Welcome#
Modelo de projeto Python Jedi#
Incolume Project Model#
Objetivos#
Base com estrutura inicial para começar um projeto Python.
Descrição#
Estrutura base genérica para iniciar um projeto Python.
Escopo#
- Sistema operacional Linux preferencialmente (Linux Like ou WSL);
- git
- Python 3.10+
- poetry
Ferramentas aplicadas#
- bandit
- blue
- coverage
- isort
- mkdocs
- mypy
- pydocstyle
- pylint
- pytest
- safety
- taskipy
- tox
Exemplos e Uso#
Disponível em docs/api.
Registro de Mudanças#
Disponível em docs/about/CHANGELOG.md.
Contribuidores#
Disponível em docs/about/CONTRIBUTORS.md.
Convenções adotadas#
- GIT Conventional Commits
- Keep a Changelog
- PEP 8 - Estilo de codificação Python
- Versionamento Semântico
- Zen do Python - PEP20
Tecnologias adotadas#
Deseja aprender mais sobre alguns dos requisitos não funcionais utilizados no projeto?