Skip to content

Commit

Permalink
feat: Refactor poetry installation (#117)
Browse files Browse the repository at this point in the history
* build: Remove reference to poetry in pyproject

* build: Upgrade version

* build: Install standalone poetry

* build: Upgrade version

* docs: Update changelog and readme
  • Loading branch information
lorenzomammana committed May 22, 2024
1 parent 9dbd1bf commit 112b405
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 592 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
setup.py
- name: Install Package
run: |
python -m pip install -U pip poetry
python -m poetry install --no-cache --with test -E onnx
curl -sSL https://install.python-poetry.org | python3 -
poetry install --no-cache --with test -E onnx
- name: Run Tests
run: |
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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.

Expand Down
Loading

0 comments on commit 112b405

Please sign in to comment.