TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
When getting started install dependencies with poetry and initiate pre-commit
poetry install
poetry run pre-commit installTo add dependencies use poetry add
poetry add <package> [-G <group>]- Latest releases
- API references
You can build the project using poetry
poetry buildAnd run tests like so
poetry run pytestTODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files: