-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace poetry by PEP-621 compliant pyproject.toml (#9)
- Loading branch information
Showing
11 changed files
with
129 additions
and
692 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,6 @@ tests/integration/**/output.* | |
|
||
# OS Specific | ||
.DS_Store | ||
|
||
# Environments | ||
.venv |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
3.11 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,8 +16,6 @@ | |
- [Overview](#overview) | ||
- [Pre-commit Hook](#pre-commit-hook) | ||
- [Installation](#installation) | ||
- [With pip](#with-pip) | ||
- [With Poetry](#with-poetry) | ||
- [Usage](#usage) | ||
- [Arguments](#arguments) | ||
- [Limitations](#limitations) | ||
|
@@ -56,18 +54,11 @@ repos: | |
## Installation | ||
### With pip | ||
```bash | ||
pip install git+https://github.com/csia-pme/[email protected] | ||
``` | ||
|
||
### With Poetry | ||
|
||
```bash | ||
poetry add git+https://github.com/csia-pme/[email protected] | ||
``` | ||
|
||
## Usage | ||
|
||
```bash | ||
|
@@ -119,33 +110,39 @@ blocks. | |
|
||
### Development | ||
|
||
Firstly, install the pre-commit hooks: | ||
Create and enable a virtual environment: | ||
|
||
```bash | ||
pre-commit install | ||
python -m venv .venv | ||
source .venv/bin/activate | ||
``` | ||
|
||
Then, install the development dependencies: | ||
Install the development dependencies: | ||
|
||
```bash | ||
poetry install | ||
pip install . | ||
``` | ||
|
||
Install the pre-commit hooks: | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
|
||
### Testing | ||
|
||
To run the tests: | ||
|
||
```bash | ||
poetry run pytest | ||
pytest | ||
``` | ||
|
||
### Linting | ||
|
||
To lint the code: | ||
|
||
```bash | ||
poetry run flake8 | ||
poetry run black --check . | ||
pre-commit run -a | ||
``` | ||
|
||
### Releasing | ||
|
@@ -156,7 +153,7 @@ poetry run black --check . | |
|
||
```bash | ||
# Bump the version in pyproject.toml | ||
poetry version <version> | ||
sed -i 's/version = ".*"/version = "0.x.y"/' pyproject.toml | ||
# Create a new tag | ||
git tag <version> main | ||
# Push the tag | ||
|
@@ -172,7 +169,6 @@ git push origin <version> | |
This project is built with the following tools: | ||
|
||
- [`pre-commit`](https://pre-commit.com/) | ||
- [`poetry`](https://python-poetry.org/) | ||
- [`pytest`](https://docs.pytest.org/) | ||
- [`flake8`](https://flake8.pycqa.org/en/latest/) | ||
- [`black`](https://black.readthedocs.io/en/stable/) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.