django-shortcut 0.1.3

A CLI tool to bootstrap a production-ready Django REST Framework project in seconds.

Django Shortcut

A command-line tool for bootstrapping a production-ready Django REST Framework project.

Features

• Creates a Python virtual environment
• Installs Django and Django REST Framework
• Configures JWT Authentication
• Creates a .env file
• Configures CORS, Static, and Media settings
• Runs initial database migrations
• Initializes a Git repository
• Generates a requirements.txt file

Requirements

• Python 3.8+
• Git (optional, for repository initialization)

Installation

Install from PyPI:

pip install django-shortcut

Verify the installation:

dj-shortcuts --help

Usage

Create a new project:

dj-shortcuts <project_name>

Example:

dj-shortcuts ecommerce_api

Create a project in a custom directory:

dj-shortcuts ecommerce_api --target C:\Projects

or

dj-shortcuts ecommerce_api -t C:\Projects

Alternative Usage

If the CLI command is unavailable (for example, if your Python Scripts directory is not in your system PATH), run the module directly:

python -m django_shortcuts.cli <project_name>

Example:

python -m django_shortcuts.cli ecommerce_api

Generated Project

The generated project includes:

• Python virtual environment
• Django project structure
• Django REST Framework
• JWT Authentication
• CORS configuration
• Environment variable support
• Static and Media configuration
• Git repository
• requirements.txt

After Project Creation

Navigate to the project directory:

cd ecommerce_api

Activate the virtual environment.

Windows

venv\Scripts\activate

Linux/macOS

source venv/bin/activate

Start the development server:

python manage.py runserver

Visit:

http://127.0.0.1:8000/

Admin panel:

http://127.0.0.1:8000/admin/

Updating

Upgrade to the latest version:

pip install --upgrade django-shortcut

Troubleshooting

Command not found

If you receive:

'dj-shortcuts' is not recognized as an internal or external command

Run the CLI directly:

python -m django_shortcuts.cli <project_name>

Alternatively, add your Python Scripts directory to your system PATH.

Repository

GitHub:

https://github.com/ihmnoyon/django-shortcut

License

Released under the MIT License.

Author

Mahedi Hasan Noyon

• GitHub: https://github.com/imhnoyon/
• Portfolio: https://mahed.pythonanywhere.com/
• Email: [e-mail]