incolume.py.changelog 0.8.0

Generate CHANGELOG.md

Python Incolume Utils

---

Projeto desenvolvido e administrado incolume.com.br

Este gera o Changelog a partir dos registros encontrados em git tag -n.

Instalar o pacote

Instalação com pip

pip install incolume.py.changelog

Instalação com pipenv

pipenv install incolume.py.changelog

Instalação com poetry

poetry add incolume.py.changelog

poetry add git+https://gitlab.com/development-incolume/incolumepy.utils.git#main

Atualizar o pacote

Atualização com pip

pip install -U incolume.py.changelog

Atualização com pipenv

pipenv update incolume.py.changelog

Atualização com poetry

poetry update incolume.py.changelog

poetry update git+https://gitlab.com/development-incolume/incolumepy.utils.git#main

Gerar pacote a partir dos fontes para instalação

poetry build

Documentação detalhada

Exemplos da API disponíveis em docs/api

Incolume Python Changelog

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.