Um guia para gerenciar adequadamente chaves de API e variáveis ​​de ambiente em projetos Python

? Introdução

Ao trabalhar com APIs em Python, muitas vezes você precisa usar chaves de API ou outras credenciais confidenciais. É crucial gerenciar essas chaves com segurança para evitar o vazamento de informações confidenciais ou enviá-las acidentalmente ao seu repositório Git.

Para uma demonstração completa, confira meu repositório GitHub Secure-API-Key-Handling. Ele apresenta um aplicativo de bate-papo Streamlit que gerencia chaves de API com segurança usando arquivos .env e o pacote python-dotenv enquanto interage com o modelo Gemini Generative AI .

? Começando

Siga estas etapas para configurar seu projeto para manipulação segura de chaves de API:

1. Instale dependências

Você precisará do pacote python-dotenv para carregar variáveis ​​de ambiente de um arquivo .env.

pip install python-dotenv

2. Configure um arquivo .env

Crie um arquivo .env na raiz do seu projeto, onde você armazenará sua chave de API e outras variáveis ​​específicas do ambiente:

# .env
API_KEY=your_api_key_here

Importante: Este arquivo .env nunca deve ser enviado ao seu repositório. Configuraremos .gitignore para garantir isso.

3. Adicione .env a .gitignore

Adicione a seguinte linha ao seu arquivo .gitignore para garantir que .env não seja enviado ao Git:

# .gitignore
.env

5. Forneça um arquivo .env.example

Para outros desenvolvedores trabalhando em seu projeto, inclua um arquivo .env.example como modelo:

# .env.example
API_KEY=your_api_key_here

Este arquivo não conterá dados confidenciais, mas fornece um exemplo das variáveis ​​necessárias para executar o projeto. Outros desenvolvedores podem copiar este arquivo para .env e adicionar suas próprias credenciais.

cp .env.example .env

? Erros comuns a evitar

• Chaves de API de codificação: Nunca codifique informações confidenciais diretamente em seu código Python.

# BAD EXAMPLE: Never do this
api_key = "hardcoded_api_key"

• Comprometendo arquivos .env : certifique-se de que .env esteja sempre incluído em .gitignore para evitar enviá-lo acidentalmente para o controle de versão.

• Empurrando ambientes virtuais: Sempre exclua ambientes virtuais (como venv) do Git:
  

# .gitignore
venv/

? Recursos:

• Manipulação segura de chaves de API no repositório GitHub
• 8 dicas para usar chaves de API com segurança