Skip to main content

Django-docopt-command allows you to write Django manage.py commands using the docopt library

Project description

Django-docopt-command allows you to write Django manage.py commands using the docopt library. This means that you can define commands using usage strings.

References:

class Command(DocOptCommand):
    # This usage string defines the command options:
    docs = "Usage: command <option1> <option2> [--flag1]"

    def handle_docopt(self, arguments):
        # arguments contains a dictionary with the options
        pass

Django-docopt-command is tested with Django 1.7-1.9 and Python 2.7, 3.3-3.5 and is hosted on github.

Example

See the testproject/docopt_example in the django-docopt-command github repository.

Usage

Install django-docopt-command.

pip install django-docopt-command

Step 1 - management command

Write a Django custom management command, as described in Writing custom django-admin commands.

Step 2 - inherit from DocOptCommand

class Command(DocOptCommand):
    pass

Step 3 - add a docs string

class Command(DocOptCommand):
    docs = "Usage: command <option1> <option2> [--flag1]"

Step 4 - override handle_docopt

class Command(DocOptCommand):
    docs = "Usage: command <option1> <option2> [--flag1]"

    def handle_docopt(self, arguments):
        option1 = arguments['option1']
        option2 = arguments['option2']

License

Django-docopt-command is licensed under the Apache 2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-docopt-command-0.2.2.tar.gz (1.9 kB view hashes)

Uploaded Source

Built Distributions

django_docopt_command-0.2.2-py2.7.egg (4.0 kB view hashes)

Uploaded Source

django_docopt_command-0.2.2-py2-none-any.whl (3.6 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page