Ir para o conteúdo

Incolume Python Changelog#

PyPI - Python Version codecov PyPI version

Tests CI/CD Ruff PyPI - Wheel PyPI - Status

Metodology: PEP8 Metodology: PEP20 Metodology: SemVer Metodology: keep-a-changelog Metodology: conventionalcommits

"style: ruff" Style: isort style: pydocstyle

Linter: mypy Linter: pylint Linter: flake8

security: bandit security: pipaudit security: safety

Objetivos#

Esta API automatiza a criação de um arquivo changelog utilizando os resgistros do git, para gerenciar melhor seus projetos, seguindo a metodologia do Keep a Changelog.

Descrição#

O funcionamento é através da captura dos registros do comando git tag -n, obtendo assim data, etiquetas e modificações, gerando então um arquivo de gerenciamento de mudanças relevantes para cada versão.

No pacote há ferramentas para Quality Assurance (QA) como ruff, mypy, pylint, isort, pydocstyle; além de ferramentas de segurança como bandit, pipaudit e safety.

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.

Tecnologias aplicadas#

Deseja aprender mais sobre alguns dos requisitos não funcionais utilizados no projeto? Consulte a sessão Padrões Aplicados em Guia de Contribuíção.