Initialized the repo based on hatch for testing, formatting, linting, environment management, and as building system. We are using mostly hatch defaults to not make complicated pyproject.toml so it is easier to maintain which are ruff as formatter and linter and pytest for tests. For the documentation I set up sphinx. The idea would be use sphinx with MyST so it is easier to maintain as we can just write markdown files. Because hatch cannot interpret the org file I changed the README file to rst, since we can integrate it better with the sphinx docs. Added basic developer information about developer tools to the README.
TODOs/Issues:
[x] The CI currently is invoked twice. I think the CI should be
push:
branches: [main]
pull_request:
# Check all PR
But then it only gets active after this PR is merged, so might change this in a future PR
Initialized the repo based on
hatchfor testing, formatting, linting, environment management, and as building system. We are using mostlyhatchdefaults to not make complicatedpyproject.tomlso it is easier to maintain which are ruff as formatter and linter and pytest for tests. For the documentation I set up sphinx. The idea would be use sphinx with MyST so it is easier to maintain as we can just write markdown files. Because hatch cannot interpret theorgfile I changed the README file torst, since we can integrate it better with the sphinx docs. Added basic developer information about developer tools to the README.TODOs/Issues:
But then it only gets active after this PR is merged, so might change this in a future PR