django-spec-cli

Run a django-service-specs registry from manage.py: one subcommand per spec, an option for each of its parameters, a principal named on the command line, and an exit code for every refusal.

It is the kernel's management-command transport, moved out of the kernel with its history so the kernel carries no transport. The command line, the exit codes and the SpecCommand subclass contract are the ones the kernel shipped; the import path, the system check ids and the setting key are this package's.

Install

pip install django-spec-cli

Python 3.10 or later, Django 4.2 or later, and django-service-specs 0.10.0 or later, which it installs.

Quickstart

Subclass SpecCommand in one of your apps' management/commands/ modules and name a registry; the module's name is the command's:

# yourapp/management/commands/notes.py
from django_spec_cli import SpecCommand

from yourapp.specs import notes  # a django_service_specs.SpecRegistry


class Command(SpecCommand):
    registry = notes

$ python manage.py notes rename-note --as-user 1 --pk 1 --title Final --json
{"id":1,"title":"Final"}

The run goes through the kernel's dispatch, so the permission checks are enforced for the user --as-user names. --explain lists the specs that authorize nothing.

The system check

List "django_spec_cli" in INSTALLED_APPS and manage.py check reports every open spec a SpecCommand serves as django_spec_cli.W001, and a command that could not be loaded as django_spec_cli.W003. The command itself needs no app listed.

Until the kernel removes its own copy of the command, kernel 0.10.x still registers django_service_specs.W001 and W003 over its own SpecCommand. A project listing both "django_service_specs" and "django_spec_cli" sees both ids: each walk reports the commands subclassing its own class, and a command that cannot be loaded is reported by each. A project that moves its imports here and lists only "django_service_specs" gets no check for the moved commands, so list "django_spec_cli".

Documentation

https://artui.github.io/django-spec-cli/

License

MIT. See LICENSE.