Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/deanishe/zothero
/ types & classes
Types & classes
59 in github.com/deanishe/zothero
⨍
Functions
438
◇
Types & classes
59
↓ 11 callers
Class
Version
Mostly semantic versioning. The main difference to proper :ref:`semantic versioning <semver>` is that this implementation doesn't require a m
src/lib/workflow/update.py:201
↓ 6 callers
Class
Option
src/lib/docopt.py:186
↓ 5 callers
Class
Argument
src/lib/docopt.py:155
↓ 4 callers
Class
CaseInsensitiveDictionary
Dictionary with caseless key search. Enables case insensitive searching while preserving case sensitivity when keys are listed, ie, via keys(
src/lib/workflow/web.py:108
↓ 4 callers
Class
Codec
src/lib/rtfunicode.py:40
↓ 4 callers
Class
Required
src/lib/docopt.py:226
↓ 2 callers
Class
Attachment
File attached to an `Entry`. NOTE: An Attachment may have either a URL or a path, but not both. The other attribute will be ``None``. At
src/lib/zothero/models.py:192
↓ 2 callers
Class
Collection
Collection `Entry` belongs to. Attributes: name (unicode): Name of Collection key (unicode): Unique identifier
src/lib/zothero/models.py:217
↓ 2 callers
Class
Command
src/lib/docopt.py:170
↓ 2 callers
Class
Creator
Author/performer of `Entry`. Attributes: index (int): Priority of Creator given (unicode): Given name of Creator family (
src/lib/zothero/models.py:237
↓ 2 callers
Class
DocoptLanguageError
Error in construction of usage-message by developer.
src/lib/docopt.py:17
↓ 2 callers
Class
Either
src/lib/docopt.py:275
↓ 2 callers
Class
Entry
A publication from the Zotero database. Attributes: id (int): Database ID for Entry key (unicode): The unique identifier for this
src/lib/zothero/models.py:65
↓ 2 callers
Class
Locale
A locale understood by CSL.
src/lib/cite/locales/__init__.py:20
↓ 2 callers
Class
LockFile
Context manager to protect filepaths with lockfiles. .. versionadded:: 1.13 Creates a lockfile alongside ``protected_path``. Other ``LockFil
src/lib/workflow/util.py:376
↓ 2 callers
Class
TokenStream
src/lib/docopt.py:289
↓ 2 callers
Class
Workflow
The ``Workflow`` object is the main interface to Alfred-Workflow. It provides APIs for accessing the Alfred/workflow environment, storing & c
src/lib/workflow/workflow.py:889
↓ 1 callers
Class
AcquisitionError
Raised if a lock cannot be acquired.
src/lib/workflow/util.py:49
↓ 1 callers
Class
AnyOptions
Marker/placeholder for [options] shortcut.
src/lib/docopt.py:248
↓ 1 callers
Class
BetterBibTex
Read citkeys from BetterBibTex database. Attributes: refkeys (dict): ``(library ID, item Key): citekey`` mapping.
src/lib/zothero/betterbibtex.py:22
↓ 1 callers
Class
CSLStyle
A CSL style configuration. Attributes: hidden (bool): Whether the style is hidden (i.e. a parent style). name (unicode): Name of
src/lib/zothero/models.py:259
↓ 1 callers
Class
Cache
Key-value store manager. Attributes: filepath (str): Path to cache sqlite file. invalid_names (tuple): Names not permitted for St
src/lib/zothero/cache.py:252
↓ 1 callers
Class
CitationError
Raised if call to ``cite`` program fails.
src/lib/cite/cite.py:29
↓ 1 callers
Class
Dict
src/lib/docopt.py:488
↓ 1 callers
Class
DocoptExit
Exit in case user invoked program with incorrect arguments.
src/lib/docopt.py:22
↓ 1 callers
Class
Download
A workflow file that is available for download. .. versionadded: 1.37 Attributes: url (str): URL of workflow file. filename
src/lib/workflow/update.py:55
↓ 1 callers
Class
Index
Search index database.
src/lib/zothero/index.py:122
↓ 1 callers
Class
KeychainError
Raised for unknown Keychain errors. Raised by methods :meth:`Workflow.save_password`, :meth:`Workflow.get_password` and :meth:`Workflow.delet
src/lib/workflow/workflow.py:453
↓ 1 callers
Class
Modifier
Modify :class:`Item3` arg/icon/variables when modifier key is pressed. Don't use this class directly (as it won't be associated with any :cla
src/lib/workflow/workflow3.py:112
↓ 1 callers
Class
NoRedirectHandler
Prevent redirections.
src/lib/workflow/web.py:99
↓ 1 callers
Class
OneOrMore
src/lib/docopt.py:253
↓ 1 callers
Class
PasswordExists
Raised when trying to overwrite an existing account password. You should never receive this error: it is used internally by the :meth:`Workfl
src/lib/workflow/workflow.py:472
↓ 1 callers
Class
PasswordNotFound
Password not in Keychain. Raised by method :meth:`Workflow.get_password` when ``account`` is unknown to the Keychain.
src/lib/workflow/workflow.py:463
↓ 1 callers
Class
Response
Returned by :func:`request` / :func:`get` / :func:`post` functions. Simplified version of the ``Response`` object in the ``requests`` librar
src/lib/workflow/web.py:181
↓ 1 callers
Class
SerializerManager
Contains registered serializers. .. versionadded:: 1.8 A configured instance of this class is available at :attr:`workflow.manager`.
src/lib/workflow/workflow.py:506
↓ 1 callers
Class
Settings
A dictionary that saves itself when changed. Dictionary keys & values will be saved as a JSON file at ``filepath``. If the file does not exis
src/lib/workflow/workflow.py:802
↓ 1 callers
Class
Store
Key-value store based on an sqlite3 table. Instantiate these via `Cache.open(name)`. Attributes: cache (Cache): `Cache` object holdi
src/lib/zothero/cache.py:66
↓ 1 callers
Class
Styles
CSL style loader and manager. Reads (and caches) .csl files from disk and fetches them from URLs. Styles are loaded and the cache updated on
src/lib/zothero/styles.py:92
↓ 1 callers
Class
Zotero
Interface to the Zotero database.
src/lib/zothero/zotero.py:162
Class
AttrDict
Dictionary whose keys are also accessible as attributes.
src/lib/zothero/models.py:23
Class
CPickleSerializer
Wrapper around :mod:`cPickle`. Sets ``protocol``. .. versionadded:: 1.8 This is the default serializer and the best combination of speed and
src/lib/workflow/workflow.py:625
Class
ChildPattern
src/lib/docopt.py:107
Class
Converter
Convert HTML to RTF.
src/lib/cite/html2rtf.py:24
Class
EntryFormatter
Formats an `Entry` for display.
src/lib/zothero/formatting.py:20
Class
HTMLText
Extract text from HTML. Strips all tags from HTML. Attributes: data (list): Accumlated text content.
src/lib/zothero/util.py:66
Class
IncrementalEncoder
src/lib/rtfunicode.py:45
Class
InitialiseDB
Raised if database needs initialising.
src/lib/zothero/index.py:85
Class
Item
Represents a feedback item for Alfred. Generates Alfred-compliant XML for a single item. You probably shouldn't use this class directly, but
src/lib/workflow/workflow.py:709
Class
Item3
Represents a feedback item for Alfred 3+. Generates Alfred-compliant JSON for a single item. Don't use this class directly (as it then won't
src/lib/workflow/workflow3.py:252
Class
JSONSerializer
Wrapper around :mod:`json`. Sets ``indent`` and ``encoding``. .. versionadded:: 1.8 Use this serializer if you need readable data files. JSO
src/lib/workflow/workflow.py:585
Class
Optional
src/lib/docopt.py:239
Class
ParentPattern
src/lib/docopt.py:140
Class
Pattern
src/lib/docopt.py:32
Class
PickleSerializer
Wrapper around :mod:`pickle`. Sets ``protocol``. .. versionadded:: 1.8 Use this serializer if you need to add custom pickling.
src/lib/workflow/workflow.py:664
Class
StreamWriter
src/lib/rtfunicode.py:53
Class
Variables
Workflow variables for Run Script actions. .. versionadded: 1.26 This class allows you to set workflow variables from Run Script actions
src/lib/workflow/workflow3.py:35
Class
Workflow3
Workflow class that generates Alfred 3+ feedback. It is a subclass of :class:`~workflow.Workflow` and most of its methods are documented ther
src/lib/workflow/workflow3.py:449
Class
ZotHero
Main application object. This class is a thin wrapper around the worker classes - `zotero.Zotero` - `index.Index` - `styles.St
src/lib/zothero/core.py:26
Class
uninterruptible
Decorator that postpones SIGTERM until wrapped function returns. .. versionadded:: 1.12 .. important:: This decorator is NOT thread-safe.
src/lib/workflow/util.py:498