Features¶

• Catches and logs workflow errors for easier development and support
• “Magic” arguments to help development, debugging and management of the workflow
• Auto-saves settings
• Super-simple data caching
• Fuzzy, Alfred-like search/filtering with diacritic folding
• Keychain support for secure storage (and syncing) of passwords, API keys etc.
• Simple generation of Alfred feedback (XML output)
• Input/output decoding for handling non-ASCII text
• Lightweight web API with Requests-like interface
• Pre-configured logging
• Painlessly add directories to sys.path
• Easily launch background tasks (daemons) to keep your workflow responsive
• Check for and install new workflow versions using GitHub releases.

Quick example¶

Here’s how to show recent Pinboard.in posts in Alfred.

Create a new workflow in Alfred’s preferences. Add a Script Filter with Language /usr/bin/python and paste the following into the Script field (changing API_KEY):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

import sys
from workflow import Workflow, ICON_WEB, web

API_KEY = 'your-pinboard-api-key'

def main(wf):
    url = 'https://api.pinboard.in/v1/posts/recent'
    params = dict(auth_token=API_KEY, count=20, format='json')
    r = web.get(url, params)
    r.raise_for_status()
    for post in r.json()['posts']:
        wf.add_item(post['description'], post['href'], arg=post['href'],
                    uid=post['hash'], valid=True, icon=ICON_WEB)
    wf.send_feedback()


if __name__ == u"__main__":
    wf = Workflow()
    sys.exit(wf.run(main))

Add an Open URL action to your workflow with {query} as the URL, connect your Script Filter to it, and you can now hit ENTER on a Pinboard item in Alfred to open it in your browser.

Installation¶

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

The Alfred-Workflow Tutorial¶

A two-part tutorial on writing an Alfred workflow with Alfred-Workflow, taking you through the basics to a performant and release- ready workflow. This is the best starting point for workflow authors new to Python or programming in general. More experienced Python coders should skim this or skip straight ahead to the User Manual.

User Manual¶

If you know your way around Python and Alfred, here’s an overview of what Alfred-Workflow can do and how to do it.

API documentation¶

Documetation of the Alfred-Workflow APIs generated from the source code. A handy reference if (like me) you sometimes forget parameter names.

Script Filter results and the XML format¶

An in-depth look at Alfred’s XML format, the many parameters accepted by Workflow.add_item() and how they interact with one another.

Workflows using Alfred-Workflow¶

This is a list of some of the workflows based on Alfred-Workflow.

Feedback, questions, bugs, feature requests¶

If you have feedback or a question regarding Alfred-Workflow, please post in them in the Alfred forum thread.

If you have a bug report or a feature request, please create a new issue on GitHub.

You can also email me at deanishe@deanishe.net with any questions/feedback/bug reports. However, it’s generally better to use the forum/GitHub so that other users can benefit from and contribute to the conversation.