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.
See pyref.dev for the list of supported packages.
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.
To set up a new server:
> git clone https://github.com/mangoumbrella/pyref.dev
> cd pyref.dev
> sudo cp pyrefdev.service /etc/systemd/system/pyrefdev.service
> systemctl start pyrefdev.service
To update to a new version:
> cd pyref.dev
> git pull
> uv sync --all-extras --locked
> systemctl restart pyrefdev.service
See CHANGELOG.md.
pyref.dev is licensed under the terms of the Apache license. See LICENSE for more information.