Quick Index

Quick links to the important parts of the documentation.

• Installation
  • pip / PyPi
  • GitHub
• User Guide
  • Workflow setup and skeleton
  • Including 3rd party libraries
  • Persistent data
    • Caching data
    • Session-scoped cache
    • Storing data
    • Settings
    • Keychain access
    • A note on Script Behaviour
  • Searching/filtering data
    • Using “Alfred filters results”
    • Fuzzy filtering with Alfred-PyWorkflow
  • Retrieving data from the web
  • Notifications
    • Usage
  • Background processes
  • Self-updating
    • GitHub releases
    • Configuration
    • Usage
    • Under the hood
    • Version numbers
  • Versioning and migration
    • Setting a version number
    • Version numbers
    • First run/migration
  • System icons
    • List of icons
  • “Magic” arguments
    • Customising magic arguments
  • Workflow variables
    • Getting variables
    • Setting variables from Run Script actions
    • Setting variables in Script Filters
    • Persisting variables
    • More information
  • Serialization of stored/cached data
    • Built-in serializers
    • Managing serializers
    • Serializer interface
  • Re-running a Script Filter
  • Encoded bytest and strings
    • TL;DR
    • String types
    • Normalization
    • Other Gotchas
    • Further information
• API documentation
  • Workflow objects
    • Workflow
    • Settings
    • Serializers
    • Exceptions
  • Background processes
    • run_in_background()
    • is_running()
    • kill()
  • HTTP requests
    • get()
    • post()
    • request()
    • Response objects
  • Workflow updates
    • check_update()
    • install_update()
    • Helpers
  • Notifications
    • notify()
  • Utility & helper functions
    • Scripting
    • Text
    • Alfred’s API
    • Miscellaneous
    • Exceptions
• Tutorial Part 1: Creating a Basic Pinboard Workflow
  • Creating a new Workflow
  • Describing your Workflow
  • Adding a Script Filter
  • Writing your Python script
  • Adding workflow actions
  • Improving performance and not getting banned
  • Making the posts searchable
    • Improving the search results
  • What now?
    • Further reading
• Tutorial Part 2: Creating a Distribution-Ready Pinboard Workflow
  • Performing multiple actions from one script
  • Multi-step actions
  • Saving settings
    • Saving settings securely
  • “Magic” arguments
  • Logging
  • Spit and polish
    • Two actions, one keyword
    • Notifying the user if there are no results
    • Greased lightning: background updates
  • The fruits of your labour
    • Sharing your workflow
    • Updating your workflow