https://github.com/mbraak/django-docopt-command

Django-docopt-command allows you to write Django manage.py commands using the docopt library
https://github.com/mbraak/django-docopt-command

django django-docopt-command docopt python

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mbraak/django-docopt-command
• Owner: mbraak
• License: other
• Created: 2013-09-30T17:43:53.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T05:26:14.000Z (8 months ago)
• Last Synced: 2024-11-14T16:54:10.631Z (2 months ago)
• Topics: django, django-docopt-command, docopt, python
• Language: Python
• Size: 179 KB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
# Django docopt command

[![Build Status](https://img.shields.io/travis/mbraak/django-docopt-command.svg?style=for-the-badge)](https://travis-ci.org/mbraak/django-docopt-command) [![Version](https://img.shields.io/pypi/v/django-docopt-command.svg?colorB=brightgreen&style=for-the-badge)](https://pypi.python.org/pypi/django-docopt-command/)

[![Coverage Status](https://img.shields.io/coveralls/mbraak/django-docopt-command.svg?style=for-the-badge)](https://coveralls.io/r/mbraak/django-docopt-command?branch=master) [![Requirements Status](https://img.shields.io/requires/github/mbraak/django-docopt-command.svg?style=for-the-badge)](https://requires.io/github/mbraak/django-docopt-command/requirements/?branch=master)

[![License](https://img.shields.io/pypi/l/django-docopt-command.svg?style=for-the-badge&colorB=brightgreen)](https://pypi.python.org/pypi/django-docopt-command/)

Django-docopt-command allows you to write [Django](https://www.djangoproject.com) [manage.py](https://docs.djangoproject.com/en/dev/howto/custom-management-commands/) commands using the [docopt](http://www.docopt.org) library. This means that you can define commands using usage strings.

References:

* [Django](https://www.djangoproject.com): The Web framework for perfectionists with deadlines

* [The docopt library](http://www.docopt.org): Command-line interface description language

* [Writing custom django-admin commands](https://docs.djangoproject.com/en/dev/howto/custom-management-commands/)

```python

class Command(DocOptCommand):

	# This usage string defines the command options:

	docs = "Usage: command   [--flag1]"

	def handle_docopt(self, arguments):

		# arguments contains a dictionary with the options

		pass

```

Django-docopt-command is tested with Django 2.2 - 3.1 and Python 3.5 - 3.8 and is hosted on [github](https://github.com/mbraak/django-docopt-command).

Note that version 1.0.0 also supports Django 2.1 and version 0.5.0 supports Django 1.11 and Django 2.0.

### 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](https://docs.djangoproject.com/en/dev/howto/custom-management-commands/).

**Step 2 - inherit from DocOptCommand**

```python

class Command(DocOptCommand):

	pass

```

**Step 3 - add a docs string**

```python

class Command(DocOptCommand):

	docs = "Usage: command   [--flag1]"

```

**Step 4 - override handle_docopt**

```python

class Command(DocOptCommand):

	docs = "Usage: command   [--flag1]"

	def handle_docopt(self, arguments):

		option1 = arguments['option1']

		option2 = arguments['option2']

```

## License

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