Return value for case-insensitive key or default.

Lazy `Workflow` object.

Replace ``$HOME`` in path with ~.

:class:`dict` of ``info.plist`` contents.

Extract text from HTML. Args: html (unicode): HTML to process. decode (bool, optional): Decode from UTF-8 to Unicode.

Return value for `key` or `default`. Passes result through `self.convert_out()` before returning. Args: key (str): Datab

Return ``text`` as normalised unicode. If ``encoding`` and/or ``normalization`` is ``None``, the ``input_encoding``and ``normalizatio

Return ``(key, value)`` pairs.

Serialize object ``obj`` to open JSON file. .. versionadded:: 1.8 :param obj: Python object to serialize :type obj: JSON-ser

Ensure ``s`` is Unicode. Returns Unicode unchanged, decodes bytestrings and calls `unicode()` on anything else. Args: s (basestr

Path to ``filename`` in workflow's data directory. Return absolute path to ``filename`` within your workflow's :attr:`data directory

Return `CSLStyle` for key. Args: key (unicode): Unique key for style. Returns: models.CSLStyle: Style object

Return Workflow object for this module. Returns: workflow.Workflow: Workflow object for current workflow.

Save ``data`` to cache under ``name``. If ``data`` is ``None``, the corresponding cache file will be deleted. :param name: n

Path to ``filename`` in workflow's cache directory. Return absolute path to ``filename`` within your workflow's :attr:`cache director

Search index. Creates and returns an `Index` object. The index is initialised, but may be empty. Returns: .index

Load serialized object from open JSON file. .. versionadded:: 1.8 :param file_obj: file handle :type file_obj: ``file`` obje

Return serializer object for ``name``. :param name: Name of serializer to return :type name: ``unicode`` or ``str`` :returns:

Set the clipboard contents. `contents` should have the format: { 'UTI': 'value', ... } e.g. `{'

Create new `Entry`. Args: *args: Optional initialisation data. As for `dict`. **kwargs: Optional initialisation data.

Interate over values.

Register ``serializer`` object under ``name``. Raises :class:`AttributeError` if ``serializer`` in invalid. .. note:: `

Save settings to JSON file specified in ``self._filepath``. If you're using this class via :attr:`Workflow.settings`, which you proba

Set value for key, passing `value` through `self.convert_in()`. Args: key (str): Database key. value (obj): Object to

Override :class:`dict` method to save on update.

Call ``security`` CLI program that provides access to keychains. May raise `PasswordNotFound`, `PasswordExists` or `KeychainError` ex

Atomic file writer. .. versionadded:: 1.12 Context manager that ensures the file is only written if the write succeeds. The data is firs

Context manager providing database cursor.

Execute an AppleScript script and return its output. .. versionadded:: 1.31 Run AppleScript either by filepath or code. If ``script`` is a v

Search index for ``query``. Args: query (unicode): Query to search for Returns: list: `Entry` objects for ma

Implement comparison.

Create an `Entry` from a SQLite database row.

Parse string ``s`` into list of ints and strings.

Add an item to be output to Alfred. :param title: Title shown in Alfred :type title: ``unicode`` :param subtitle: Subtitle sh

Return cached data if younger than ``max_age`` seconds. Retrieve data from cache or re-generate and re-cache data if stale/non-exista

Convert `datetime` to Sqlite time string. Format string is `SQLITE_DATE_FMT`. Args: dt (datetime): `datetime` object to convert.

Deserialise an `Entry` from JSON.

Test if ``text`` contains only ASCII characters. :param text: text to test for ASCII-ness :type text: ``unicode`` :returns: ``True`` if `

Return name of application to call currently running Alfred. .. versionadded: 1.37 Returns 'Alfred 3' or 'com.runningwithcrayons.Alfred' dep

Return original keys.

Return logger for this module. Returns: logging.Logger: Logger for this module.

Open a `Store` with `name` and using the specified converters. Args: name (str): The name of the Store/database table.

Run a command and return the output. .. versionadded:: 1.31 A thin wrapper around :func:`subprocess.check_output` that ensures all argum

Print stored items to console/Alfred as XML.

Print help message.

Convert keys and values in ``dic`` into UTF-8-encoded :class:`str`. :param dic: Mapping of Unicode strings :type dic: dict :returns: Dict

Ensure string is Unicode. .. versionadded:: 1.31 Decode encoded strings using ``encoding`` and normalise Unicode to form ``norm`` if spe

Return full path to ``filename`` in workflow's root directory. :param filename: basename of file :type filename: ``unicode``

Create a new :class:`Item3` object. Use same arguments as for :class:`Workflow.Item <workflow.Workflow.Item>`. Argument ``su

Return path to pickle cache file for arguments. :param name: name of task :type name: ``unicode`` :returns: Path to cache file :rtype

Create directory `dirpath` if it doesn't exist. :param dirpath: path to directory :type dirpath: ``unicode`` :returns: ``dirp

Delete all files in a directory. :param dirpath: path to directory to clear :type dirpath: ``unicode`` or ``str`` :param filt

Get PID of job or `None` if job does not exist. Args: name (str): Name of job. Returns: int: PID of job process (or `None` i

Extract style info from a .csl file. Args: path (unicode): Path to a .csl file. Returns: models.CSLStyle: St

New cache name/key based on session ID.

Return path to PID file for ``name``. :param name: name of task :type name: ``unicode`` :returns: Path to PID file for task :rtype: `

Load CSL styles from ``dirpath``. Read any .csl files in ``dirpath``, ignoring those that haven't been modified since they were last

Update search index from a `Zotero` instance. Retrieve Zotero entries and add to/update in the search index. Args: zot (

Coerce `key` to Unicode or raise `ValueError`. Args: key (str or unicode): String key. Raises: TypeError: Ra

Ensure string only contains ASCII characters. Args: s (basestring): Unicode or bytestring. Returns: unicode: String containi

Return age in seconds of cache `name` or 0 if cache doesn't exist. :param name: name of datastore :type name: ``unicode`` :re

Call update script if it's time to check for a new release. .. versionadded:: 1.9 The update script will be run in the background, s

Delete all files in workflow's :attr:`cachedir`. :param filter_func: Callable to determine whether a file should be deleted or no

Remove item from store.

Serialise `Entry` to JSON. Returns: str: JSON-encoded `Entry`.

Return path to notifier applet executable. Returns: unicode: Path to Notify.app ``applet`` executable.

Parse a Zotero date string into CSL(JSON) ``date-parts``. Args: datestr (unicode): Zotero date string. Returns: dict: ``date

expr ::= seq ( '|' seq )* ;

long ::= '--' chars [ ( ' ' | '=' ) chars ] ;

seq ::= ( atom [ '...' ] )* ;

shorts ::= '-' ( chars )* [ [ ' ' ] chars ] ;

Convert PNG file to ICNS using ``iconutil``. Create an iconset from the source PNG file. Generate PNG files in each size required by macOS, t

Raise stored error if one occurred. error will be instance of :class:`urllib2.HTTPError`

Release the lock by deleting `self.lockfile`.

Initiate an HTTP(S) request. Returns :class:`Response` object. :param method: 'GET' or 'POST' :type method: unicode :param url: URL to op

Delete workflow settings, cache and data. File :attr:`settings <settings_path>` and directories :attr:`cache <cachedir>` and :attr:`d

r"""Cache arguments then call this script again via :func:`subprocess.call`. :param name: name of job :type name: unicode :param args: ar

Make a name filesystem-safe.

Set a "global" workflow variable. .. versionchanged:: 1.33 These variables are always passed to downstream workflow objects.

Human-readable time since timestamp ``ts``.

Context manager that logs execution time.

Update search index from a `Zotero` instance. If the Zotero database is newer than the index (or the index is empty), retrieve entrie

Update values from other ``dict``.

Compare Downloads based on version numbers.

Implement comparison.