Proteger as Chaves de API em uma aplicação Python

Explicando o Problema

Em diversas aplicações, precisamos utilizar chaves de acesso a serviços de API. Essas chaves são privadas e não devem ser expostas ao público, pois, caso caiam em mãos erradas, podem causar prejuízos financeiros, vazamento de dados ou até bloqueio dos serviços.

No desenvolvimento de aplicações localmente, esse risco é menor. Porém, quando utilizamos plataformas de versionamento de código, como o GitHub, é fundamental garantir que essas chaves não sejam enviadas para o repositório público ou compartilhado.

Como Proteger as Chaves Utilizando o Arquivo config.py

Uma forma simples e prática de proteger as chaves de API é utilizando um arquivo config.py para armazenar essas informações sensíveis. Esse arquivo não deve ser versionado, evitando que as chaves sejam expostas no repositório remoto.

Exemplo de config.py

	 
api_key = "SUA_KEY" base_url = "SUA_URL_BASE" 

Utilizando as Variáveis na Aplicação

Para utilizar essas variáveis dentro da sua aplicação, basta realizar a importação do módulo config e acessar as variáveis conforme o exemplo abaixo:

	 
import config 

client = OpenAI(api_key=config.api_key, base_url=config.base_url) 

Configurando o Arquivo .gitignore

Para garantir que o arquivo config.py não seja enviado ao repositório, é necessário adicioná-lo ao arquivo .gitignore. Dessa forma, o Git irá ignorá-lo durante os commits.

	 
# Configurações locais 
config.py 

⚠️ Atenção: Essa abordagem é válida para ambientes locais, testes ou pequenos projetos. Para aplicações em produção, ambientes colaborativos ou que envolvam múltiplos desenvolvedores, o mais recomendado é utilizar variáveis de ambiente ou gerenciadores de segredos.

Conclusão

Manter as chaves de API seguras é uma prática essencial no desenvolvimento de software. Utilizar um arquivo config.py ignorado pelo .gitignore é uma solução prática.