# Peplum
## Introduction
Peplum is a terminal-based lookup manager for [Python Enhancement
Proposals](https://peps.python.org). 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`](https://pypa.github.io/pipx/):
```sh
$ pipx install peplum
```
Once installed run the `peplum` command.
### Homebrew
The package is available via Homebrew. Use the following commands to install:
```sh
$ brew tap davep/homebrew
$ brew install peplum
```
Once installed run the `peplum` command.
## Using Peplum
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 <kbd>F1</kbd>.
## File locations
Peplum stores files in a `peplum` directory within both
[`$XDG_DATA_HOME` and
`$XDG_CONFIG_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/).
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/peps.json` -- The locally-held PEP data.
## Getting help
If you need help, or have any ideas, please feel free to [raise an
issue](https://github.com/davep/peplum/issues) or [start a
discussion](https://github.com/davep/peplum/discussions).
## TODO
See [the TODO tag in
issues](https://github.com/davep/peplum/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
to see what I'm planning.
[//]: # (README.md ends here)
Raw data
{
"_id": null,
"home_page": null,
"name": "peplum",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "chui, documentation, pep, terminal, tui",
"author": null,
"author_email": "Dave Pearson <davep@davep.org>",
"download_url": "https://files.pythonhosted.org/packages/53/d8/f49f038fae0f73a8455d2a850c6a1819e63ed7220b6d05f4b8b539c05bd5/peplum-0.1.0.tar.gz",
"platform": null,
"description": "# Peplum\n\n\n\n## Introduction\n\nPeplum is a terminal-based lookup manager for [Python Enhancement\nProposals](https://peps.python.org). It provides the ability to browse,\nfilter and search the metadata for all the PEPs available via the PEP API.\n\n## Installing\n\n### pipx\n\nThe package can be installed using [`pipx`](https://pypa.github.io/pipx/):\n\n```sh\n$ pipx install peplum\n```\n\nOnce installed run the `peplum` command.\n\n### Homebrew\n\nThe package is available via Homebrew. Use the following commands to install:\n\n```sh\n$ brew tap davep/homebrew\n$ brew install peplum\n```\n\nOnce installed run the `peplum` command.\n\n## Using Peplum\n\nThe best way to get to know Peplum is to read the help screen, once in the\nmain application you can see this by pressing <kbd>F1</kbd>.\n\n\n\n## File locations\n\nPeplum stores files in a `peplum` directory within both\n[`$XDG_DATA_HOME` and\n`$XDG_CONFIG_HOME`](https://specifications.freedesktop.org/basedir-spec/latest/).\nIf you wish to fully remove anything to do with Peplum you will need to\nremove those directories too.\n\nExpanding for the common locations, the files normally created are:\n\n- `~/.config/peplum/configuration.json` -- The configuration file.\n- `~/.local/share/peplum/peps.json` -- The locally-held PEP data.\n\n## Getting help\n\nIf you need help, or have any ideas, please feel free to [raise an\nissue](https://github.com/davep/peplum/issues) or [start a\ndiscussion](https://github.com/davep/peplum/discussions).\n\n## TODO\n\nSee [the TODO tag in\nissues](https://github.com/davep/peplum/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)\nto see what I'm planning.\n\n[//]: # (README.md ends here)\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
"summary": "A terminal-based PEP lookup manager",
"version": "0.1.0",
"project_urls": {
"Discussions": "https://github.com/davep/peplum/discussions",
"Documentation": "https://github.com/davep/peplum/blob/main/README.md",
"Homepage": "https://github.com/davep/peplum",
"Issues": "https://github.com/davep/peplum/issues",
"Repository": "https://github.com/davep/peplum",
"Source": "https://github.com/davep/peplum"
},
"split_keywords": [
"chui",
" documentation",
" pep",
" terminal",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5c4e011e46ba7ba3a0386f7c0ec682c3f3c5e8be4caaef03f74f611321a6ca4",
"md5": "a6624a375ec833b0173298551884b46e",
"sha256": "b85103b6a961ae34775e3eca1c18809a6446de880c9389ec260384636ba8fd96"
},
"downloads": -1,
"filename": "peplum-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6624a375ec833b0173298551884b46e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 54222,
"upload_time": "2025-01-25T11:52:56",
"upload_time_iso_8601": "2025-01-25T11:52:56.627994Z",
"url": "https://files.pythonhosted.org/packages/a5/c4/e011e46ba7ba3a0386f7c0ec682c3f3c5e8be4caaef03f74f611321a6ca4/peplum-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53d8f49f038fae0f73a8455d2a850c6a1819e63ed7220b6d05f4b8b539c05bd5",
"md5": "60305e164eb53296b05a1fef4bb264b1",
"sha256": "14c55576118d7659aebda5e413f004d2f98e0229cdc0be314cbe59d298bbca68"
},
"downloads": -1,
"filename": "peplum-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "60305e164eb53296b05a1fef4bb264b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 583373,
"upload_time": "2025-01-25T11:52:58",
"upload_time_iso_8601": "2025-01-25T11:52:58.891507Z",
"url": "https://files.pythonhosted.org/packages/53/d8/f49f038fae0f73a8455d2a850c6a1819e63ed7220b6d05f4b8b539c05bd5/peplum-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 11:52:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davep",
"github_project": "peplum",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "peplum"
}
JSON
