Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2 KB

README.md

File metadata and controls

54 lines (40 loc) · 2 KB
Raw

logo
*Placeholder logo*

dj-beat-drop

dj-beat-drop is a CLI utility designed to simplify the creation of new Django projects by organizing all configuration files into a config directory, instead of using Django's default naming convention. This approach avoids the antipattern of naming the config directory the same as the project name.

logo

Project Status

This project is in the very early stages of development, focusing on defining the API. Future releases will include additional features and improvements.

Features

  • Simplified Project Structure: All configuration files are placed in a config directory.
  • Latest Django Version: Currently, the utility uses the latest release of Django.

Future Goals

  • Third-Party Templates: Add support for using a third-party template.
  • Polish: Add lots of polish inspired by laravel CLI.
  • Official Django Project: Aim to have this utility included as an official Django project, potentially renaming the command to django for easier usage (e.g., django new).
  • Tests: Add tests to ensure the utility works as expected.
  • Environment Variables: Add support for environment variables to configure the project.
  • LTS Version: Add an option so you can use the latest LTS version of Django instead of the latest release default.
  • pyproject.toml Integration: Set up new Django projects with a pyproject.toml file that can be used by uv to run the project.

Installation

pip install dj-beat-drop

Usage

# If you just installed dj-beat-drop, then reload your shell to make the command available.
beatdrop new example_project