Installation

Alfred-PyWorkflow can be installed from the Python Package Index with pip or from the source code on GitHub.

Tip

If you don’t know how to create a new workflow and add files to it, have a look at the tutorial.

pip / PyPi

You can install Alfred-PyWorkflow directly into your workflow with:

pip install --target=/path/to/my/workflow Alfred-PyWorkflow

Important

If you intend to distribute your workflow to other users, you should include Alfred-PyWorkflow (and other non-standard Python libraries your workflow requires) within your workflow as described above. Do not ask users to install anything into their system Python. That way lies broken software.

GitHub

Download the alfred-pyworkflow-X.X.X.zip file from the GitHub releases page and extract the ZIP to the root directory of your workflow (where info.plist is).

Alternatively, you can download the source code from the GitHub repository and copy the workflow subfolder to the root directory of your workflow.

Your Workflow directory should look something like this (where yourscript.py contains your workflow code and info.plist is the workflow information file generated by Alfred):

Your Workflow/
    info.plist
    icon.png
    workflow/
        __init__.py
        background.py
        notify.py
        update.py
        version
        web.py
        workflow.py
    yourscript.py
    etc.