pyref.dev

pyref.dev is a fast, convenient way to access Python reference docs.

It allows you to quickly jump to the official documentation for Python standard library modules and popular packages by using a simple URL pattern:

https://pyref.dev/<fully.qualified.symbol.name>

You can also search for symbols using:

https://pyref.dev/is?symbol=<SYMBOL>

And if you are feeling lucky, ask it to redirect to the first result:

https://pyref.dev/is?lucky=true&symbol=<SYMBOL>

Lastly, you can pip install pyrefdev and run the pyrefdev CLI tool.

Examples

Supported packages

See pyref.dev for the list of supported packages.

Case sensitivity

For most of the cases, they are case-insensitive. However, for symbols like typing.final and typing.Final, you need to access them with the correct case.

Server setup

To set up a new server:

> sudo apt update && sudo apt install nginx
> sudo rm /etc/nginx/sites-available/default /etc/nginx/sites-enabled/default
> curl -LsSf https://astral.sh/uv/install.sh | sh
> git clone https://github.com/mangoumbrella/pyref.dev
> cd pyref.dev
> uv venv --python 3.14
> uv sync --all-extras --locked
> uv run pyrefdev-indexer build-index
> sudo cp deploy/pyrefdev.service /etc/systemd/system/pyrefdev.service
> sudo cp deploy/pyrefdev.conf /etc/nginx/sites-available/pyrefdev
> sudo ln -sf /etc/nginx/sites-available/pyrefdev /etc/nginx/sites-enabled/pyrefdev
> systemctl start nginx.service
> systemctl start pyrefdev.service

To update to a new version:

git pull && git fetch --tags && uv pip install -e . && uv sync --all-extras --locked && uv run pyrefdev-indexer build-index && systemctl restart pyrefdev.service

To upgrade uv venv's Python version:

uv venv --python 3.14

Changelog

See CHANGELOG.md.

License

pyref.dev is licensed under the terms of the Apache license. See LICENSE for more information.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrefdev-2026.5.tar.gz (13.0 MB view details)

Uploaded Sep 6, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pyrefdev-2026.5-py3-none-any.whl (13.5 MB view details)

Uploaded Sep 6, 2026 Python 3

File details

Details for the file pyrefdev-2026.5.tar.gz.

File metadata

Download URL: pyrefdev-2026.5.tar.gz
Upload date: Sep 6, 2026
Size: 13.0 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyrefdev-2026.5.tar.gz
Algorithm	Hash digest
SHA256	`af5ae5c3adfddc2d4403469c7dfa24cd4aa288ac7bc677283829cf919e8401df`
MD5	`705b58b82adec44658a3398452c77d6d`
BLAKE2b-256	`723b427cfac6829bb2a6ec25d17e0c400a186762c7da720a5779e0299e4850ce`

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrefdev-2026.5.tar.gz:

Publisher: pypi_upload.yml on mangoumbrella/pyref.dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: pyrefdev-2026.5.tar.gz
- Subject digest: af5ae5c3adfddc2d4403469c7dfa24cd4aa288ac7bc677283829cf919e8401df
- Sigstore transparency entry: 2741741866
- Sigstore integration time: Sep 6, 2026
Source repository:
- Permalink: mangoumbrella/pyref.dev@54315c657c543c47cf9280129f3f51f0d0d12f82
- Branch / Tag: refs/tags/v2026.5
- Owner: https://github.com/mangoumbrella
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: pypi_upload.yml@54315c657c543c47cf9280129f3f51f0d0d12f82
- Trigger Event: release