It takes time to start a Django Project and make it almost production-ready.

Last update: Jan 01, 2022

Related tags

Overview

django-setup-cli

Django Setup Cli

It takes time to start a Django Project and make it almost production ready. A developer needs to spend a lot of time installing required libraries, setup database, setup cache as well as hiding secrets, configure settings file. With the help of django-setup-cli a developer can start an almost production ready project in a minute.

Requirements

python 3.6>

Installation

1. Create a virtual environment and activate

windows

 pip install virtualenv
 virtualenv venv
 <YOUR WORKING DIRECTORY>/venv/scripts/activate

Your Current Working Directory

Ubuntu [Debian]

sudo apt-get install python3-pip
sudo pip3 install virtualenv 
virtualenv venv 
source venv/bin/activate

you can use any name instead of venv

2. Install django-setup-cli

pip3 install django-setup-cli

Usages

How to use

Usage: django-cli [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  generate      Generates YAML File
  startproject  Starts Django Project

1. `startproject`

Option 1:

Similar to django-admin startproject

If there's no valid setup.yaml file in your working directory django-cli will take some input to start the project

To Start a project use the following command in the shell

django-cli startproject PROJECT_NAME

Note: PROJECT_NAME is optional

>> django-cli startproject ProjectName[Optional]

1. Project Name
Your Project Name: T

2. Install Necessary Libraries
Install Libraries [y/N]: y

1.Install djangorestframework [y/N]: y
2.Install graphene-django [y/N]: y
3.Install django-channels [y/N]: y
4.Install django-localflavor [y/N]: y
5.Install celery [y/N]: y
6.Install whitenoise [y/N]: y
7.Install django-filter [y/N]: y
8.Install django-extensions [y/N]: y
9.Install django-storages [y/N]: y

3. Static File
Create/Use Static File [y/N]: y

4. Template File
Create/Use Template File [y/N]: y

5. Media File
Create/Use Media File [y/N]: y

6. Setup Database
Setup Database [Skip To Use Default] [y/N]: y
1. postgresql
2. mysql
3. maria_db
4. oracle
5. mssql
6. sqlite3
7. django_cockroachdb

Database Engine: 1
Database Name: DATABASE_NAME
Database User: USER
Database Password: PASSWORD
Database Host: localhost
Database Port: 5432

7. Setup Cache
Install Cache [y/N]: y

1. pymemcache
2. redis
3. DatabaseCache
4. FileBasedCache
5. LocMemCache

Cache Engine: 2
Cache Location: LOCATION

After Providing required Information Your Project will be created and you will see following output

1. Installing Required Libraries
installing django
...
...
2. Creating Source Directory
..
3. Creating Project File

Project Setup Complete

Your working directory will have the following files and folders

project
│   README.md
│   .gitignore    
│   .env       [Django Secrets]
|   setup.yaml [django-cli YAML Setup Config File]  
└───src
   │   manage.py
   │   
   └───PROJECT_NAME
       │   asgi.py
       │   config.py
       │   settings.py   
       |   wsgi.py
       |   urls.py

Note: Do not delete .env file, it will contain database, cache and django secret keys

Option 2:

1. Create a `setup.yaml` file

name: TEST_PROJECT
libraries:
- django-rest-framework
- celery
- django-storages
template: true
static: true
media: false
database:
  engine: postgresql
  user: user
  password: password
  host: host
  port: port
  option: 
    config: psql.cfg
cache:
  backend: redis
  location: localhost:6532
env:
  SECRET_KEY: YOUR_SECRET_KEY

2. Run `django-cli startproject` in terminal/shell

django-cli startproject
# Your Project Will be created automatically using the setup.yaml file

Use Environment Variable in `setup.yaml`

It is possible to use secrets I.E [Database Password, Username, Secret Key] using environment variable

To Hide Secrets Using environment variable create a cli.env file in the source directory And do the following

cli.env

MY_SECRET_KEY=
   
    
DATABASE_USER=django_cli
DATABASE_PASSWORD=gonnaCry?

setup.yaml

To use env secret Put $ before your env variable I.E $SECRET_KEY

name: TEST_PROJECT
libraries:
- django-rest-framework
- celery
- django-storages
template: true
static: true
media: false
database:
  engine: postgresql
  user: $DATABASE_USER
  password: $DATABASE_PASSWORD
  host: host
  port: port
  option: 
    config: psql.cfg
cache:
  backend: redis
  location: localhost:6532
env:
  SECRET_KEY: $MY_SECRET_KEY

You can target a different env file using --env django-cli startproject NewProject --env spider.env

2. `generate`

django-cli generate PROJECT_NAME --env cli.env

Will generate setup.yaml file, it will not create project PROJECT_NAME and --env are optional fields

3. `install`

django-cli install

Will install required libraries also install libraries that are inside requirements.txt file

@Creator and Maintainer

Khan Asfi Reza

pytest-django allows you to test your Django project/applications with the pytest testing tool.

1.1k Dec 14, 2022

django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project. Inspired in the dashboard framework Dashing

django-dashing django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project.

703 Dec 22, 2022

Intellicards-backend - A Django project bootstrapped with django-admin startproject mysite

2 Jan 13, 2022

Get inside your stronghold and make all your Django views default login_required

Stronghold Get inside your stronghold and make all your Django views default login_required Stronghold is a very small and easy to use django app that

384 Nov 23, 2022

💨 Fast, Async-ready, Openapi, type hints based framework for building APIs

Fast to learn, fast to code, fast to run Django Ninja - Fast Django REST Framework Django Ninja is a web framework for building APIs with Django and P

3.8k Jan 1, 2023

A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, celery and redis.

Django Channels Websocket Chatbot A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, c

8 Oct 28, 2022

Comments

No 'project name' exported to setup.yaml > Fix
If a project is created from scratch (without using any setup.yaml file), 'project name' is not exported to setup.yaml.

Creation process stops at 1st step.
opened by flyusfly 1

Releases(v1.0.17)

v1.0.17(Dec 20, 2021)

Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.16...v1.0.17
Source code(tar.gz)
Source code(zip)
v1.0.16(Dec 20, 2021)
Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.15...v1.0.16

Rest Framework issue Fixed

Formatting issue fixed

Source code(tar.gz)
Source code(zip)
v1.0.15(Dec 20, 2021)
Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.14...v1.0.15

Config File Parsing Error Fixed

Settings Import File Optimization [PEP8]

Readme and Gitignore outside source directory

Added Author Name and Description

Source code(tar.gz)
Source code(zip)
v1.0.14(Dec 20, 2021)

Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.13...v1.0.14
Source code(tar.gz)
Source code(zip)
v1.0.13(Dec 20, 2021)

Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.12...v1.0.13
Source code(tar.gz)
Source code(zip)
v1.0.12(Dec 20, 2021)

Full Changelog: https://github.com/khan-asfi-reza/django-setup-cli/compare/v1.0.1...v1.0.12
Source code(tar.gz)
Source code(zip)
v1.0.1(Dec 20, 2021)

Version Error Fixed
Source code(tar.gz)
Source code(zip)
1.0.0(Dec 20, 2021)
First Official Release

Create Django Production Ready Project

Auto Configure Settings

Auto Configure Template, Static, Media

Source code(tar.gz)
Source code(zip)

It takes time to start a Django Project and make it almost production-ready.

Related tags

Overview

django-setup-cli

Django Setup Cli

Requirements

Installation

1. Create a virtual environment and activate

2. Install django-setup-cli

Usages

1. startproject

Option 1:

Option 2:

1. Create a setup.yaml file

2. Run django-cli startproject in terminal/shell

Use Environment Variable in setup.yaml

2. generate

3. install

You might also like...

pytest-django allows you to test your Django project/applications with the pytest testing tool.

django-dashing is a customisable, modular dashboard application framework for Django to visualize interesting data about your project. Inspired in the dashboard framework Dashing

Intellicards-backend - A Django project bootstrapped with django-admin startproject mysite

Get inside your stronghold and make all your Django views default login_required

💨 Fast, Async-ready, Openapi, type hints based framework for building APIs

A Django chatbot that is capable of doing math and searching Chinese poet online. Developed with django, channels, celery and redis.

Blog focused on skills enhancement and knowledge sharing. Tech Stack's: Vue.js, Django and Django-Ninja

Meta package to combine turbo-django and stimulus-django

django-quill-editor makes Quill.js easy to use on Django Forms and admin sites

Comments

No 'project name' exported to setup.yaml > Fix

Releases(v1.0.17)

v1.0.17(Dec 20, 2021)

v1.0.16(Dec 20, 2021)

v1.0.15(Dec 20, 2021)

v1.0.14(Dec 20, 2021)

v1.0.13(Dec 20, 2021)

v1.0.12(Dec 20, 2021)

v1.0.1(Dec 20, 2021)

1.0.0(Dec 20, 2021)

First Official Release

Owner

Khan Asfi Reza

Django admin CKEditor integration.

Docker django app

Utilities for implementing a modified pre-order traversal tree in django.

A Django Webapp performing CRUD operations on Library Database.

Full featured redis cache backend for Django.

The Django Leaflet Admin List package provides an admin list view featured by the map and bounding box filter for the geo-based data of the GeoDjango.

Pinax is an open-source platform built on the Django Web Framework.

🏭 An easy-to-use implementation of Creation Methods for Django, backed by Faker.

A simple REST API to manage postal addresses, written in Python/Django.

Store model history and view/revert changes from admin site.

React.JS - Django Application Template

Atualizando o projeto APIs REST Django REST 2.0

A simple Django dev environment setup with docker for demo purposes for GalsenDev community

An airlines clone website with django

An API was build with Django to store and retrieve information about various musical instruments.

A CTF leaderboard for the submission of flags during a CTF challenge. Built using Django.