Django Docs Workflow for Alfred

Search the Django documentation using Alfred.

Installation

1. Download the latest version
2. Install the workflow by double-clicking the .alfredworkflow file
3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.

Usage

Just type dj followed by your search query.

dj FormView

Either press ⌘Y to Quick Look the result, or press to open it in your web browser.

Changing the Django version to search

The workflow supports searching the documentation of several versions. To change the branch, configure the Workflow as show in the image below.

Development

The workflow is built with Rust 1.88 or newer on macOS. Copy .env.example to .env and provide the three Algolia settings before building a release binary; the release target also accepts settings already exported in the environment.

cargo run -- -q "FormView"

Install cargo-about before running the complete local check, because make ci generates the bundled third-party license notice:

cargo install cargo-about --locked --features cli
make ci

make package creates the versioned .alfredworkflow archive. Release builds produce one universal workflow binary for Apple Silicon and Intel and keep the workflow's runtime cache and .env files out of the archive.

Note

The lightning fast search is powered by Algolia which was generous enough to hand me a big enough plan to fit all the indices for the officially supported Django documentation versions. A big thank you to @redox from @algolia 😇 🍻 ❤

The index for Algolia was compiled from the zipped Django HTML documentation using a simple Python script I wrote.