روش تعیین مخزن GitHub در requirement.txt

معرفی

در پایتون requirements.txt فایل به مدیریت وابستگی ها کمک می کند. این یک فایل متنی ساده است که بسته هایی را لیست می کند که پروژه پایتون شما به آنها وابسته است. اما آیا می دانستید که می توانید یک مخزن مستقیم GitHub را نیز به عنوان منبع در خود مشخص کنید requirements.txt? در این بایت، چگونگی و چرایی انجام این کار را بررسی خواهیم کرد.

چرا یک مخزن مستقیم GitHub مشخص کنید؟

چند دلیل وجود دارد که ممکن است بخواهید یک مخزن مستقیم GitHub را در خود مشخص کنید requirements.txt فایل. شاید بسته مورد نیاز شما در PyPI در دسترس نباشد، یا شاید شما نیاز به نسخه خاصی از بسته ای داشته باشید که فقط در GitHub در دسترس باشد (به هر حال، در برخی از بسته های قدیمی تر، به روز رسانی ها همیشه در PyPI منتشر نمی شوند). یا، ممکن است در یک پروژه همکاری داشته باشید و بخواهید از جدیدترین تغییراتی که هنوز در PyPI اعمال نشده است استفاده کنید.

به عنوان مثال، چند بار بوده است که من به یک ویژگی از یک کتابخانه پایتون نیاز داشتم که فقط در شاخه توسعه در GitHub در دسترس بود. با مشخص کردن مخزن مستقیم GitHub در ما requirements.txt، ما توانستیم از این ویژگی قبل از انتشار رسمی استفاده کنیم.

و در آخر، می توانید از URL های مستقیم به عنوان راهی برای استفاده از مخازن خصوصی از GitHub استفاده کنید.

روش استفاده از منبع مستقیم GitHub در requirement.txt

برای تعیین مخزن مستقیم GitHub در خود requirements.txt، باید از فرمت زیر استفاده کنید:

git+https://github.com/username/repo.git

فرض کنید می خواهیم آخرین کد را از روی نصب کنیم requests کتابخانه مستقیماً از GitHub. ما خط زیر را به ما اضافه می کنیم requirements.txt:

git+https://github.com/psf/requests.git

سپس، می‌توانیم وابستگی‌ها را از ما نصب کنیم requirements.txt مثل همیشه:

$ pip install -r requirements.txt

آن را خواهید دید pip کلون می کند requests repo و آن را نصب می کند.

تغییرات URL Repo

بسته به نیازتان، چند تغییر از URL repo وجود دارد که می توانید از آنها استفاده کنید.

اگر می خواهید نصب کنید شاخه خاص، استفاده کنید @ نماد به دنبال نام شعبه:

git+https://github.com/username/repo.git@branch-name

برای نصب a تعهد خاص، استفاده کنید @ نماد به دنبال هش commit:

git+https://github.com/username/repo.git@commit-hash

و البته، یکی دیگر از نسخه های رایج برای مخازن خصوصی است. برای آن ها، می توانید از یک نشانه دسترسی استفاده کنید:

git+https://<token>@github.com/username/repo.git

نتیجه

توانایی تعیین یک منبع مستقیم GitHub در خود requirements.txt به شما انعطاف بیشتری در مدیریت وابستگی های پروژه پایتون می دهد. چه به نسخه خاصی از یک بسته نیاز داشته باشید، چه بخواهید از قابلیتی استفاده کنید که هنوز به طور رسمی منتشر نشده است یا در حال کار با مخازن خصوصی هستید، این تکنیک می تواند ابزار بسیار مفیدی در گردش کار توسعه شما باشد.