build: switch to Poetry

2026-09-29 06:44:00 -06:00 · 2021-12-20 23:29:37 +01:00
parent bbe3842a2f
commit 3b2d9db2e2
6 changed files with 349 additions and 31 deletions
@@ -42,6 +42,26 @@ $ cd pq-cli
 $ pip install --user .
 ```

+## Contributing
+
+```sh
+# Clone the repository:
+git clone https://github.com/rr-/pqcli.git
+cd pqcli
+
+# Install to a local venv:
+poetry install
+
+# Install pre-commit hooks:
+poetry run pre-commit install
+
+# Enter the venv:
+poetry shell
+```
+
+This project uses [poetry](https://python-poetry.org/) for packaging.
+Install instructions are available at [poetry#installation](https://python-poetry.org/docs/#installation).
+
 ## Troubleshooting

 ### `_curses.error: init_pair() returned ERR`