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.0a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 968c8742d7f38300cc9bf769b68c50ad719980fcbffa597d3ce407579374da56 |
|
MD5 | 4f77e9269af6cfd2d30dcdc2357758c9 |
|
BLAKE2b-256 | ec0674c9853f1b5452961b7d899153f36fb2886b69d08d428f545656d59ad26a |
Hashes for incolume_py_changelog-0.8.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe9fc1006634599c4938be8d2c1d4f547fbd933ee99f537f9ac95352f36c37dd |
|
MD5 | eeb6b32f1c65facee6544bc3c2030346 |
|
BLAKE2b-256 | 76246596f874d8f418035043692be3ee1bbb953a317f52e083fabb5c883f76e1 |