دليل لإدارة مفاتيح واجهة برمجة التطبيقات ومتغيرات البيئة بشكل صحيح في مشاريع بايثون

؟ مقدمة

عند العمل مع واجهات برمجة التطبيقات في Python، غالبًا ما تحتاج إلى استخدام مفاتيح واجهة برمجة التطبيقات أو بيانات الاعتماد الحساسة الأخرى. من الضروري إدارة هذه المفاتيح بشكل آمن لتجنب تسرب المعلومات الحساسة أو وضعها عن طريق الخطأ في مستودع Git الخاص بك.

للحصول على عرض توضيحي كامل، تحقق من معالجة Secure-API-Key-Handling لمستودع GitHub الخاص بي، فهو يتميز بتطبيق دردشة Streamlit الذي يدير مفاتيح API بشكل آمن باستخدام ملفات .env وحزمة python-dotenv أثناء التفاعل مع نموذج Gemini Geneative AI. .

؟ ابدء

اتبع هذه الخطوات لإعداد مشروعك للتعامل الآمن مع مفتاح واجهة برمجة التطبيقات:

1. تثبيت التبعيات

ستحتاج إلى حزمة python-dotenv لتحميل متغيرات البيئة من ملف .env.

pip install python-dotenv

2. قم بإعداد ملف .env

قم بإنشاء ملف .env في جذر مشروعك، حيث ستقوم بتخزين مفتاح API والمتغيرات الأخرى الخاصة بالبيئة:

# .env
API_KEY=your_api_key_here

هام: لا ينبغي أبدًا الالتزام بملف .env هذا في مستودعك. سنقوم بتكوين .gitignore للتأكد من ذلك.

3. أضف .env إلى .gitignore

أضف السطر التالي إلى ملف .gitignore الخاص بك للتأكد من عدم دفع .env إلى Git:

# .gitignore
.env

5. قم بتوفير ملف .env.example

بالنسبة للمطورين الآخرين الذين يعملون في مشروعك، قم بتضمين ملف .env.example كقالب:

# .env.example
API_KEY=your_api_key_here

لن يحتوي هذا الملف على بيانات حساسة، ولكنه يعطي مثالاً للمتغيرات المطلوبة لتشغيل المشروع. يمكن للمطورين الآخرين نسخ هذا الملف إلى .env وإضافة بيانات الاعتماد الخاصة بهم.

cp .env.example .env

؟ الأخطاء الشائعة التي يجب تجنبها

• مفاتيح API ذات التشفير الثابت: لا تقم مطلقًا بترميز المعلومات الحساسة بشكل مباشر في كود Python الخاص بك.

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

• تشغيل ملفات .env : تأكد من تضمين .env دائمًا في .gitignore لتجنب دفعه عن طريق الخطأ إلى التحكم في الإصدار.

• دفع البيئات الافتراضية : استبعد دائمًا البيئات الافتراضية (مثل venv) من Git:
  

# .gitignore
venv/

؟ موارد:

• مستودع GitHub للتعامل الآمن مع مفاتيح واجهة برمجة التطبيقات
• 8 نصائح لاستخدام مفاتيح API بشكل آمن