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 , вы должны определить свой собственный шаблон модели в соответствии с желаемым каталогом, то есть /path/to/templates/models/model.tpl templates/models/model.tpl.

Разработка

Установите из источника:

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

Зависимости

Проверьте pyproject.toml для всех зависимостей установки.

Интерактивные документы

Чтобы сохранить согласованность в нашей документации по всем различным командам и функциям CLI, мы решили перенести readme в серию ноутбуков Jupyter, которые вы можете изучить по команде в рамках каталога DOCS.

Делать

Проверьте наши открытые проблемы.

Получить запросы

Нашел ошибку? Видите опечатку? Есть идея для новой команды? Не стесняйтесь отправлять запрос на привлечение с вашими взносами. Они очень желанные и ценится.

ЛИЦЕНЗИЯ

Django-Clite лицензирован BSD.