What is included on this project?
π¦ A basic pyproject.toml
file to provide installation, packaging and distribution for your project.
π§ͺ Testing structure using Pytest.
β Code linter Ruff.
βοΈ Code formatter using Black.
π€ Typing checking using Mypy.
π Continuous integration using Github Actions with jobs to check the quality of your code.
π Documentation with Sphinx and Readthedocs.
This repository contains the following files and folders:
π¦ Repository
β£ π .github : contain the github settings
β β π ISSUE_TEMPLATE : contains issues templates
β β π *.yaml
β β π workflows : contains CICD processes
β β£ π code_quality.yml : Ruff + Black + mypy
β β π tests.yml : pytest + CodeCov
β£ π docs: contains the documentation.
β£ π project_name: contains the project code.
β β π *.py
β£ π test: contains the project tests.
β β π test_*.py
β£ π .gitignore: lists the files/folders to ignore for git.
β£ π pre-commit-config.yaml: configuration file for pre-commit.
β£ π CITATION.cff: citation information.
β£ π CODE_OF_CONDUCT.md: code of conduct.
β£ π CONTRIBUTING.md: contributing guidelines.
β£ π LICENSE: license file.
β£ π pyproject.toml: project configuration file.
β£ π README.md: markdown file containing the project's readme.
β£ π readthedocs.yml: Settings for readthedocs.