https://github.com/GaretJax/django-click

Write Django management command using the click CLI library
https://github.com/GaretJax/django-click

Last synced: about 1 month ago
JSON representation

Write Django management command using the click CLI library

• Host: GitHub
• URL: https://github.com/GaretJax/django-click
• Owner: GaretJax
• License: mit
• Created: 2015-09-10T22:48:53.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-21T17:09:12.000Z (2 months ago)
• Last Synced: 2024-04-21T19:40:24.097Z (2 months ago)
• Language: Python
• Homepage:
• Size: 105 KB
• Stars: 237
• Watchers: 7
• Forks: 18
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Lists

• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• -awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• starred-awesome - django-click - Write Django management command using the click CLI library (Python)
• my-stars - GaretJax/django-click - Write Django management command using the click CLI library (Python)
• awesome-django - django-click - Write Django management commands using the click CLI library. (Third-Party Packages / Commands)
• awesome-django - django-click - Write Django management commands using the [click CLI library](https://click.palletsprojects.com). (Third-Party Packages / Commands)

README

        
============

Django Click

============

Project information:

.. image:: https://img.shields.io/pypi/v/django-click.svg

   :target: https://pypi.python.org/pypi/django-click

.. image:: https://img.shields.io/pypi/dm/django-click.svg

   :target: https://pypi.python.org/pypi/django-click

.. image:: https://img.shields.io/badge/docs-TODO-lightgrey.svg

   :target: http://django-click.readthedocs.org/en/latest/

.. image:: https://img.shields.io/pypi/l/django-click.svg

   :target: https://github.com/GaretJax/django-click/blob/master/LICENSE

Automated code metrics:

.. image:: https://img.shields.io/travis/GaretJax/django-click.svg

   :target: https://travis-ci.org/GaretJax/django-click

.. image:: https://img.shields.io/coveralls/GaretJax/django-click/master.svg

   :target: https://coveralls.io/r/GaretJax/django-click?branch=master

.. image:: https://img.shields.io/codeclimate/github/GaretJax/django-click.svg

   :target: https://codeclimate.com/github/GaretJax/django-click

``django-click`` is a library to easily write Django management commands using the

``click`` command line library.

* Free software: MIT license

* Documentation for the Click command line library: https://click.palletsprojects.com/en/8.0.x/

* Compatible with Django 4.2 and 5.0 running on Python 3.8, 3.9, 3.10, 3.11, and 3.12 (note: 3.10+ required for Django 5.0).

Installation

============

::

  pip install django-click

Example

=======

Create a command module as you would usually do, but instead of creating a

class, just put a ``djclick`` command into

``/management/commands/helloworld.py``:

.. code:: python

   import djclick as click

   @click.command()

   @click.argument('name')

   def command(name):

       click.secho('Hello, {}'.format(name), fg='red')

And then call the command with::

   $ ./manage.py helloworld django-click

   Hello, django-click

Check out the `test commands

`_

for additional example commands and advanced usage.