https://github.com/epicserve/dj-beat-drop

A CLI for creating new Django projects
https://github.com/epicserve/dj-beat-drop

Last synced: 3 months ago
JSON representation

A CLI for creating new Django projects

• Host: GitHub
• URL: https://github.com/epicserve/dj-beat-drop
• Owner: epicserve
• License: gpl-3.0
• Created: 2024-10-12T17:52:43.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-19T22:05:27.000Z (3 months ago)
• Last Synced: 2024-10-20T06:31:04.725Z (3 months ago)
• Language: Python
• Size: 283 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - epicserve/dj-beat-drop - A CLI for creating new Django projects (Python)

README

        



  


    


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



  


    

  



## 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

```sh

pip install dj-beat-drop

```

## Usage

```sh

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

beatdrop new example_project

```