Commit graph

6 commits

Author SHA1 Message Date
fb407631d9
Set up code formatting tools
- auto-format code with:
  + autoflake => * remove unused imports and variables
                 * remove duplicate dict keys
                 * expand star imports
  + black => enforce an uncompromising code style
  + isort => enforce a consistent import style
             compliant with Google's Python style guide
- add nox session "format" to run these tools
2024-09-10 01:27:34 +02:00
ceabb00bab
Set up nox as the task runner
- base configuration for all nox sessions to come
- add infos about nox in the README file
- ignore [py]cache folders in git
2024-09-10 01:21:37 +02:00
e832333ed9
Initialize the project
- describe how a local develop environment can be set up
- we use poetry to manage the project
  => add pyproject.toml and poetry.lock files
- add a package for the source code
  => "src" layout structure to ensure that pytest runs the tests
     against a packaged version installed in a virtual environment
     and not the *.py files in the project directory
     (Source: https://hynek.me/articles/testing-packaging/)
- ignore poetry's artifacts in git
2024-09-10 01:15:36 +02:00
c7d8b7f283
Add README file
- describe the project's goals
- contributions are welcome
- mention the GitFlow branching model
2024-09-10 01:02:32 +02:00
8ebd6c9f71
Add open-source license
MIT license because the project is for everybody
2024-09-10 00:45:24 +02:00
3416deccb9
Math is the language of the universe. 2024-09-10 00:43:00 +02:00