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

หมายเหตุ: หากคุณต้องการข้ามปลั๊กอิน/คำสั่งจากการค้นพบอัตโนมัติเพียงเปลี่ยนชื่อแพ็คเกจโดยการเตรียมหรือต่อท้ายจำนวนขีด จำกัด ( _ ) รหัสใด ๆ ที่อยู่ภายในแพ็คเกจจะถูกละเว้น

เอาชนะเทมเพลต

Flag --templates-dir สามารถใช้เพื่อกำหนดค่าเส้นทางเพิ่มเติมที่ CLI สามารถค้นหาเทมเพลตทรัพยากร หรือคุณสามารถใช้ตัวแปรสภาพแวดล้อม DJANGO_CLITE_TEMPLATES_DIR เพื่อจุดประสงค์เดียวกัน

ดูไดเรกทอรีไฟล์เทมเพลตสำหรับการอ้างอิงว่าไฟล์ใดที่สามารถเอาชนะได้ เส้นทางของเทมเพลตที่คุณต้องการแทนที่จำเป็นต้องตรงกับเทมเพลตที่ให้ไว้ ตัวอย่างเช่นหากคุณต้องการแทนที่เทมเพลตโมเดลซึ่งกำหนดไว้ภายใต้ src/cli/template_files/models/model.tpl คุณควรกำหนดเทมเพลตโมเดลของคุณเองภายใต้ไดเรกทอรีที่คุณต้องการเช่น /path/to/templates/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