Python Starter

📋 Conteúdo

• Pré-requisitos
• Primeiros Passos
• Estrutura do Projeto
• Desenvolvimento
• Solução de Problemas no Windows

🔧 Pré-requisitos

Certifique-se de instalar os seguintes programas antes de começar:

• Visual Studio Code Download VSCode

• Git Download Git

• uv

  Instale utilizando o comando adequado ao seu sistema operacional:

  # Windows (PowerShell)
  powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
  
  # macOS/Linux
  curl -LsSf https://astral.sh/uv/install.sh | sh

🚀 Primeiros Passos

Siga os passos abaixo para configurar rapidamente o projeto:

1. Clone o repositório

git clone https://github.com/cacdia/python-starter.git
cd python-starter

2. Configure o ambiente virtual

Crie o ambiente virtual e instale automaticamente todas as dependências:

uv sync

3. Configure o VSCode

Abra o projeto no Visual Studio Code:

code .

Instale as extensões recomendadas

Ao abrir o projeto pela primeira vez:

• Uma notificação aparecerá sugerindo a instalação das extensões recomendadas.
• Clique em Install All ou em Show Recommendations.
• Alternativamente, pressione Ctrl+Shift+X (ou Cmd+Shift+X no macOS) e digite @recommended na barra de pesquisa.

As extensões recomendadas para este projeto são:

• Error Lens (usernamehw.errorlens)
• Python (ms-python.python)
• Ruff (charliermarsh.ruff)

Selecione o interpretador Python correto

1. Pressione Ctrl+Shift+P (ou Cmd+Shift+P no macOS).
2. Digite Python: Select Interpreter.
3. Escolha o interpretador Python referente ao ambiente virtual criado (.venv), geralmente exibido como: "Python 3.13 ('.venv':venv)".

4. Execute o projeto

uv run main.py

Para executar diretamente pelo Python:

python main.py "<frase>"

📁 Estrutura do Projeto

python-starter/
├── main.py              # Ponto de entrada do programa
├── pyproject.toml       # Metadados e dependências do projeto
├── ruff.toml            # Configurações específicas do Ruff
├── src/                 # Diretório de código fonte
│   ├── __init__.py      # Torna o diretório um pacote (arquivo vazio)
│   └── vaca.py          # Função vaca_diz para exibir frase e arte ASCII de vaca
└── .vscode/             # Configurações otimizadas para VSCode
    ├── extensions.json  # Extensões recomendadas
    ├── settings.json    # Configurações específicas do projeto
    └── tasks.json       # Tarefas configuradas para o projeto

💻 Desenvolvimento

Comandos essenciais

Use os comandos abaixo para facilitar o desenvolvimento do projeto:

# Executar o código
uv run main.py        # recomendado

# Formatar código com Ruff
uv run ruff format . --check

# Verificar e corrigir lint com Ruff
uv run ruff check . --fix

# Adicionar uma nova dependência
uv add nome-do-pacote

# Sincronizar dependências após alterações no pyproject.toml
uv sync

Também é possível executar as tarefas configuradas pelo VS Code:

1. Pressione Ctrl+Shift+P (ou Cmd+Shift+P no macOS).
2. Digite Tasks: Run Task.
3. Selecione uma das tarefas disponíveis:
   • Formatar com Ruff: Verifica a formatação do código
   • Lint com Ruff: Executa o linter e corrige problemas automaticamente

🪟 Solução de Problemas no Windows

Caso enfrente problemas relacionados a permissões no PowerShell, execute:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser