Skip to content

A django scaffolding tool to create high quality projects

License

Notifications You must be signed in to change notification settings

contraslash/django-bootstrapper

Repository files navigation

Django Bootstrapper

PyPI Build Status

This is a simple django project generator, it uses django default command and complete the schema generating a full application ready to use, including base, authentication, and template_base applications.

The main idea behind this projects is to automate some labors when we create projects.

Usage

First create a new environment

# For pip users
python -m venv my_custom_environment
# For conda users
conda create --name my_custom_environment

Now install django-bootstrapper

pip install django-bootstrapper

Now just execute django-bootstrapper.py and follow the rules

The project folder structure will be:

project_folder
├── applications
│   ├── authentication (Authentication app from https://github.com/contraslash/authentication-django)
│   ├── base_template (Base template from https://github.com/contraslash/template_cdn_bootstrap)
│   └── __init__.py
├── base (base from https://github.com/contraslash/base-django)
├── manage.py
└── project_name
    ├── __init__.py
    ├── settings.py
    ├── urls.py
    └── wsgi.py

The project is git submodule based, and creates submodules for authentication, base_template and base, all open source projects created by contraslash.

Also we recommend to use Django Crud Generator to create CRUD automatically.

Our main goal is to create a project with a structure that we can extend using templates and existing files.

If you want to modify and add to your tree any submodule, we recommend to follow this question

Test your changes

We want to include test on this suite so, to test your changes use

pytest

Compile locally

python setup.py sdist
python setup.py install

About

A django scaffolding tool to create high quality projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published