dj-command 0.3.0

Run Django management commands with a simple `dj {command_name}`. Can also use aliases for commands defined in a simple config file.

Why?

It is available everywhere if you install via pip, has cute aliases defined in a JSON file (.dj-config.json) per project, will run as many commands as you want, and defaults to Django management commands if an alias cannot be found.

Note that calling a long-running processes (e.g. runserver) will prevent any other commands from being run.

Example .dj-config.json

{
	"commands": [
		{
			"name": "m",
			"help": "Does the migration dance",
			"execute": "./manage.py makemigrations && ./manage.py migrate",
		},
		{
			"name": "r",
			"help": "Runserver",
			"execute": "./manage.py runserver",
			"long_running": true
		}
	]
}

Basic arguments and options

• dj --help to see all of the options
• dj --list to see all of the available custom commands
• dj {command_name} to run a custom command or Django management command (e.g. dj migrate)
• dj {command_name} --dry_run to show what commands would run without actually executing them

How to work on the source

1. Clone the repo
2. Run the source locally: poetry run python dj
3. Test the source: poetry run pytest
4. Build and install locally: poetry build && pip3 install --user --upgrade --force-reinstall dist/dj_command-0.1.0-py3-none-any.whl
5. Test with ~/.local/bin/dj migrate
6. Publish the source to pypi: poetry publish --build --username USERNAME --password PASSWORD

Acknowledgements

• poetry: please, please, please continue to wrangle the complexity of 1) creating Python projects, and 2) installing dependencies; seriously, it's baffling out there without you
• click: ridiculously full-featured library to help implement CLI programs in Python; it has all the bells and most of the whistles
• attrs: would you like easy classes in Python? yes, please
• delegator.py: dealing with subprocess is a pain, but delegator hides all the ugly cruft behind a nice API

Prior art

This isn't a new idea and there are a few other implementations out there that do similar things. But, uh, I like mine. 😀

• dj-cmd
• Django-dj
• dj-cli