Una guía para administrar correctamente las claves API y las variables de entorno en proyectos Python

? Introducción

Cuando trabajas con API en Python, a menudo necesitas usar claves de API u otras credenciales confidenciales. Es crucial administrar estas claves de forma segura para evitar filtrar información confidencial o enviarlas accidentalmente a su repositorio de Git.

Para una demostración completa, consulte mi repositorio de GitHub Secure-API-Key-Handling. Cuenta con una aplicación de chat Streamlit que administra de forma segura las claves API utilizando archivos .env y el paquete python-dotenv mientras interactúa con el modelo Gemini Generative AI. .

? Empezando

Siga estos pasos para configurar su proyecto para el manejo seguro de claves API:

1. Instalar dependencias

Necesitarás el paquete python-dotenv para cargar variables de entorno desde un archivo .env.

pip install python-dotenv

2. Configurar un archivo .env

Cree un archivo .env en la raíz de su proyecto, donde almacenará su clave API y otras variables específicas del entorno:

# .env
API_KEY=your_api_key_here

Importante: Este archivo .env nunca debe enviarse a su repositorio. Configuraremos .gitignore para garantizarlo.

3. Agregue .env a .gitignore

Agregue la siguiente línea a su archivo .gitignore para asegurarse de que .env no se envíe a Git:

# .gitignore
.env

5. Proporcione un archivo .env.example

Para otros desarrolladores que trabajan en su proyecto, incluya un archivo .env.example como plantilla:

# .env.example
API_KEY=your_api_key_here

Este archivo no contendrá datos confidenciales, pero proporciona un ejemplo de las variables necesarias para ejecutar el proyecto. Otros desarrolladores pueden copiar este archivo a .env y agregar sus propias credenciales.

cp .env.example .env

? Errores comunes que se deben evitar

• Claves API de codificación: nunca codifique información confidencial directamente en su código Python.

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

• Confirmar archivos .env: asegúrese de que .env esté siempre incluido en .gitignore para evitar enviarlo accidentalmente al control de versiones.

• Impulsar entornos virtuales: excluye siempre los entornos virtuales (como venv) de Git:
  

# .gitignore
venv/

? Recursos:

• Repositorio GitHub de manejo seguro de claves API
• 8 consejos para utilizar claves API de forma segura