Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to pyproject.toml and poetry #180

Merged
merged 25 commits into from
May 10, 2024
Merged

Switch to pyproject.toml and poetry #180

merged 25 commits into from
May 10, 2024

Conversation

JR-1991
Copy link
Member

@JR-1991 JR-1991 commented Apr 11, 2024

Overview

This PR converts the previous setup.py implementation to the current standard of using pyproject.toml using poetry. For this all dependencies originally found within the requirements directory have been included as individual groups (e.g. dev, tests etc.). Furthermore, the requirements.txt file has been updated to include the dependencies with which the tests have been run, following the argument in this StackOverflow answer. Last but not least, a build.yml workflow has been added to test the library's build status and a publishing workflow publish.yml to publish on release automatically.

This PR also adds a linting workflow based on Ruff which implements flake8 and black rules. The pre-commit hook has also been modified to use ruff for linting and format checks. Ruff is much faster and the pre-commit hooks finish almost instantly - We love performance, don't we? 🤓

TLDR

  • Switch from setup.py to pyproject.toml
  • Addition of build.yml workflow to test build status
  • Addition of lint.yml workflow for ruff linting
  • Added ruff to pre-commit hooks

ToDo's

  • Check which dependencies to keep, especially within dev group.
  • Add workflow to test publishing at Test PyPI (access is required) Independent of this PR

@JR-1991 JR-1991 added the dependencies Pull requests that update a dependency file label Apr 11, 2024
@JR-1991 JR-1991 added this to the 0.3.2 milestone Apr 11, 2024
@JR-1991 JR-1991 self-assigned this Apr 11, 2024
@JR-1991 JR-1991 marked this pull request as ready for review May 10, 2024 10:03
@JR-1991 JR-1991 merged commit e149282 into master May 10, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
Development

Successfully merging this pull request may close these issues.

1 participant