| Name | pepotron JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | CLI to open PEPs in your browser |
| upload_time | 2024-10-16 19:56:31 |
| maintainer | None |
| docs_url | None |
| author | Hugo van Kemenade |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
bpo
cli
pep
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# pepotron
[](https://pypi.org/project/pepotron/)
[](https://pypi.org/project/pepotron/)
[](https://pypistats.org/packages/pepotron)
[](https://github.com/hugovk/pepotron/actions)
[](https://codecov.io/gh/hugovk/pepotron)
[](LICENSE.txt)
[](https://github.com/psf/black)
CLI to open PEPs in your browser.
## Installation
### From PyPI
```bash
python3 -m pip install --upgrade pepotron
```
### With [pipx][pipx]
```bash
pipx install pepotron
```
[pipx]: https://github.com/pypa/pipx
### From source
```bash
git clone https://github.com/hugovk/pepotron
cd pepotron
python3 -m pip install .
```
## Usage
### Open a PEP
<!-- [[[cog
from pepotron.scripts.run_command import run
run("pep 8")
]]] -->
```console
$ pep 8
https://peps.python.org/pep-0008/
```
<!-- [[[end]]] -->
### Open release schedule PEP for a Python version
<!-- [[[cog run("pep 3.11") ]]] -->
```console
$ pep 3.11
https://peps.python.org/pep-0664/
```
<!-- [[[end]]] -->
### Open a PEP by searching for words in the title
<!-- [[[cog run("pep dead batteries") ]]] -->
```console
$ pep dead batteries
Score Result
90 PEP 594: Removing dead batteries from the standard library
58 PEP 415: Implement context suppression with exception attributes
55 PEP 476: Enabling certificate verification by default for stdlib http clients
55 PEP 500: A protocol for delegating datetime methods to their tzinfo implementations
55 PEP 696: Type defaults for TypeVarLikes
https://peps.python.org/pep-0594/
```
<!-- [[[end]]] -->
### Open a PEP topic
<!-- [[[cog run("pep governance") ]]] -->
```console
$ pep governance
https://peps.python.org/topic/governance/
```
<!-- [[[end]]] -->
<!-- [[[cog run("pep packaging") ]]] -->
```console
$ pep packaging
https://peps.python.org/topic/packaging/
```
<!-- [[[end]]] -->
<!-- [[[cog run("pep release") ]]] -->
```console
$ pep release
https://peps.python.org/topic/release/
```
<!-- [[[end]]] -->
<!-- [[[cog run("pep typing") ]]] -->
```console
$ pep typing
https://peps.python.org/topic/typing/
```
<!-- [[[end]]] -->
<!-- [[[cog run("pep topics") ]]] -->
```console
$ pep topics
https://peps.python.org/topic/
```
<!-- [[[end]]] -->
### Open a build preview of a python/peps PR
<!-- [[[cog run("pep 594 --pr 2440") ]]] -->
```console
$ pep 594 --pr 2440
https://pep-previews--2440.org.readthedocs.build/pep-0594/
```
<!-- [[[end]]] -->
### Open the PEPs website
<!-- [[[cog run("pep") ]]] -->
```console
$ pep
https://peps.python.org
```
<!-- [[[end]]] -->
<!-- [[[cog run("pep --pr 2440") ]]] -->
```console
$ pep --pr 2440
https://pep-previews--2440.org.readthedocs.build
```
<!-- [[[end]]] -->
### Find the next available PEP number
Check published PEPs and [open PRs](https://github.com/python/peps/pulls) to find the
next available PEP number.
<!-- [[[cog run("pep next") ]]] -->
```console
$ pep next
Next available PEP: 730
```
<!-- [[[end]]] -->
### Open a BPO issue in the browser
Issues from [bugs.python.org](https://bugs.python.org/) have been migrated to
[GitHub issues](https://github.com/python/cpython/issues) and have new numbers. This
command will open the redirect page to take you to the new issue.
<!-- [[[cog run("bpo 46208") ]]] -->
```console
$ bpo 46208
https://bugs.python.org/issue?@action=redirect&bpo=46208
```
<!-- [[[end]]] -->
This redirects to https://github.com/python/cpython/issues/90366
### Help
<!-- [[[cog run("pep --help") ]]] -->
```console
$ pep --help
usage: pep [-h] [-u URL] [-p PR] [--clear-cache] [-n] [-v] [-V] [search ...]
pepotron: CLI to open PEPs in your browser
positional arguments:
search PEP number, or Python version for its schedule, or words from title
options:
-h, --help show this help message and exit
-u URL, --url URL Base URL for PEPs (default: https://peps.python.org)
-p PR, --pr PR Open preview for python/peps PR
--clear-cache Clear cache before running
-n, --dry-run Don't open in browser
-v, --verbose Verbose logging
-V, --version show program's version number and exit
```
<!-- [[[end]]] -->
<!-- [[[cog run("bpo --help") ]]] -->
```console
$ bpo --help
usage: bpo [-h] [-n] [-v] [-V] bpo
Open this BPO in the browser
positional arguments:
bpo BPO number
options:
-h, --help show this help message and exit
-n, --dry-run Don't open in browser
-v, --verbose Verbose logging
-V, --version show program's version number and exit
```
<!-- [[[end]]] -->
Raw data
{
"_id": null,
"home_page": null,
"name": "pepotron",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "bpo, cli, pep",
"author": "Hugo van Kemenade",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4e/cf/7892cd4c888dc91132d987c3476420962c77ec8a4cf0b94ee3917b6a0667/pepotron-1.3.0.tar.gz",
"platform": null,
"description": "# pepotron\n\n[](https://pypi.org/project/pepotron/)\n[](https://pypi.org/project/pepotron/)\n[](https://pypistats.org/packages/pepotron)\n[](https://github.com/hugovk/pepotron/actions)\n[](https://codecov.io/gh/hugovk/pepotron)\n[](LICENSE.txt)\n[](https://github.com/psf/black)\n\nCLI to open PEPs in your browser.\n\n## Installation\n\n### From PyPI\n\n```bash\npython3 -m pip install --upgrade pepotron\n```\n\n### With [pipx][pipx]\n\n```bash\npipx install pepotron\n```\n\n[pipx]: https://github.com/pypa/pipx\n\n### From source\n\n```bash\ngit clone https://github.com/hugovk/pepotron\ncd pepotron\npython3 -m pip install .\n```\n\n## Usage\n\n### Open a PEP\n\n<!-- [[[cog\nfrom pepotron.scripts.run_command import run\nrun(\"pep 8\")\n]]] -->\n\n```console\n$ pep 8\nhttps://peps.python.org/pep-0008/\n```\n\n<!-- [[[end]]] -->\n\n### Open release schedule PEP for a Python version\n\n<!-- [[[cog run(\"pep 3.11\") ]]] -->\n\n```console\n$ pep 3.11\nhttps://peps.python.org/pep-0664/\n```\n\n<!-- [[[end]]] -->\n\n### Open a PEP by searching for words in the title\n\n<!-- [[[cog run(\"pep dead batteries\") ]]] -->\n\n```console\n$ pep dead batteries\nScore Result\n90 PEP 594: Removing dead batteries from the standard library\n58 PEP 415: Implement context suppression with exception attributes\n55 PEP 476: Enabling certificate verification by default for stdlib http clients\n55 PEP 500: A protocol for delegating datetime methods to their tzinfo implementations\n55 PEP 696: Type defaults for TypeVarLikes\n\nhttps://peps.python.org/pep-0594/\n```\n\n<!-- [[[end]]] -->\n\n### Open a PEP topic\n\n<!-- [[[cog run(\"pep governance\") ]]] -->\n\n```console\n$ pep governance\nhttps://peps.python.org/topic/governance/\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"pep packaging\") ]]] -->\n\n```console\n$ pep packaging\nhttps://peps.python.org/topic/packaging/\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"pep release\") ]]] -->\n\n```console\n$ pep release\nhttps://peps.python.org/topic/release/\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"pep typing\") ]]] -->\n\n```console\n$ pep typing\nhttps://peps.python.org/topic/typing/\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"pep topics\") ]]] -->\n\n```console\n$ pep topics\nhttps://peps.python.org/topic/\n```\n\n<!-- [[[end]]] -->\n\n### Open a build preview of a python/peps PR\n\n<!-- [[[cog run(\"pep 594 --pr 2440\") ]]] -->\n\n```console\n$ pep 594 --pr 2440\nhttps://pep-previews--2440.org.readthedocs.build/pep-0594/\n```\n\n<!-- [[[end]]] -->\n\n### Open the PEPs website\n\n<!-- [[[cog run(\"pep\") ]]] -->\n\n```console\n$ pep\nhttps://peps.python.org\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"pep --pr 2440\") ]]] -->\n\n```console\n$ pep --pr 2440\nhttps://pep-previews--2440.org.readthedocs.build\n```\n\n<!-- [[[end]]] -->\n\n### Find the next available PEP number\n\nCheck published PEPs and [open PRs](https://github.com/python/peps/pulls) to find the\nnext available PEP number.\n\n<!-- [[[cog run(\"pep next\") ]]] -->\n\n```console\n$ pep next\nNext available PEP: 730\n```\n\n<!-- [[[end]]] -->\n\n### Open a BPO issue in the browser\n\nIssues from [bugs.python.org](https://bugs.python.org/) have been migrated to\n[GitHub issues](https://github.com/python/cpython/issues) and have new numbers. This\ncommand will open the redirect page to take you to the new issue.\n\n<!-- [[[cog run(\"bpo 46208\") ]]] -->\n\n```console\n$ bpo 46208\nhttps://bugs.python.org/issue?@action=redirect&bpo=46208\n```\n\n<!-- [[[end]]] -->\n\nThis redirects to https://github.com/python/cpython/issues/90366\n\n### Help\n\n<!-- [[[cog run(\"pep --help\") ]]] -->\n\n```console\n$ pep --help\nusage: pep [-h] [-u URL] [-p PR] [--clear-cache] [-n] [-v] [-V] [search ...]\n\npepotron: CLI to open PEPs in your browser\n\npositional arguments:\n search PEP number, or Python version for its schedule, or words from title\n\noptions:\n -h, --help show this help message and exit\n -u URL, --url URL Base URL for PEPs (default: https://peps.python.org)\n -p PR, --pr PR Open preview for python/peps PR\n --clear-cache Clear cache before running\n -n, --dry-run Don't open in browser\n -v, --verbose Verbose logging\n -V, --version show program's version number and exit\n```\n\n<!-- [[[end]]] -->\n\n<!-- [[[cog run(\"bpo --help\") ]]] -->\n\n```console\n$ bpo --help\nusage: bpo [-h] [-n] [-v] [-V] bpo\n\nOpen this BPO in the browser\n\npositional arguments:\n bpo BPO number\n\noptions:\n -h, --help show this help message and exit\n -n, --dry-run Don't open in browser\n -v, --verbose Verbose logging\n -V, --version show program's version number and exit\n```\n\n<!-- [[[end]]] -->\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI to open PEPs in your browser",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/hugovk/pepotron/releases",
"Homepage": "https://github.com/hugovk/pepotron",
"Source": "https://github.com/hugovk/pepotron"
},
"split_keywords": [
"bpo",
" cli",
" pep"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dfd728e46d66a601b6eae8c3c12c97362f6b9564e533953ef97962ae63f70d67",
"md5": "ce34f863435c36e76e7884cdfb40bafd",
"sha256": "3122217b79581565bfb5c98483dfa4dd51020c673139c18ba17cb364b1b7fc68"
},
"downloads": -1,
"filename": "pepotron-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce34f863435c36e76e7884cdfb40bafd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9076,
"upload_time": "2024-10-16T19:56:29",
"upload_time_iso_8601": "2024-10-16T19:56:29.210812Z",
"url": "https://files.pythonhosted.org/packages/df/d7/28e46d66a601b6eae8c3c12c97362f6b9564e533953ef97962ae63f70d67/pepotron-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ecf7892cd4c888dc91132d987c3476420962c77ec8a4cf0b94ee3917b6a0667",
"md5": "fbca3811d9bc238561d63bf9ecf5f96c",
"sha256": "b0bb1f8c5472252db0e26b918eb26fdaa8c906acba1c354dee0b30522768c3d2"
},
"downloads": -1,
"filename": "pepotron-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "fbca3811d9bc238561d63bf9ecf5f96c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14024,
"upload_time": "2024-10-16T19:56:31",
"upload_time_iso_8601": "2024-10-16T19:56:31.144529Z",
"url": "https://files.pythonhosted.org/packages/4e/cf/7892cd4c888dc91132d987c3476420962c77ec8a4cf0b94ee3917b6a0667/pepotron-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 19:56:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hugovk",
"github_project": "pepotron",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pepotron"
}
