diff --git a/.gitignore b/.gitignore index 68bc17f..b4ab01e 100644 --- a/.gitignore +++ b/.gitignore @@ -158,3 +158,5 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +**/.DS_Store \ No newline at end of file diff --git a/django_routines/__init__.py b/django_routines/__init__.py index 3d60f54..7c06826 100644 --- a/django_routines/__init__.py +++ b/django_routines/__init__.py @@ -21,7 +21,7 @@ from django.core.exceptions import ImproperlyConfigured from django.utils.functional import Promise -VERSION = (1, 0, 0) +VERSION = (1, 0, 1) __title__ = "Django Routines" __version__ = ".".join(str(i) for i in VERSION) diff --git a/doc/.DS_Store b/doc/.DS_Store deleted file mode 100644 index 272505e..0000000 Binary files a/doc/.DS_Store and /dev/null differ diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index d030232..5108997 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -2,6 +2,11 @@ Change Log ========== +v1.0.1 +====== + +* `Help example images dont have the correct usage line. `_ + v1.0.0 ====== diff --git a/doc/source/index.rst b/doc/source/index.rst index 1aa3d43..db9a1ee 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,7 +30,7 @@ The routine command will read our settings file and generate two subcommands, on and one called package: .. typer:: django_routines.management.commands.routine.Command:typer_app:package - :prog: ./manage.py routine + :prog: ./manage.py routine package :theme: dark :convert-png: latex @@ -47,7 +47,7 @@ Now we can run all of our package routines with one command: The deploy command has several switches that we can enable to run additional commands. .. typer:: django_routines.management.commands.routine.Command:typer_app:deploy - :prog: ./manage.py routine + :prog: ./manage.py routine deploy :theme: dark :convert-png: latex diff --git a/examples/deploy.svg b/examples/deploy.svg index 22fd303..7e3a4b8 100644 --- a/examples/deploy.svg +++ b/examples/deploy.svg @@ -19,143 +19,143 @@ font-weight: 700; } - .terminal-3312726252-matrix { + .terminal-3171235174-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-3312726252-title { + .terminal-3171235174-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-3312726252-r1 { fill: #c5c8c6;font-weight: bold } -.terminal-3312726252-r2 { fill: #c5c8c6 } -.terminal-3312726252-r3 { fill: #d0b344;font-weight: bold } -.terminal-3312726252-r4 { fill: #c5c8c6;text-decoration: underline; } -.terminal-3312726252-r5 { fill: #98a84b } -.terminal-3312726252-r6 { fill: #68a0b3 } -.terminal-3312726252-r7 { fill: #d0b344 } -.terminal-3312726252-r8 { fill: #868887 } -.terminal-3312726252-r9 { fill: #68a0b3;font-weight: bold } + .terminal-3171235174-r1 { fill: #c5c8c6;font-weight: bold } +.terminal-3171235174-r2 { fill: #c5c8c6 } +.terminal-3171235174-r3 { fill: #d0b344;font-weight: bold } +.terminal-3171235174-r4 { fill: #c5c8c6;text-decoration: underline; } +.terminal-3171235174-r5 { fill: #98a84b } +.terminal-3171235174-r6 { fill: #68a0b3 } +.terminal-3171235174-r7 { fill: #d0b344 } +.terminal-3171235174-r8 { fill: #868887 } +.terminal-3171235174-r9 { fill: #68a0b3;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - ./manage.py routine + ./manage.py routine deploy - + - - -Usage: ./manage.py routine [OPTIONS] COMMAND [ARGS]... - - -Deploy the site application into production. - - -[0] routine package | prepare -[0] migrate -[0] collectstatic -[0] shellcompletion install | initial -[0] loaddata ./fixtures/demo.json | demo - -╭─ Options ─────────────────────────────────────────────────────╮ -│--allInclude all switched commands.│ -│--demoLoad the demo data.│ -│--initialThings to do on the very first deployment │ -│on a new server.                          │ -│--prepareGenerate artifacts like migrations and    │ -│transpiled javascript.                    │ -│--helpShow this message and exit.│ -╰───────────────────────────────────────────────────────────────╯ -╭─ Commands ────────────────────────────────────────────────────╮ -│list List the commands that will be run.                   │ -╰───────────────────────────────────────────────────────────────╯ + + +Usage: ./manage.py routine deploy [OPTIONS] COMMAND [ARGS]... + + +Deploy the site application into production. + + +[0] routine package | prepare +[0] migrate +[0] collectstatic +[0] shellcompletion install | initial +[0] loaddata ./fixtures/demo.json | demo + +╭─ Options ─────────────────────────────────────────────────────╮ +│--allInclude all switched commands.│ +│--demoLoad the demo data.│ +│--initialThings to do on the very first deployment │ +│on a new server.                          │ +│--prepareGenerate artifacts like migrations and    │ +│transpiled javascript.                    │ +│--helpShow this message and exit.│ +╰───────────────────────────────────────────────────────────────╯ +╭─ Commands ────────────────────────────────────────────────────╮ +│list List the commands that will be run.                   │ +╰───────────────────────────────────────────────────────────────╯ diff --git a/examples/package.svg b/examples/package.svg index a6b4224..8a1586e 100644 --- a/examples/package.svg +++ b/examples/package.svg @@ -19,114 +19,114 @@ font-weight: 700; } - .terminal-1906384706-matrix { + .terminal-3022464026-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1906384706-title { + .terminal-3022464026-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1906384706-r1 { fill: #c5c8c6;font-weight: bold } -.terminal-1906384706-r2 { fill: #c5c8c6 } -.terminal-1906384706-r3 { fill: #d0b344;font-weight: bold } -.terminal-1906384706-r4 { fill: #c5c8c6;text-decoration: underline; } -.terminal-1906384706-r5 { fill: #98a84b } -.terminal-1906384706-r6 { fill: #68a0b3 } -.terminal-1906384706-r7 { fill: #868887 } -.terminal-1906384706-r8 { fill: #68a0b3;font-weight: bold } + .terminal-3022464026-r1 { fill: #c5c8c6;font-weight: bold } +.terminal-3022464026-r2 { fill: #c5c8c6 } +.terminal-3022464026-r3 { fill: #d0b344;font-weight: bold } +.terminal-3022464026-r4 { fill: #c5c8c6;text-decoration: underline; } +.terminal-3022464026-r5 { fill: #98a84b } +.terminal-3022464026-r6 { fill: #68a0b3 } +.terminal-3022464026-r7 { fill: #868887 } +.terminal-3022464026-r8 { fill: #68a0b3;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - ./manage.py routine + ./manage.py routine package - + - - -Usage: ./manage.py routine [OPTIONS] COMMAND [ARGS]... - - -Generate pre-package artifacts like migrations and transpiled  -javascript. - - -[0] makemigrations -[0] renderstatic - -╭─ Options ─────────────────────────────────────────────────────╮ -│--allInclude all switched commands.│ -│--helpShow this message and exit.│ -╰───────────────────────────────────────────────────────────────╯ -╭─ Commands ────────────────────────────────────────────────────╮ -│list List the commands that will be run.                   │ -╰───────────────────────────────────────────────────────────────╯ + + +Usage: ./manage.py routine package [OPTIONS] COMMAND [ARGS]... + + +Generate pre-package artifacts like migrations and transpiled  +javascript. + + +[0] makemigrations +[0] renderstatic + +╭─ Options ─────────────────────────────────────────────────────╮ +│--allInclude all switched commands.│ +│--helpShow this message and exit.│ +╰───────────────────────────────────────────────────────────────╯ +╭─ Commands ────────────────────────────────────────────────────╮ +│list List the commands that will be run.                   │ +╰───────────────────────────────────────────────────────────────╯ diff --git a/examples/readme_dict.py b/examples/readme_dict.py index 106eb3c..51f2c9f 100644 --- a/examples/readme_dict.py +++ b/examples/readme_dict.py @@ -19,8 +19,10 @@ "name": "deploy", "switch_helps": { "demo": "Load the demo data.", - "initial": "Things to do on the very first deployment on a new server.", - "prepare": "Generate artifacts like migrations and transpiled javascript.", + "initial": "Things to do on the very first deployment on a new " + "server.", + "prepare": "Generate artifacts like migrations and transpiled " + "javascript.", }, }, "package": { @@ -28,7 +30,8 @@ {"command": "makemigrations"}, {"command": "renderstatic"}, ], - "help_text": "Generate pre-package artifacts like migrations and transpiled javascript.", + "help_text": "Generate pre-package artifacts like migrations and " + "transpiled javascript.", "name": "package", }, } diff --git a/pyproject.toml b/pyproject.toml index ce5bf34..fab7127 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "django-routines" -version = "1.0.0" +version = "1.0.1" description = "Define named groups of management commands in Django settings files for batched execution." authors = ["Brian Kohan "] license = "MIT"