Skip to content

ackama/django-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

181 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Django Template Project

Expected Python Version: 3.12.x

Purpose

This project is intended as:

  • a kick-off point for projects
  • an evolving codebase which implements our best practices at the time
  • a place where we can document decisions that have been made about practices
    • e.g.: why X was picked, why Y was avoided (+ pros & cons)

Usage

To create a new project from this template, you can use Copier. The simplest way to run copier is with pipx or uvx:

pipx run copier copy path/to/django-template <project_folder>

or

uvx copier copy path/to/django-template <project_folder>

You can pull the template directly from Github:

uvx copier copy gh:ackama/django-template <project_folder>

This will ask you a series of questions to help you configure your project. The answer you provide to these questions will also be recorded in your new project in a file called .copier-answers.yml.y

Running the copier command will create a new project in the folder specified in with <project_folder>.

Note

Copier has an update mode which allows you to change your answers to the setup questions at a later date. Your current project must be under git control for this to work. It works pretty well but has not been tested here after lots of changes to the project have be made since the copy. So use caution.

Contributing

If you have ideas for improvements, open a PR with your idea or propose it in the guild channel

Feature branches are encouraged, and merging should on consensus from guild

About

A template for initiating new Django projects

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 7