Generate CHANGELOG.md
Project description
Incolume Python Changelog
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://github.com/development-incolume/incolume.py.changelog#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://github.com/development-incolume/incolume.py.changelog#main
Gerar pacote a partir dos fontes para instalação
poetry build
Exemplos e Uso
Exemplos e outras curiosidades sobre este projeto podem ser visualizadas em docs/api.
Registro de Mudanças
Disponível em docs/about/CHANGELOG.md.
Contribuidores
Disponível em docs/about/CONTRIBUTORS.md.
Tecnologias adotadas
Disponível em docs/user_guide/development.md.
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.9.0rc0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb9913bef536687fd7800a7f550830fec01f258ca867d7846496fe7400c1faff |
|
MD5 | 5db79b95eeb72e6cb560002e97eda2dd |
|
BLAKE2b-256 | 07a224889709f861d7bb3ce2f64c3abb33d9be2b35912376933757da0be0c2a4 |
Hashes for incolume_py_changelog-0.9.0rc0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a8a7966b77b40d219616ab3c2e3fded36a421f43f4484dedf7fc872400f8f07 |
|
MD5 | b2ac7e933d156305989490b9228e13b8 |
|
BLAKE2b-256 | 1e48d80aac9be9e69cd3b116ee7594f839f899a3f554b984e21afa0b27afb453 |