https://github.com/contraslash/django-bootstrapper
A django scaffolding tool to create high quality projects
https://github.com/contraslash/django-bootstrapper
Last synced: 2 months ago
JSON representation
A django scaffolding tool to create high quality projects
- Host: GitHub
- URL: https://github.com/contraslash/django-bootstrapper
- Owner: contraslash
- License: mit
- Created: 2018-09-29T19:37:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T17:56:17.000Z (about 5 years ago)
- Last Synced: 2025-10-27T11:15:24.436Z (8 months ago)
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Bootstrapper
[](https://pypi.org/project/django-bootstrapper)
[](https://travis-ci.org/contraslash/django-bootstrapper)
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
```bash
# For pip users
python -m venv my_custom_environment
# For conda users
conda create --name my_custom_environment
```
Now install django-bootstrapper
```bash
pip install django-bootstrapper
```
Now just execute `django-bootstrapper.py` and follow the rules
The project folder structure will be:
```text
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](https://django-crud-generator.readthedocs.io/en/latest/) 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](https://stackoverflow.com/questions/1260748/how-do-i-remove-a-submodule)
## Test your changes
We want to include test on this suite so, to test your changes use
```bash
pytest
```
## Compile locally
```bash
python setup.py sdist
python setup.py install
```