Skip to main content

A CLI tool for Django development

Project description

djazz-cli

djazz-cli is a Django command-line tool that extends and enhances Django's built-in management commands. It provides a simpler, more intuitive interface through the dj command.

Features

  • Simplified project creation with template support
  • Enhanced app creation with better defaults
  • Shorter, more intuitive command syntax
  • Helpful next-step guidance after commands
  • Default templates with common configurations

Installation

Install using pip:

pip install djazz-cli

Usage

Creating a New Project

# Basic project creation (in current directory)
dj startproject myproject

# Create project with a specific template
dj startproject myproject template_name

# Create project in a specific directory
dj startproject myproject template_name path/to/directory

Creating a New App

# Basic app creation
dj startapp myapp

# Create app with a specific template
dj startapp myapp template_name

# Create app in a specific directory
dj startapp myapp template_name path/to/directory

Motivation

The django-admin CLI is a powerful tool for managing Django projects, but it has some limitations:

  1. The default app template lacks common files like urls.py
  2. Project creation always creates a nested directory structure
  3. Template usage requires verbose command-line options

djazz-cli addresses these issues by:

  • Providing better default templates
  • Simplifying the command interface
  • Creating projects in the current directory by default
  • Making template usage more straightforward

Templates

Project Templates

  • default: Enhanced version of Django's default project template

App Templates

  • default: Extended app template with additional files (urls.py, etc.)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

djazz_cli-0.1.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

djazz_cli-0.1.0-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file djazz_cli-0.1.0.tar.gz.

File metadata

  • Download URL: djazz_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for djazz_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7dcbc83896dfe79b8884c1ba053e956d8561c5ee5abc6926f5deb1f717512563
MD5 47766860dec191e9dcaa0218abfa202b
BLAKE2b-256 1c6a6646c660567d172f3f949467dcd3f95f3821fad60faed48fdf6f5d4e0fc7

See more details on using hashes here.

File details

Details for the file djazz_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: djazz_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for djazz_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c4617c83cb1ab4ec0d786a0af90d9f28018a82b9f04777c649800bbc857d373
MD5 5b22c0426abd7d4095e60b92c8adfbd3
BLAKE2b-256 6df29a0f388b822bd60c77a08ea22e9be860cc8c8bce44aff91e92eadc37a9e2

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