Generate CHANGELOG.md
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for incolume_py_changelog-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1707ea7f84359961c177abef695d8e71010e189b6fa32656fcd5408648292e7a |
|
MD5 | 53680847d2e1c28bc10e893f0243f19b |
|
BLAKE2b-256 | e5eedaceb63ac46e3a3ecb36b4ef2046efe01b82169306ed6066b72dd22373e5 |
Hashes for incolume_py_changelog-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53103093f6d375314fef8bc3fb14fb0dca03b2ad26ec7e8fdacb337af8228939 |
|
MD5 | 0b20cf5b83346d26cb4762505435959b |
|
BLAKE2b-256 | 31591a9356f7c8196cb1d5bd4062e313269adda2b114da1689ecd885929518aa |