pypi-list/README.md
2021-06-25 08:22:59 -05:00

41 lines
791 B
Markdown

# pypi-list
Live on [pypi-list.waylonwalker.com](https://pypi-list.waylonwalker.com/)
Listing python packages from pypi, and finding available single word packages.
## Install
``` bash
pip install -r requirements.txt
```
## Run the Pipeline
``` bash
# Run with existing package data
python pypi-list.py
# Full run
python pypi-list.py --full
```
## Scheduled on GitHub actions
This pipeline run daily at `0:0` to generate a `packages.json`,
`unavailable.json`, `avalilable.json`.
## Development
``` bash
pip install -e ".[dev]"
```
This project includes a `pre-commit-config`, this ensures that each commit made
to the project passes all checks that are also ran in CI. To setup pre-commit
in your development environment run the follow command.
``` bash
pre-commit install
```