cookiecutter gh:fbidu/cookie-py
Esse é um modelo básico de cookiecutter para projetos Python que inclui várias ferramentas que gosto de usar.
Um modelo de cookiecutter serve para criar novos projetos com base em um formato pré-definido. No caso em todo projeto Python, eu gosto de usar certas ferramentas como Black, PyTest, PyLint, Pre-Commit e Poetry. Esse meu modelo instala tudo e configura tudo isso para mim!
É um modelo fortemente enviesado para o que eu gosto, uma vez que ele reflete minhas escolhas particulares sobre ferramentas, análises estáticas, hooks e etc.
Sinta-se livre para usar, forkear e modificar a vontade!
- Instale o Poetry
- Instale o Cookiecutter
- Execute
cookiecutter gh:fbidu/cookie-py - O seu terminal irá te perguntar tudo o que precisar!
Itens marcados estão implementados!
- Usar o Poetry para gerenciar pacotes
- Usar o pre-commit para cuidar de hooks pre-commit do git
- Instalar o Pytest
- Instalar o Black
- Executar Pytest pre-push
- Relatório de Coverage no Pytest
- Adicionar um Dockerfile simples que cuida das dependências do Poetry
- Black
- Pylint
This is a basic cookiecutter template for Python projects that includes everything I like to use.
A cookiecutter template is useful to create new projects based on a pre-defined model. In every Python project I like to use some tools like Black, PyTest, PyLint, Pre-Commit and Poetry. This template install and sets up all those tools for me!
It is highly opinionated since it reflects my personal choices about tooling, static analysis, hooks and so on.
Feel free to use, fork and modify at will!
- Install Poetry
- Install Cookiecutter
- Run
cookiecutter gh:fbidu/cookie-py - Your terminal will ask you everything it needs!
Checked items are implemented
- Use Poetry to manage packages
- Use Pre-commit to handle git pre-commit hooks
- Install Pytest
- Install Black
- Run Pytest pre-push
- Coverage report on Pytest
- Simple Dockerfile that handles Poetry dependencies
- Black
- Pylint