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

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

Last synced: 8 days 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 (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T17:53:55.000Z (about 1 month ago)
• Last Synced: 2024-10-02T03:19:40.203Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 121 KB
• Stars: 249
• Watchers: 7
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• -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)
• starred-awesome - django-click - Write Django management command using the click CLI library (Python)

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/coveralls/GaretJax/django-click/master.svg

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

``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.

Release Notes and Contributors

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

* `Release Notes on GitHub `_

* `Our Wonderful Contributors `_

This package is a member of `Django Commons `_ and adheres to the community's `Code of Conduct `_. It is maintained by `Jonathan Stoppani `_ and `Timothy Allen `_, who have many professional responsibilities. We are thrilled that our employers allow us a certain amount of time to contribute to open-source projects. We add features as they are necessary for our projects, and try to keep up with Issues and Pull Requests as best we can. Due to constraints of time (our full time jobs!), Feature Requests without a Pull Request may not be implemented, but we are always open to new ideas and grateful for contributions and our users.