Este repositĂłrio Ă© um exemplo simples de como organizar um projeto Python seguindo boas prĂĄticas de estrutura, gerenciamento de dependĂȘncias e reprodutibilidade.
đŠ Este exemplo inclui:
- Estrutura organizada de pastas (
src/,data/, etc.) - Gerenciamento de ambientes com Conda ou venv + pip
- Scripts comentados e limpos
- Um arquivo
.csvde exemplo para leitura com Pandas
meu_projeto/
âââ README.md <- Este arquivo
âââ main.py <- Script principal de execução
âââ src/ <- Pacote com cĂłdigo reutilizĂĄvel
â âââ utils.py <- FunçÔes auxiliares
âââ data/ <- Dados de entrada (exemplo.csv)
â âââ exemplo.csv
âââ environment.yml <- DependĂȘncias para uso com Conda
âââ requirements.txt <- DependĂȘncias para uso com venv/pip
VocĂȘ precisa ter instalado:
- Python 3.11+
- Miniconda ou Anaconda (opcional, mas recomendado)
- Ou apenas o Python com
venvepip
-
Criar o ambiente:
conda env create -f environment.yml -
Ativar o ambiente:
conda activate meu_projeto_env -
Rodar o projeto:
python main.py
-
Criar o ambiente virtual:
python3 -m venv venv source venv/bin/activate -
Instalar dependĂȘncias:
pip install -r requirements.txt -
Rodar o projeto:
python main.py
- Como usar o Pandas para ler arquivos
.csv - Como estruturar pastas e arquivos para facilitar manutenção
- Como separar cĂłdigo em mĂłdulos reutilizĂĄveis (
src/utils.py) - Como documentar e compartilhar um projeto com ambiente isolado
Este projeto pode ser facilmente expandido para incluir:
- AnĂĄlise exploratĂłria de dados com Matplotlib ou Seaborn
- Scripts de scraping, automação ou machine learning
- Testes unitĂĄrios com
pytest - ConfiguraçÔes com
pyproject.tomlousetup.pypara empacotamento
- Use um ambiente virtual para cada projeto para evitar conflitos de dependĂȘncia.
- Sempre inclua um
README.md,requirements.txtouenvironment.ymlno seu projeto. - Prefira separar seus scripts em mĂłdulos dentro de
src/ouapp/para manter o projeto organizado. - Documente tudo!
Feito por Luan Camargo
Linkedin: Luan Camargo
GitHub: LuanAlvesCamargo
Sinta-se Ă vontade para clonar, estudar e adaptar!