django clite

Django-Clite

Alat CLI yang menangani menciptakan dan mengelola proyek Django

• Django-Clite
  • Instalasi
    • Memperluas CLI
  • Dependensi
  • Dokumen interaktif
  • Untuk melakukan
  • Tarik permintaan
  • LISENSI

Instalasi

Instal via PIP:

pip install django-clite

Setelah instalasi, CLI akan mengekspos biner dengan namanya:

 django-clite

Memperluas CLI

Saat ini, ada dua cara utama untuk memperluas fungsionalitas CLI:

1. Menambahkan perintah/plugin Anda sendiri
2. Mengesampingkan templat sumber daya yang disediakan

Termasuk perintah Anda sendiri

Jika Anda ingin memperluas fungsionalitas CLI ini, Anda dapat menyertakan plugins/commands Anda sendiri dengan mengatur variabel lingkungan: DJANGO_CLITE_PLUGINS . Cukup atur variabel ini ke jalur di mana plugin Anda berada.

Perintah plugin ditemukan secara otomatis jika ditempatkan di bawah direktori plugin, tetapi pastikan untuk melakukan hal berikut agar ini berfungsi:

1. Beri nama paket Anda dan klik perintah yang sama . Artinya, paket yang disebut get , misalnya, harus menentukan perintah get .
2. Tempatkan definisi perintah dalam modul main.py paket . Misalnya:

 # get/main.py
import click


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

3. Sub-perintah harus ditambahkan ke grup perintah paling atas dalam modul main.py paket.

 # 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. Akses perintah Anda melalui grup perintah terbanyak Anda.

 django-clite get foo

Catatan: Jika Anda ingin melewatkan plugin/perintah agar tidak ditemukan secara otomatis, cukup ganti nama paket dengan prepending atau menambahkan sejumlah garis bawah ( _ ). Kode apa pun yang terkandung dalam paket akan diabaikan.

Mengesampingkan template

Bendera --templates-dir dapat digunakan untuk mengkonfigurasi jalur tambahan di mana CLI dapat mencari templat sumber daya. Atau, Anda dapat menggunakan variabel lingkungan DJANGO_CLITE_TEMPLATES_DIR untuk tujuan yang sama.

Lihatlah direktori file template untuk referensi file apa yang bisa ditimpa. Jalur templat yang ingin Anda unggulkan perlu mencocokkan template yang disediakan. Misalnya, jika Anda ingin mengganti templat model, yang didefinisikan di bawah src/cli/template_files/models/model.tpl , Anda harus mendefinisikan templat model Anda sendiri di bawah direktori yang Anda inginkan, yaitu /path/to/templates/models/model.tpl .

Perkembangan

Instal dari Sumber:

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

Dependensi

Lihat PyProject.toml untuk semua dependensi instalasi.

Dokumen interaktif

Untuk mempertahankan konsistensi dalam dokumentasi kami tentang semua perintah dan fitur yang berbeda dari CLI, kami telah memutuskan untuk memindahkan ReadMe ke serangkaian buku catatan Jupyter yang dapat Anda jelajahi per perintah di bawah direktori Docs.

Untuk melakukan

Lihatlah masalah terbuka kami.

Tarik permintaan

Menemukan bug? Melihat kesalahan ketik? Punya ide untuk perintah baru? Jangan ragu untuk mengirimkan permintaan tarik dengan kontribusi Anda. Mereka sangat disambut dan dihargai.

LISENSI

Django-Clite berlisensi BSD.