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

Improve dev cycle #55

Closed
7 tasks done
oniboni opened this issue May 9, 2024 · 0 comments · Fixed by #57
Closed
7 tasks done

Improve dev cycle #55

oniboni opened this issue May 9, 2024 · 0 comments · Fixed by #57

Comments

@oniboni
Copy link
Collaborator

oniboni commented May 9, 2024

Description

The project setup is rather outdated and does not comply to PEP 621.
We need automated tests for CI/CD.

Background

pip 21.1 was released in 2021. Prior to this version a pyproject.toml was not yet supported for projects 1.

There have been lots of attempts to standardize the python project setup and multiple build backends exist with pros and cons for each of them.

Hatch seems to be the easiest way to setup and maintain projects and dev cycles, and brings static code analysis (backed by ruff) effortlessly to the project.

Definition of Done

  • setup.py -> pyproject.toml
  • setup hatch environments for dev jobs
  • find a way to test this plugin with mkdocs
  • add tests for raised and solved issues
  • add CI job to automate
  • add pre-commit hook(s) to simplify dev cycle
  • add documentation about how to develop within this project
@oniboni oniboni changed the title Add tests Improve dev cycle May 9, 2024
@oniboni oniboni linked a pull request May 9, 2024 that will close this issue
@oniboni oniboni mentioned this issue May 16, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant