Skip to content

iyashar/GitHub_API_Wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 GitHub API Wrapper

یک API بسیط و قدرتمند ساخته شده با FastAPI برای تعامل با GitHub API که دسترسی آسان به اطلاعات کاربران، ریپازیتوری‌ها و جستجو را فراهم می‌کند.

FastAPI Python GitHub API License

✨ ویژگی‌ها

  • 🎯 دسترسی آسان به GitHub API
  • سریع و کارآمد با FastAPI
  • 📚 مستندات خودکار با Swagger UI
  • 🎨 ظاهر زیبا و ریسپانسیو
  • 🔒 مدیریت خطاهای پیشرفته
  • 📊 پشتیبانی از rate limiting
  • 🔍 جستجوی پیشرفته ریپازیتوری‌ها

🛠️ نصب و راه‌اندازی

پیش‌نیازها

  • Python 3.7+
  • pip

مرحله ۱: کلون کردن ریپازیتوری

git clone https://github.com/your-username/github-api-wrapper.git
cd github-api-wrapper

مرحله 2: نصب نیازمندی ها

pip install -r requirements.txt

مرحله 3: اجرای برنامه

# روش ۱: مستقیم
python github_api.py

# روش ۲: با uvicorn (بهترین روش)
uvicorn github_api:app --reload --host 0.0.0.0 --port 8000

# روش ۳: با فایل اجرایی
python run.py

مرحله ۴: بررسی اجرای برنامه

بروید به: http://localhost:8000

مرحله 5: 🧪 تست کردن

# تست خودکار
python test_api.py

تست دستی

curl http://localhost:8000/health
curl http://localhost:8000/api/user/octocat

🐛 عیب‌یابی

مشکل: {"detail":"Not Found"}

مطمئن شوید سرور در حال اجراست آدرس endpoint را بررسی کنید

مشکل: اتصال به GitHub

اتصال اینترنت را بررسی کنید می توانید GitHub Token را تنظیم کنید

🤝 مشارکت

ریپازیتوری را fork کنید یک branch جدید ایجاد کنید تغییرات را commit کنید نهایتا Pull Request ایجاد کنید

📄 لایسنس

این پروژه تحت لایسنس MIT منتشر شده است.

About

Github API wrapper

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages