pepotron


Namepepotron JSON
Version 1.1.1 PyPI version JSON
download
home_page
SummaryCLI to open PEPs in your browser
upload_time2023-10-12 22:54:53
maintainer
docs_urlNone
authorHugo van Kemenade
requires_python>=3.8
licenseMIT
keywords bpo cli pep
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # pepotron

[![PyPI version](https://img.shields.io/pypi/v/pepotron.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/pepotron/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pepotron.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/pepotron/)
[![PyPI downloads](https://img.shields.io/pypi/dm/pepotron.svg)](https://pypistats.org/packages/pepotron)
[![Test](https://github.com/hugovk/pepotron/actions/workflows/test.yml/badge.svg)](https://github.com/hugovk/pepotron/actions)
[![Codecov](https://codecov.io/gh/hugovk/pepotron/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/pepotron)
[![Licence](https://img.shields.io/github/license/hugovk/pepotron.svg)](LICENSE.txt)
[![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](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": "",
    "name": "pepotron",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "bpo,cli,pep",
    "author": "Hugo van Kemenade",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/13/97/eb55af19e55946576643bf016359887221bc5ccd24944c98129f6dfa2bae/pepotron-1.1.1.tar.gz",
    "platform": null,
    "description": "# pepotron\n\n[![PyPI version](https://img.shields.io/pypi/v/pepotron.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/pepotron/)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/pepotron.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/pepotron/)\n[![PyPI downloads](https://img.shields.io/pypi/dm/pepotron.svg)](https://pypistats.org/packages/pepotron)\n[![Test](https://github.com/hugovk/pepotron/actions/workflows/test.yml/badge.svg)](https://github.com/hugovk/pepotron/actions)\n[![Codecov](https://codecov.io/gh/hugovk/pepotron/branch/main/graph/badge.svg)](https://codecov.io/gh/hugovk/pepotron)\n[![Licence](https://img.shields.io/github/license/hugovk/pepotron.svg)](LICENSE.txt)\n[![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](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.1.1",
    "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": "bbfc75788f7725d0a9f966ea93ecc53e15ad02c1694509856e74c0de1ebed693",
                "md5": "dba9f11017a93e1b188bf05ff067ef6e",
                "sha256": "0deec9f21fd7857243e448098e5df528ef33af55e28ea1ba52e1ddb133be5c57"
            },
            "downloads": -1,
            "filename": "pepotron-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dba9f11017a93e1b188bf05ff067ef6e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8648,
            "upload_time": "2023-10-12T22:54:52",
            "upload_time_iso_8601": "2023-10-12T22:54:52.151458Z",
            "url": "https://files.pythonhosted.org/packages/bb/fc/75788f7725d0a9f966ea93ecc53e15ad02c1694509856e74c0de1ebed693/pepotron-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1397eb55af19e55946576643bf016359887221bc5ccd24944c98129f6dfa2bae",
                "md5": "a19ff1aa70eb20967765a8091587b18e",
                "sha256": "6f434c9a86238f4ba9f6ea8acd504eb3c450f50e936c9343ac7a1dc62dec4991"
            },
            "downloads": -1,
            "filename": "pepotron-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a19ff1aa70eb20967765a8091587b18e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13390,
            "upload_time": "2023-10-12T22:54:53",
            "upload_time_iso_8601": "2023-10-12T22:54:53.304675Z",
            "url": "https://files.pythonhosted.org/packages/13/97/eb55af19e55946576643bf016359887221bc5ccd24944c98129f6dfa2bae/pepotron-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-12 22:54:53",
    "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"
}
        
Elapsed time: 0.12704s