django clite

Django-clite

أداة CLI تعالج إنشاء وإدارة مشاريع Django

• Django-clite
  • تثبيت
    • تمديد CLI
  • التبعيات
  • مستندات تفاعلية
  • للقيام
  • طلبات سحب
  • رخصة

تثبيت

التثبيت عبر PIP:

pip install django-clite

بعد التثبيت ، سوف يعرض CLI الثنائي مع الاسم:

 django-clite

تمديد CLI

حاليًا ، هناك طريقتان رئيسيتان لتوسيع وظائف CLI:

1. إضافة الأوامر/الإضافات الخاصة بك
2. تجاوز قوالب الموارد المقدمة

بما في ذلك الأوامر الخاصة بك

إذا كنت ترغب في تمديد وظيفة CLI هذا ، فيمكنك تضمين plugins/commands الخاصة بك عن طريق تعيين متغير البيئة: DJANGO_CLITE_PLUGINS . ما عليك سوى تعيين هذا المتغير على المسار الذي توجد فيه الإضافات الخاصة بك.

يتم اكتشاف أوامر البرنامج المساعد تلقائيًا إذا تم وضعها ضمن دليل الإضافات ، ولكن يرجى التأكد من القيام بما يلي حتى يعمل:

1. اسم الحزمة الخاصة بك وانقر فوق الأمر نفسه . وهذا هو ، حزمة تسمى get ، على سبيل المثال ، يجب أن تحدد الأمر get .
2. ضع تعريف الأمر ضمن وحدة الحزمة main.py . على سبيل المثال:

 # get/main.py
import click


@ click . command ()
@ click . pass_context
def get ( ctx ):
    pass

3. يجب إضافة التوزيع الفرعي إلى مجموعة الأوامر الأعلى في وحدة main.py الخاصة بالحزمة.

 # get/main.py
import click


@ click . group () # <- group
@ click . pass_context
def get ( ctx ):
  pass


@ click . command ()
@ click . pass_context
def foo ( ctx ):
  pass


get . add_command ( foo )

4. الوصول إلى الأوامر الخاصة بك عبر مجموعة الأوامر الخاصة بك.

 django-clite get foo

ملاحظة: إذا كنت ترغب في تخطي مكون إضافي/أمر من أن يتم اكتشافه تلقائيًا ، فما عليك سوى إعادة تسمية الحزمة إما عن طريق إعداد أو إلحاق أي عدد من العروض السفلية ( _ ). سيتم تجاهل أي رمز موجود داخل الحزمة.

تجاوز القوالب

يمكن استخدام العلم- --templates-dir لتكوين مسار إضافي حيث يمكن لـ CLI البحث عن قوالب الموارد. بدلاً من ذلك ، يمكنك استخدام متغير البيئة DJANGO_CLITE_TEMPLATES_DIR لنفس الغرض.

ألقِ نظرة على دليل ملفات القالب للحصول على مرجع للملفات التي يمكن تجاوزها. تحتاج مسارات القوالب التي ترغب في تجاوزها إلى مطابقة القالب المقدم. على سبيل المثال ، إذا كنت ترغب في تجاوز قالب النموذج ، الذي يتم تعريفه بموجب src/cli/template_files/models/model.tpl ، فيجب عليك تحديد قالب النموذج الخاص بك ضمن الدليل المطلوب ، IE /path/to/templates/models/model.tpl PATTPH/TO/TEMPHING/TEMPHITES/MODELS/MODEL.TPL.

تطوير

التثبيت من المصدر:

 git clone https://github.com/oleoneto/django-clite.git
cd django-clite
pip install --editable .

التبعيات

تحقق من pyproject.toml لجميع تبعيات التثبيت.

مستندات تفاعلية

من أجل الحفاظ على الاتساق في وثائقنا لجميع الأوامر والميزات المختلفة لـ CLI ، قررنا نقل README إلى سلسلة من أجهزة الكمبيوتر المحمولة Jupyter التي يمكنك استكشافها لكل أمر تحت دليل المستندات.

للقيام

تحقق من قضايانا المفتوحة.

طلبات سحب

وجدت خطأ؟ انظر خطأ مطبعي؟ هل لديك فكرة عن أمر جديد؟ لا تتردد في تقديم طلب سحب مع مساهماتك. انهم موضع ترحيب كبير وتقدير.

رخصة

Django-clite هو BSD مرخص.