Skip to main content

Build Django management commands using the click CLI package.

Project description

Project information:

https://img.shields.io/pypi/v/django-click.svg https://img.shields.io/pypi/dm/django-click.svg https://img.shields.io/badge/docs-TODO-lightgrey.svg https://img.shields.io/pypi/l/django-click.svg

Automated code metrics:

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

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/stable/

  • Compatible with Django 4.2, 5.2 and 6.0 running on Python 3.10, 3.11, 3.12, 3.13 and 3.14

    • 3.10+ required for Django 5.2 and above

    • 3.12+ required for Django 6.0 and above

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 <yourapp>/management/commands/helloworld.py:

import djclick as click

@click.command()
@click.argument('name')
def command(name):
    click.secho(f'Hello, {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

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.

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_click-2.5.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_click-2.5.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file django_click-2.5.0.tar.gz.

File metadata

  • Download URL: django_click-2.5.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.1

File hashes

Hashes for django_click-2.5.0.tar.gz
Algorithm Hash digest
SHA256 60d346a04d0db991d0bb31754c0dcad282643aa26a4701ca5ff5df742a7473f8
MD5 b53860f8c11c40a5ca0877b2af6ba327
BLAKE2b-256 fce980f860c3f2bb9bdcc58de6b9578bbc6b4a57bedefdc97211e736fb960380

See more details on using hashes here.

File details

Details for the file django_click-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: django_click-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.1

File hashes

Hashes for django_click-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6bcb71d0bac47f67b91d9ee1972d881d72b5bf20cd2a45a57265cdfac49b88aa
MD5 7c4b606bbd5e92fb14a986a23eacfc99
BLAKE2b-256 2743a8eedd594b0f1d5e736ad5afd48ff4431566d2760b79115af40d8b4e950a

See more details on using hashes here.

Supported by

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