Skip to content

Latest commit

 

History

History
246 lines (169 loc) · 5.16 KB

README.md

File metadata and controls

246 lines (169 loc) · 5.16 KB
Raw

pepotron

PyPI version Supported Python versions PyPI downloads Test Codecov Licence Code style: Black

CLI to open PEPs in your browser.

Installation

From PyPI

python3 -m pip install --upgrade pepotron

With pipx

pipx install pepotron

From source

git clone https://github.com/hugovk/pepotron
cd pepotron
python3 -m pip install .

Usage

Open a PEP

Run pep or pepotron, they do the same thing.

$ pep 8
https://peps.python.org/pep-0008/
$ # Or:
$ pepotron 8
https://peps.python.org/pep-0008/
$ # Or:
$ uvx pepotron 8
https://peps.python.org/pep-0008/

Open release schedule PEP for a Python version

$ pep 3.11
https://peps.python.org/pep-0664/

Open a PEP by searching for words in the title

$ pep dead batteries
Score   Result
90      PEP 594: Removing dead batteries from the standard library
61      PEP 767: Annotating Read-Only Attributes
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

https://peps.python.org/pep-0594/

Open a PEP topic

$ pep governance
https://peps.python.org/topic/governance/
$ pep packaging
https://peps.python.org/topic/packaging/
$ pep release
https://peps.python.org/topic/release/
$ pep typing
https://peps.python.org/topic/typing/
$ pep topics
https://peps.python.org/topic/

Open a build preview of a python/peps PR

$ pep 594 --pr 2440
https://pep-previews--2440.org.readthedocs.build/pep-0594/

Open the PEPs website

$ pep
https://peps.python.org
$ pep --pr 2440
https://pep-previews--2440.org.readthedocs.build

Find the next available PEP number

Check published PEPs and open PRs to find the next available PEP number.

$ pep next
Next available PEP: 769

Open a BPO issue in the browser

Issues from bugs.python.org have been migrated to GitHub issues and have new numbers. This command will open the redirect page to take you to the new issue.

$ bpo 46208
https://bugs.python.org/issue?@action=redirect&bpo=46208

This redirects to python/cpython#90366

Help

$ 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, or 'next' to
                 find next available PEP number

options:
  -h, --help     show this help message and exit
  -u, --url URL  Base URL for PEPs (default: https://peps.python.org)
  -p, --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
$ 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