# Incolume Python Changelog
--------
_Projeto desenvolvido e administrado por incolume.com.br_
[]((https://codecov.io/gh/development-incolume/incolume.py.changelog))
[](https://github.com/development-incolume/incolume.py.changelog/actions/workflows/unit-tests.yml)
[](https://github.com/astral-sh/ruff)
[](https://peps.python.org/pep-0008/)
[](https://peps.python.org/pep-0020/)
[](https://semver.org/lang/pt-BR)
[](https://keepachangelog.com/pt-BR/1.0.0/)
[](https://www.conventionalcommits.org/pt-br/v1.0.0/#specification)
[](https://github.com/astral-sh/ruff)
[](https://pycqa.github.io/isort/)
[](http://www.pydocstyle.org/en/stable/)
[](https://mypy.readthedocs.io/en/stable/)
[](https://pylint.pycqa.org/en/latest/)
[](https://flake8.pycqa.org/en/latest/)
[](https://bandit.readthedocs.io/en/latest/)
[](https://pypi.org/project/pip-audit/)
[](https://pypi.org/project/safety/)
[](https://pepy.tech/project/incolume-py-changelog)
[](https://pepy.tech/project/incolume-py-changelog)
[](https://pepy.tech/project/incolume-py-changelog)
---
### Incolume Python Changelog
Este gera o Changelog a partir dos registros encontrados em `git tag -n`.
## Instalar o pacote
### Instalação com pip
```shell
pip install incolume.py.changelog
```
### Instalação com pipenv
```shell
pipenv install incolume.py.changelog
```
### Instalação com poetry
```shell
poetry add -G dev incolume.py.changelog
```
```shell
poetry add -G dev git+https://github.com/development-incolume/incolume.py.changelog#main
```
### Instalação com uv
```shell
uv venv -p 3.8
uv pip add --dev incolume.py.changelog==0.13.1
```
## Atualizar o pacote
### Atualização com pip
```shell
pip install -U incolume.py.changelog
```
### Atualização com pipenv
```shell
pipenv update incolume.py.changelog
```
### Atualização com poetry
```shell
poetry update -G dev incolume.py.changelog
```
```shell
poetry update -G dev git+https://github.com/development-incolume/incolume.py.changelog#main
```
### Atualização com uv
```shell
uv venv -p 3.8
uv pip add --dev incolume.py.changelog==0.13.1
```
## Gerar pacote a partir dos fontes para instalação
```shell
poetry build
```
## Exemplos e Uso
Exemplos e outras curiosidades sobre este projeto podem
ser visualizadas em [docs/api](docs/api/index.md).
## Registro de Mudanças ##
Disponível em [docs/about/CHANGELOG.md](docs/about/CHANGELOG.md).
## Contribuidores ##
Disponível em [docs/about/CONTRIBUTORS.md](docs/about/CONTRIBUTORS.md).
## Tecnologias adotadas
Disponível em [docs/user_guide/development.md](docs/user_guide/development.md).
# Incolume Python Changelog
[]((https://codecov.io/gh/development-incolume/incolume.py.changelog))
[](https://github.com/development-incolume/incolume.py.changelog/actions/workflows/unit-tests.yml)
[](https://github.com/astral-sh/ruff)
[](https://peps.python.org/pep-0008/)
[](https://peps.python.org/pep-0020/)
[](https://semver.org/lang/pt-BR)
[](https://keepachangelog.com/pt-BR/1.0.0/)
[](https://www.conventionalcommits.org/pt-br/v1.0.0/#specification)
[](https://github.com/astral-sh/ruff)
[](https://pycqa.github.io/isort/)
[](http://www.pydocstyle.org/en/stable/)
[](https://mypy.readthedocs.io/en/stable/)
[](https://pylint.pycqa.org/en/latest/)
[](https://flake8.pycqa.org/en/latest/)
[](https://bandit.readthedocs.io/en/latest/)
[](https://pypi.org/project/pip-audit/)
[](https://pypi.org/project/safety/)
[](https://pepy.tech/project/incolume-py-changelog)
[](https://pepy.tech/project/incolume-py-changelog)
[](https://pepy.tech/project/incolume-py-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](api/index.md).
## Registro de Mudanças
Disponível em [docs/about/CHANGELOG.md](about/CHANGELOG.md).
## Contribuidores
Disponível em [docs/about/CONTRIBUTORS.md](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](user_guide/development.md).
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/incolume.py.changelog/",
"name": "incolume.py.changelog",
"maintainer": "britodfbr",
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": "contato@incolume.com.br",
"keywords": "python, utils, incolume",
"author": "britodfbr",
"author_email": "contato@incolume.com.br",
"download_url": "https://files.pythonhosted.org/packages/57/10/402b2d903164f5ac417c0535c40bb1c5461d031396b60f74040be9b0421d/incolume_py_changelog-0.14.0.tar.gz",
"platform": null,
"description": "# Incolume Python Changelog\n\n--------\n\n_Projeto desenvolvido e administrado por incolume.com.br_\n\n\n[]((https://codecov.io/gh/development-incolume/incolume.py.changelog))\n\n\n[](https://github.com/development-incolume/incolume.py.changelog/actions/workflows/unit-tests.yml)\n[](https://github.com/astral-sh/ruff)\n\n\n\n[](https://peps.python.org/pep-0008/)\n[](https://peps.python.org/pep-0020/)\n[](https://semver.org/lang/pt-BR)\n[](https://keepachangelog.com/pt-BR/1.0.0/)\n[](https://www.conventionalcommits.org/pt-br/v1.0.0/#specification)\n\n[](https://github.com/astral-sh/ruff)\n[](https://pycqa.github.io/isort/)\n[](http://www.pydocstyle.org/en/stable/)\n\n[](https://mypy.readthedocs.io/en/stable/)\n[](https://pylint.pycqa.org/en/latest/)\n[](https://flake8.pycqa.org/en/latest/)\n\n[](https://bandit.readthedocs.io/en/latest/)\n[](https://pypi.org/project/pip-audit/)\n[](https://pypi.org/project/safety/)\n\n\n\n\n[](https://pepy.tech/project/incolume-py-changelog)\n[](https://pepy.tech/project/incolume-py-changelog)\n[](https://pepy.tech/project/incolume-py-changelog)\n\n\n\n\n\n\n\n\n---\n\n### Incolume Python Changelog\n\nEste gera o Changelog a partir dos registros encontrados em `git tag -n`.\n\n## Instalar o pacote\n\n### Instala\u00e7\u00e3o com pip\n```shell\npip install incolume.py.changelog\n```\n### Instala\u00e7\u00e3o com pipenv\n```shell\npipenv install incolume.py.changelog\n```\n\n### Instala\u00e7\u00e3o com poetry\n```shell\npoetry add -G dev incolume.py.changelog\n```\n\n```shell\npoetry add -G dev git+https://github.com/development-incolume/incolume.py.changelog#main\n```\n\n### Instala\u00e7\u00e3o com uv\n```shell\nuv venv -p 3.8\nuv pip add --dev incolume.py.changelog==0.13.1\n```\n\n## Atualizar o pacote\n### Atualiza\u00e7\u00e3o com pip\n```shell\npip install -U incolume.py.changelog\n```\n### Atualiza\u00e7\u00e3o com pipenv\n```shell\npipenv update incolume.py.changelog\n```\n### Atualiza\u00e7\u00e3o com poetry\n```shell\npoetry update -G dev incolume.py.changelog\n```\n\n```shell\npoetry update -G dev git+https://github.com/development-incolume/incolume.py.changelog#main\n```\n\n### Atualiza\u00e7\u00e3o com uv\n```shell\nuv venv -p 3.8\nuv pip add --dev incolume.py.changelog==0.13.1\n```\n\n## Gerar pacote a partir dos fontes para instala\u00e7\u00e3o\n\n```shell\npoetry build\n```\n\n## Exemplos e Uso\nExemplos e outras curiosidades sobre este projeto podem\nser visualizadas em [docs/api](docs/api/index.md).\n\n\n## Registro de Mudan\u00e7as ##\nDispon\u00edvel em [docs/about/CHANGELOG.md](docs/about/CHANGELOG.md).\n\n\n## Contribuidores ##\nDispon\u00edvel em [docs/about/CONTRIBUTORS.md](docs/about/CONTRIBUTORS.md).\n\n\n## Tecnologias adotadas\nDispon\u00edvel em [docs/user_guide/development.md](docs/user_guide/development.md).\n# Incolume Python Changelog\n\n\n\n\n[]((https://codecov.io/gh/development-incolume/incolume.py.changelog))\n\n\n[](https://github.com/development-incolume/incolume.py.changelog/actions/workflows/unit-tests.yml)\n[](https://github.com/astral-sh/ruff)\n\n\n\n[](https://peps.python.org/pep-0008/)\n[](https://peps.python.org/pep-0020/)\n[](https://semver.org/lang/pt-BR)\n[](https://keepachangelog.com/pt-BR/1.0.0/)\n[](https://www.conventionalcommits.org/pt-br/v1.0.0/#specification)\n\n[](https://github.com/astral-sh/ruff)\n[](https://pycqa.github.io/isort/)\n[](http://www.pydocstyle.org/en/stable/)\n\n[](https://mypy.readthedocs.io/en/stable/)\n[](https://pylint.pycqa.org/en/latest/)\n[](https://flake8.pycqa.org/en/latest/)\n\n[](https://bandit.readthedocs.io/en/latest/)\n[](https://pypi.org/project/pip-audit/)\n[](https://pypi.org/project/safety/)\n\n\n\n\n[](https://pepy.tech/project/incolume-py-changelog)\n[](https://pepy.tech/project/incolume-py-changelog)\n[](https://pepy.tech/project/incolume-py-changelog)\n\n\n\n\n\n\n\n\n---\n## Objetivos\n\nEsta API automatiza a cria\u00e7\u00e3o de um arquivo changelog utilizando os resgistros do git, para gerenciar melhor seus projetos, seguindo a metodologia do Keep a Changelog.\n\n## Descri\u00e7\u00e3o\n\nO funcionamento \u00e9 atrav\u00e9s da captura dos registros do comando `git tag -n`,\nobtendo assim data, etiquetas e modifica\u00e7\u00f5es, gerando ent\u00e3o um arquivo de\ngerenciamento de mudan\u00e7as relevantes para cada vers\u00e3o.\n\nNo pacote h\u00e1 ferramentas para Quality Assurance (QA) como ruff, mypy, pylint,\nisort, pydocstyle; al\u00e9m de ferramentas de seguran\u00e7a como bandit, pipaudit e safety.\n\n\n## Exemplos e Uso\nDispon\u00edvel em [docs/api](api/index.md).\n\n\n## Registro de Mudan\u00e7as\nDispon\u00edvel em [docs/about/CHANGELOG.md](about/CHANGELOG.md).\n\n\n## Contribuidores\nDispon\u00edvel em [docs/about/CONTRIBUTORS.md](about/CONTRIBUTORS.md).\n\n\n## Tecnologias aplicadas\nDeseja aprender mais sobre alguns dos requisitos\nn\u00e3o funcionais utilizados no projeto?\nConsulte a sess\u00e3o [Padr\u00f5es Aplicados em Guia de Contribu\u00ed\u00e7\u00e3o](user_guide/development.md).",
"bugtrack_url": null,
"license": "Unlicense",
"summary": "Generate CHANGELOG.md",
"version": "0.14.0",
"project_urls": {
"Documentation": "https://development-incolume.github.io/incolume.py.changelog/",
"Git": "https://github.com/development-incolume/incolume.py.changelog.git",
"Homepage": "https://pypi.org/project/incolume.py.changelog/",
"Oficial": "https://pypi.org/project/incolume.py.changelog/",
"Repository": "https://github.com/development-incolume/incolume.py.changelog.git",
"Source": "https://github.com/development-incolume/incolume.py.changelog/releases",
"Tracker": "https://github.com/development-incolume/incolume.py.changelog/issues"
},
"split_keywords": [
"python",
" utils",
" incolume"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46418b1a7f6ffaa2f1d88f04742ff5b0f25790ee0b873c632079ac9f220848b9",
"md5": "f3e4b57fcecccf8ca10366d3fcfccff0",
"sha256": "18e4200e61ad10c86ae6b3bc548519ddb596388c6ae54c15651d128cbad7e5f7"
},
"downloads": -1,
"filename": "incolume_py_changelog-0.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3e4b57fcecccf8ca10366d3fcfccff0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 11287,
"upload_time": "2025-01-15T11:23:00",
"upload_time_iso_8601": "2025-01-15T11:23:00.094893Z",
"url": "https://files.pythonhosted.org/packages/46/41/8b1a7f6ffaa2f1d88f04742ff5b0f25790ee0b873c632079ac9f220848b9/incolume_py_changelog-0.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5710402b2d903164f5ac417c0535c40bb1c5461d031396b60f74040be9b0421d",
"md5": "b99fb5fe2282e44ef600eb6615374a4b",
"sha256": "df06e9557aa42c4cb1080080585bf8a579a72b23c1d72fb6ccdf829f4a307a1e"
},
"downloads": -1,
"filename": "incolume_py_changelog-0.14.0.tar.gz",
"has_sig": false,
"md5_digest": "b99fb5fe2282e44ef600eb6615374a4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 334744,
"upload_time": "2025-01-15T11:23:01",
"upload_time_iso_8601": "2025-01-15T11:23:01.185979Z",
"url": "https://files.pythonhosted.org/packages/57/10/402b2d903164f5ac417c0535c40bb1c5461d031396b60f74040be9b0421d/incolume_py_changelog-0.14.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 11:23:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "development-incolume",
"github_project": "incolume.py.changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "incolume.py.changelog"
}
JSON
