From 42931d4aeb355ecc34426e912a996949463103ab Mon Sep 17 00:00:00 2001 From: Nicola Sella Date: Mon, 19 Aug 2024 14:40:53 +0200 Subject: [PATCH] Edit readme and contributing Signed-off-by: Nicola Sella --- CONTRIBUTING.md | 13 +++++++------ README.md | 4 ++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b63672cc..03039b30 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,11 +25,10 @@ Please don't include any private/sensitive information in your issue! ## Tools we use -- Python 3.6 +- Python >= 3.6 - [pylint](https://www.pylint.org/) - [black](https://github.com/psf/black) - [tox](https://tox.readthedocs.io/en/latest/) -- You may need to use [virtualenv](https://virtualenv.pypa.io/en/latest/) to support Python 3.6 ## Testing @@ -41,7 +40,7 @@ Integration tests would be required for large changes (TBD). Run unit tests and get coverage report: ``` -pip install tox +hatch shell tox -e coverage ``` @@ -65,9 +64,11 @@ tox -e coverage ## Coding conventions -- Use [black](https://github.com/psf/black) code formatter. If you have tox - installed, run `tox -e black` to see what changes will be made. You can use - `tox -e black-format` to update the code formatting prior to committing. +- Formatting and linting are incorporated using [ruff](https://docs.astral.sh/ruff/). +- If you use [pre-commit](https://pre-commit.com/) the checks will run automatically + when you commit some changes +- If you prefer to run the ckecks manually, use `tox -e fix` to run the + pre-commit checks for you. - Pass pylint - exceptions are possible, but you will need to make a good argument - Use spaces not tabs for indentation diff --git a/README.md b/README.md index 1a8da562..96d4cbed 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ It is currently under development and contributors are welcome! ## Dependencies -* For runtime dependencies, see [requirements.txt](https://github.com/containers/podman-py/blob/main/requirements.txt). -* For testing and development dependencies, see [test-requirements.txt](https://github.com/containers/podman-py/blob/main/test-requirements.txt). +* Runtime dependencies are specified in [pyproject.toml](https://github.com/containers/podman-py/blob/main/pyproject.toml). +* Testing dependencies can be installed via `pip install -e .[test]` ## Example usage