django-boss

Django-бос реалізація ідей, викладених у моєму блозі про команди управління Django. З його допомогою ви можете задати команди в окремих додатках, а потім запустити їх за допомогою djboss інтерфейс командного рядка.
<Сильний> Установка Django-бос
На даний момент, установка проводиться за допомогою easy_install Django-боса або пункт встановити Django-боса. Єдині передумови argparse, якого установка обробляється Setuptools і Джанго, який ви повинні встановлюватися в даний час так чи інакше.
<Сильний> Написання Команди
Команди визначаються як екземпляри djboss.commands.Command, присутніх в командах подмодуль всередині встановленою додатком. Наприклад, візьмемо таку структуру програми:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
Commands.py файл підмодуль, які можуть бути імпортовані в echoapp.commands.
<Сильний> З Декоратори
Нижче повний приклад правильного файлу commands.py:
від djboss.commands імпортувати *
command
Def привіт (аргументи):
& NBSP; "" "Версія для друку кліше до консолі." ""
& NBSP; друк "Hello World!"
Цей приклад іспользуетcommand декоратор заявити, що функція команди Django-бос. Ви можете додати аргументів команд теж; просто іспользоватьargument декоратор (переконайтеся, що вони приходять послеcommand):
command
argument ('- п', '--no-новий рядок', дія = "store_true",
& NBSP; допомога = "Не додавати символ кінця рядка.")
Def привіт (аргументи):
& NBSP; "" "Версія для друку кліше до консолі." ""
& NBSP; якщо args.no_newline:
і NBSP; імпорт SYS
& NBSP; sys.stdout.write ("Hello World!")
& NBSP; інше:
& NBSP; друк "Hello World!"
argument Декоратор приймає всі argparse.ArgumentParser.add_argument () робить; проконсультуватися argparse документи для отримання додаткової інформації.
Ви також можете коментувати команди, даючи аргументи ключових слів, чтобиcommand:
command (ім'я = "щось", опис = "чи що-небудь.")
Def do_something (аргументи):
& NBSP; "" ". Зробіть що-небудь" ""
& NBSP; друк "щось було зроблено."
У цьому випадку, команда буде називатися "щось", а не автоматично створене "зробити щось,", і його опис буде відрізнятися від його рядок документації. Для отримання більш детальної інформації про те, що може бути прийнятий тут, зверніться до argparse.ArgumentParser документи.
<Сильний> Без Декоратори
API дуже схожий, що не декораторів. Клас команда використовується, щоб обернути функції, і ви можете дати ключові аргументи при виклику какcommand:
Def відлуння (аргументи):
& NBSP; ...
відлуння = Команда (відлуння, ім'я = '...', опис = '...')
Додавання аргументів використовує метод Command.add_argument (), який знаходиться всього посилання на генерованого південь від аналізатора і Rsquo; s add_argument) метод (:
Def відлуння (аргументи):
& NBSP; ...
відлуння = Команда (відлуння, ім'я = '...', опис = '...')
echo.add_argument ('- п', '--no-новий рядок', ...)
echo.add_argument («слова», nargs = '*')
<Сильний> Запуск команд
Команди виконуються через djboss інтерфейс командного рядка. Для цього правильно, вам потрібно одне з двох:
* Змінна середовища DJANGO_SETTINGS_MODULE яка відноситься до дійсним, імпортованих модуля Python.
* Дійсно, імпортовані настройки модуля в поточному робочому каталозі.
Після того, як один з тих, покрита, ви можете запустити його:
djboss --help
Використання: djboss [-h] [-v] [-l LEVEL] Команда ...
Запуск команди управління Django-бос.
необов'язкові аргументи:
& NBSP; -h, --help показати цю довідку і вийти
& NBSP; -v, --version Номер версії шоу-програма та вихід
& NBSP; -l рівні, --log-Рівень
& NBSP; Виберіть рівень журналу DEBUG від, INFO, WARN (за замовчуванням)
& NBSP; або помилка.
команди:
& NBSP; КОМАНДА
& NBSP; відлуння Ехо аргументи назад в консоль.
& NBSP; привіт Роздрукувати кліше до консолі.
Щоб дізнатися суб-команд, djboss перші знахідки та імпорт налаштування Django.
Змінна оточення DJANGO_SETTINGS_MODULE має пріоритет, але якщо не вказано, djboss буде шукати `settings` модуля в поточному каталозі. Команди повинні бути визначені в `commands` подмодуль кожної програми. djboss буде шукати кожен з ваших INSTALLED_APPS для команд управління.
Кожен субкоманди отримує опції --help також:
djboss відлуння --help
використання: djboss відлуння [-h] [-n] [слова [слова ...]]
Ехо аргументи назад в консоль.
позиційні аргументи:
і NBSP; слова
необов'язкові аргументи:
& NBSP; -h, --help показати цю довідку і вийти
& NBSP; -n, --no-новий рядок не друкувати рядок після.
І тоді ви можете запустити його:
djboss відлуння кілька слів тут
деякі слова тут
Більше ж:
djboss привіт --help
Використання: djboss привіт [-h]
Роздрукувати кліше до консолі.
необов'язкові аргументи:
& NBSP; -h, --help показати цю довідку і вийти
І нарешті:
djboss привіт
Hello World!

Вимоги

• Джанго
• Python