peplum 1.0.1

A terminal-based PEP lookup manager

Peplum

Introduction

Peplum is a terminal-based lookup manager for Python Enhancement Proposals. It provides the ability to browse, filter and search the metadata for all the PEPs available via the PEP API.

Installing

pipx

The package can be installed using pipx:

$ pipx install peplum

Homebrew

The package is available via Homebrew. Use the following commands to install:

$ brew tap davep/homebrew
$ brew install peplum

Using Peplum

Once you've installed Peplum using one of the above methods, you can run the application using the peplum command.

The best way to get to know Peplum is to read the help screen, once in the main application you can see this by pressing F1.

For more information and details on configuring Peplum, see the online documentation.

File locations

Peplum stores files in a peplum directory within both $XDG_DATA_HOME and $XDG_CONFIG_HOME. If you wish to fully remove anything to do with Peplum you will need to remove those directories too.

Expanding for the common locations, the files normally created are:

• ~/.config/peplum/configuration.json -- The configuration file.
• ~/.local/share/peplum/*.json -- The locally-held PEP data.
• ~/.local/share/peplum/cache/*.rst -- The locally-cached PEP source files.

Getting help

If you need help, or have any ideas, please feel free to raise an issue or start a discussion.

TODO

See the TODO tag in issues to see what I'm planning.