From a04d393ab1838c9423eb5c4271e0dc25b86dd530 Mon Sep 17 00:00:00 2001 From: Lorenzo Mammana Date: Wed, 22 May 2024 09:44:07 +0200 Subject: [PATCH] docs: Update changelog and readme --- CHANGELOG.md | 7 +++++++ README.md | 14 ++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3aa26b9c..7748c33c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ # Changelog All notable changes to this project will be documented in this file. +### [2.1.6] + +#### Updated + +- Remove poetry dependencies from quadra toml +- Update readme to explain how to use poetry properly + ### [2.1.5] #### Fixed diff --git a/README.md b/README.md index 20b5e713..c857b785 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ source myenv/bin/activate * **Install the `quadra` package** with poetry: ```shell - pip install poetry + curl -sSL https://install.python-poetry.org | python3 - poetry add git+https://github.com/orobix/quadra.git ``` @@ -241,9 +241,15 @@ First clone the repository from Github First clone the repository from `Github`, then we need to install the package with optional dependencies (generally in editable mode) and enable the pre-commit hooks. 1. `git clone https://github.com/orobix/quadra.git && cd quadra` -1. Install `quadra` package in editable mode `poetry install --with test,dev,docs --all-extras` -2. Install pre-commit hooks `pre-commit install` -3. (Optional) Eventually build documentation by calling required commands (see below). +2. Install poetry `curl -sSL https://install.python-poetry.org | python3 -` +3. Install the required poetry plugins + ``` + poetry self add poetry-bumpversion + poetry self add poetry-dotenv-plugin + ``` +4. Install `quadra` package in editable mode `poetry install --with test,dev,docs --all-extras` +5. Install pre-commit hooks `pre-commit install` +6. (Optional) Eventually build documentation by calling required commands (see below). Now you can start developing and the pre-commit hooks will run automatically to prevent you from committing code that does not pass the linting and formatting checks.