pyrefdev


Namepyrefdev JSON
Version 2025.7 PyPI version JSON
download
home_pageNone
SummaryThe entry point to Python reference docs
upload_time2025-07-09 03:42:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords documentation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pyref.dev

[pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.

<p>
<a href="https://pypi.org/project/pyrefdev"><img alt="PyPI" src="https://img.shields.io/pypi/v/pyrefdev"></a>
<a href="https://pypi.org/project/pyrefdev"><img alt="Python veresions supported" src="https://img.shields.io/pypi/pyversions/pyrefdev"></a>
<a href="https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/pyrefdev.svg"></a>
</p>

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

* [pyref.dev/json](https://pyref.dev/json)
* [pyref.dev/pathlib.Path](https://pyref.dev/pathlib.Path)
* [pyref.dev/datetime.datetime.strftime](https://pyref.dev/datetime.datetime.strftime)
* [pyref.dev/numpy.array](https://pyref.dev/numpy.array)

## Supported packages

See [pyref.dev](https://pyref.dev/#supported-packages) 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:

```bash
> 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:

```bash
> cd pyref.dev
> git pull
> uv sync --all-extras --locked
> systemctl restart pyrefdev.service
```

## Changelog

See [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).

## License

[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE) for more information.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyrefdev",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "documentation",
    "author": null,
    "author_email": "Mango Umbrella LLC <hi@mangoumbrella.com>",
    "download_url": "https://files.pythonhosted.org/packages/f1/34/223e12913b7f3af78339b11dda9467e354ba33662547b96365c9190e82e2/pyrefdev-2025.7.tar.gz",
    "platform": null,
    "description": "# pyref.dev\n\n[pyref.dev](https://pyref.dev) is a fast, convenient way to access Python reference docs.\n\n<p>\n<a href=\"https://pypi.org/project/pyrefdev\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/pyrefdev\"></a>\n<a href=\"https://pypi.org/project/pyrefdev\"><img alt=\"Python veresions supported\" src=\"https://img.shields.io/pypi/pyversions/pyrefdev\"></a>\n<a href=\"https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/pypi/l/pyrefdev.svg\"></a>\n</p>\n\nIt allows you to quickly jump to the official documentation for Python standard library modules and popular packages by using a simple URL pattern:\n\n```\nhttps://pyref.dev/<fully.qualified.symbol.name>\n```\n\nYou can also search for symbols using:\n\n```\nhttps://pyref.dev/is?symbol=<SYMBOL>\n```\n\nAnd if you are feeling lucky, ask it to redirect to the first result:\n\n```\nhttps://pyref.dev/is?lucky=true&symbol=<SYMBOL>\n```\n\nLastly, you can `pip install pyrefdev` and run the `pyrefdev` CLI tool.\n\n## Examples\n\n* [pyref.dev/json](https://pyref.dev/json)\n* [pyref.dev/pathlib.Path](https://pyref.dev/pathlib.Path)\n* [pyref.dev/datetime.datetime.strftime](https://pyref.dev/datetime.datetime.strftime)\n* [pyref.dev/numpy.array](https://pyref.dev/numpy.array)\n\n## Supported packages\n\nSee [pyref.dev](https://pyref.dev/#supported-packages) for the list of supported packages.\n\n# Case sensitivity\n\nFor 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.\n\n## Server setup\n\nTo set up a new server:\n\n```bash\n> git clone https://github.com/mangoumbrella/pyref.dev\n> cd pyref.dev\n> sudo cp pyrefdev.service /etc/systemd/system/pyrefdev.service\n> systemctl start pyrefdev.service\n```\n\nTo update to a new version:\n\n```bash\n> cd pyref.dev\n> git pull\n> uv sync --all-extras --locked\n> systemctl restart pyrefdev.service\n```\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md).\n\n## License\n\n[pyref.dev](https://pyref.dev) is licensed under the terms of the Apache license. See [LICENSE](https://github.com/mangoumbrella/pyref.dev/blob/main/LICENSE) for more information.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The entry point to Python reference docs",
    "version": "2025.7",
    "project_urls": {
        "Changelog": "https://github.com/mangoumbrella/pyref.dev/blob/main/CHANGELOG.md",
        "Homepage": "https://pyref.dev",
        "Source": "https://github.com/mangoumbrella/pyref.dev"
    },
    "split_keywords": [
        "documentation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2fda7a3e9eb6e02824732821e4e473bd3e68bb38f72b3356b5099be3e55b9e50",
                "md5": "7c7ab7bd2da22c20c37e7df6666811ff",
                "sha256": "295bb3e8fdeab78c9a928f859b2878bd1c70758151367980fd60fc6365e82266"
            },
            "downloads": -1,
            "filename": "pyrefdev-2025.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c7ab7bd2da22c20c37e7df6666811ff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 799705,
            "upload_time": "2025-07-09T03:42:35",
            "upload_time_iso_8601": "2025-07-09T03:42:35.735200Z",
            "url": "https://files.pythonhosted.org/packages/2f/da/7a3e9eb6e02824732821e4e473bd3e68bb38f72b3356b5099be3e55b9e50/pyrefdev-2025.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f134223e12913b7f3af78339b11dda9467e354ba33662547b96365c9190e82e2",
                "md5": "8724d7f5cc6ac95cc29ffb19bb54ffea",
                "sha256": "dcf8bcc324733120d80939a36abbe1ad8757e79ad0d2179bde65a315eaeb3212"
            },
            "downloads": -1,
            "filename": "pyrefdev-2025.7.tar.gz",
            "has_sig": false,
            "md5_digest": "8724d7f5cc6ac95cc29ffb19bb54ffea",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 826293,
            "upload_time": "2025-07-09T03:42:37",
            "upload_time_iso_8601": "2025-07-09T03:42:37.276555Z",
            "url": "https://files.pythonhosted.org/packages/f1/34/223e12913b7f3af78339b11dda9467e354ba33662547b96365c9190e82e2/pyrefdev-2025.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 03:42:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mangoumbrella",
    "github_project": "pyref.dev",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyrefdev"
}
        
Elapsed time: 0.62558s