Setup a flask project using a single command, right from creating virtual environment to creating Procfile for deployment.

Overview

AutoFlask-Setup

About

AutoFlask-Setup can help you set up a new Flask Project, right from creating virtual environment to creating Procfile for deployment.

Requirements

  • Python (3.6+)

Usage

  • Just copy the setup.py file in your directory, wherever you want your project to be setup.

  • Important Commands:

    • python setup.py - About AutoFlask-Setup
    • python setup.py help - Get Necessary Commands List
    • python setup.py copyright - Get Copyright Information
    • python setup.py credits - Get Credits Information
    • python setup.py license - Get License Information
    • python setup.py initproject - Initialize Flask Project
  • Once the project setup is complete, you can delete the setup.py file safely.

Example

=2.0 Using cached itsdangerous-2.0.1-py3-none-any.whl (18 kB) Collecting Werkzeug>=2.0 Using cached Werkzeug-2.0.2-py3-none-any.whl (288 kB) Collecting click>=7.1.2 Using cached click-8.0.3-py3-none-any.whl (97 kB) Collecting Jinja2>=3.0 Using cached Jinja2-3.0.2-py3-none-any.whl (133 kB) Collecting alembic>=0.7 Using cached alembic-1.7.4-py3-none-any.whl (209 kB) Collecting SQLAlchemy>=0.8.0 Using cached SQLAlchemy-1.4.26-cp39-cp39-win_amd64.whl (1.5 MB) Collecting blinker Using cached blinker-1.4-py3-none-any.whl Collecting Mako Using cached Mako-1.1.5-py2.py3-none-any.whl (75 kB) Collecting colorama Using cached colorama-0.4.4-py2.py3-none-any.whl (16 kB) Collecting MarkupSafe>=2.0 Using cached MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl (14 kB) Collecting greenlet!=0.4.17 Using cached greenlet-1.1.2-cp39-cp39-win_amd64.whl (101 kB) Installing collected packages: MarkupSafe, colorama, Werkzeug, Jinja2, itsdangerous, greenlet, click, SQLAlchemy, Mako, Flask, Flask-SQLAlchemy, blinker, alembic, python-decouple, Flask-Migrate, Flask-Mail Successfully installed Flask-2.0.2 Flask-Mail-0.9.1 Flask-Migrate-3.1.0 Flask-SQLAlchemy-2.5.1 Jinja2-3.0.2 Mako-1.1.5 MarkupSafe-2.0.1 SQLAlchemy-1.4.26 Werkzeug-2.0.2 alembic-1.7.4 blinker-1.4 click-8.0.3 colorama-0.4.4 greenlet-1.1.2 itsdangerous-2.0.1 python-decouple-3.5 All dependencies installed successfully Creating package Package created successfully Creating app runner... App runner created successfully Creating configurations file... Configurations file created successfully Creating templates and static directory... Templates and static directory created successfully Creating routes... Routes created successfully Creating models... Models created successfully Creating miscellaneous files... * Tip: There are .env or .flaskenv files present. Do "pip install python-dotenv" to use them. Creating directory D:\Quarantine\Flask\Test\migrations ... done Creating directory D:\Quarantine\Flask\Test\migrations\versions ... done Generating D:\Quarantine\Flask\Test\migrations\alembic.ini ... done Generating D:\Quarantine\Flask\Test\migrations\env.py ... done Generating D:\Quarantine\Flask\Test\migrations\README ... done Generating D:\Quarantine\Flask\Test\migrations\script.py.mako ... done Please edit configuration/connection/logging settings in 'D:\\Quarantine\\Flask\\Test\\migrations\\alembic.ini' before proceeding. Miscellaneous files created successfully Project Setup Complete Please make necessary changes in '.env' file. Please run 'python setup.py help' for necessary commands. ">
$ py setup.py 

AutoFlask-Setup can help you set up a new Flask Project, right from creating virtual environment to creating Procfile for deployment.
AutoFlask-Setup(v1.0.0, Oct 20 2021, 8:25:39)
Add arguments like "help", "copyright", "credits" or "license" for more information.

DEVIL@ASHUTOSH-PC MINGW64 /d/Quarantine/Flask/Test (main)
$ py setup.py initproject

Initiating Project Setup

Creating and activating a virtual environment...
Installing virtualenv on Windows ... 

[+] virtualenv installed.

Creating A New virtualenv ...
Virtual environment activated successfully

Installing required dependencies...
Collecting Flask
  Using cached Flask-2.0.2-py3-none-any.whl (95 kB)
Collecting Flask-Migrate
  Using cached Flask_Migrate-3.1.0-py3-none-any.whl (20 kB)
Collecting Flask-SQLAlchemy
  Using cached Flask_SQLAlchemy-2.5.1-py2.py3-none-any.whl (17 kB)
Collecting Flask-Mail
  Using cached Flask_Mail-0.9.1-py3-none-any.whl
Collecting python-decouple
  Using cached python_decouple-3.5-py3-none-any.whl (9.6 kB)
Collecting itsdangerous>=2.0
  Using cached itsdangerous-2.0.1-py3-none-any.whl (18 kB)
Collecting Werkzeug>=2.0
  Using cached Werkzeug-2.0.2-py3-none-any.whl (288 kB)
Collecting click>=7.1.2
  Using cached click-8.0.3-py3-none-any.whl (97 kB)
Collecting Jinja2>=3.0
  Using cached Jinja2-3.0.2-py3-none-any.whl (133 kB)
Collecting alembic>=0.7
  Using cached alembic-1.7.4-py3-none-any.whl (209 kB)
Collecting SQLAlchemy>=0.8.0
  Using cached SQLAlchemy-1.4.26-cp39-cp39-win_amd64.whl (1.5 MB)
Collecting blinker
  Using cached blinker-1.4-py3-none-any.whl
Collecting Mako
  Using cached Mako-1.1.5-py2.py3-none-any.whl (75 kB)
Collecting colorama
  Using cached colorama-0.4.4-py2.py3-none-any.whl (16 kB)
Collecting MarkupSafe>=2.0
  Using cached MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl (14 kB)
Collecting greenlet!=0.4.17
  Using cached greenlet-1.1.2-cp39-cp39-win_amd64.whl (101 kB)
Installing collected packages: MarkupSafe, colorama, Werkzeug, Jinja2, itsdangerous, greenlet, click, SQLAlchemy, Mako, Flask, Flask-SQLAlchemy, blinker, alembic, python-decouple, Flask-Migrate, Flask-Mail
Successfully installed Flask-2.0.2 Flask-Mail-0.9.1 Flask-Migrate-3.1.0 Flask-SQLAlchemy-2.5.1 Jinja2-3.0.2 Mako-1.1.5 MarkupSafe-2.0.1 SQLAlchemy-1.4.26 Werkzeug-2.0.2 alembic-1.7.4 blinker-1.4 click-8.0.3 colorama-0.4.4 greenlet-1.1.2 itsdangerous-2.0.1 python-decouple-3.5
All dependencies installed successfully

Creating package
Package created successfully

Creating app runner...
App runner created successfully

Creating configurations file...
Configurations file created successfully

Creating templates and static directory...
Templates and static directory created successfully

Creating routes...
Routes created successfully

Creating models...
Models created successfully

Creating miscellaneous files...
 * Tip: There are .env or .flaskenv files present. Do "pip install python-dotenv" to use them.
Creating directory D:\Quarantine\Flask\Test\migrations ...  done
Creating directory D:\Quarantine\Flask\Test\migrations\versions ...  done
Generating D:\Quarantine\Flask\Test\migrations\alembic.ini ...  done
Generating D:\Quarantine\Flask\Test\migrations\env.py ...  done
Generating D:\Quarantine\Flask\Test\migrations\README ...  done
Generating D:\Quarantine\Flask\Test\migrations\script.py.mako ...  done
Please edit configuration/connection/logging settings in 'D:\\Quarantine\\Flask\\Test\\migrations\\alembic.ini' before proceeding.
Miscellaneous files created successfully

Project Setup Complete

Please make necessary changes in '.env' file.
Please run 'python setup.py help' for necessary commands.
You might also like...
Template for creating ds simple projects

ds-project-template Template for creating ds simple projects Requirements pyenv python==3.9.4 Setup For this purpose you use following commands: pytho

simple flask starter app utilizing docker

Simple flask starter app utilizing docker to showcase seasonal anime using jikanpy (myanimelist unofficial api).

CRUD app to create and save code snippets, Flask/Python restful Api/backend and React/Typescript frontend
CRUD app to create and save code snippets, Flask/Python restful Api/backend and React/Typescript frontend

MS3 Cheat-Hub A cheatsheet hub. An app that organizes your code snippets into collections of cheat sheets and allows you to view, like and save others

Boilerplate code for a Python Flask API

MrMat :: Python :: API :: Flask Boilerplate code for a Python Flask API This variant of a Python Flask API is code-first and using native Flask Featur

Basic Docker Compose template application with Flask, Celery, Redis, MySQL, SocketIO, Nginx and Gunicorn.

Nginx / Gunicorn / Flask 🐍 / Celery / SocketIO / MySQL / Redis / Docker 🐳 sample application Basic Docker Compose template application for orchestat

A Django project skeleton that is modern and cutting edge.

{% comment "This comment section will be deleted in the generated project" %} Edge A Fantastic Django project starter. Features Ready Bootstrap-themed

Django starter project with 🔋
Django starter project with 🔋

A batteries-included Django starter project. For a production-ready version see the book Django for Professionals. 🚀 Features Django 3.1 & Python 3.8

Project template layout for Django 3.0+

Django 3.0+ project template This is a simple Django 3.0+ project template with my preferred setup. Most Django project templates make way too many as

A project to get you started with Docker and Django.

Docker Django tl;dr $ git clone [email protected]:erroneousboat/docker-django.git $ docker-compose up Now you can access the application at https://local

Comments
  • changed command system, added better word wrap, added gitignore

    changed command system, added better word wrap, added gitignore

    Nice script. I changed the command system to be a bit different, and future-proof. I also added some word wrapping so it's easier to read if you don't have word wrap on GitHub or your editor.

    One small note, you might want to change the env file's secret key to be random each time an env file gets generated.

    opened by Mrmagicpie 2
A template for some new Python tool or package with a reasonable basic setup.

python-app-template A template with a reasonable basic setup, including: black (formatting) flake8 (linting) mypy (type checking) isort (import sortin

Anton Pirogov 3 Jul 19, 2022
Brif is a boilerplate tool based on Docker and FastAPI, designed to streamline the development and deployment of IIIF compliant platforms.

brif A boilerplate tool based on Docker, designed to streamline the development and deployment of IIIF compliant platforms. Embedded with FastAPI, Cel

Pierre 8 Sep 17, 2022
Cookiecutter Flask OpenAPI is a template for jumpstarting production-ready Flask projects quickly.

Cookiecutter Flask OpenAPI is a template for jumpstarting production-ready Flask projects quickly. It has a well organized and scalable structure. It uses API design first

Roger Camargo 3 Nov 17, 2022
Template for creating PyPI project

template-for-creating-pypi-project Template for creating PyPI project Hello there! This is a template for creating a PyPI project. Fork or clone this

null 4 Apr 25, 2022
This is the starter for the Flask React project.

Flask React Project This is the starter for the Flask React project. Getting started Clone this repository (only this branch) git clone https://github

Jami Travers 5 May 25, 2022
Open-source full-stack seed project that uses a React UI powered by a simple Flask API Server

React Flask Authentication Open-source full-stack seed project that uses a React UI powered by a simple Flask API Server.

App Generator 37 Dec 24, 2022
The starter for the Flask React project

Flask React Project This is the starter for the Flask React project. Getting started Clone this repository (only this branch) git clone https://github

Parker Bolick 2 May 14, 2022
A command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, VueJS projects.

Cookiecutter A command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python

null 18.7k Jan 8, 2023
Starter project for python based lambda project.

Serverless Python Starter Starter project for python based lambda project. Features FastAPI - Frontend dev with Hot Reload API Gateway Integration (+r

null 4 Feb 22, 2022
A python starter package to be used as a template for creating your own python packages.

Python Starter Package This is a basic python starter package to be used as a template for creating your own python packages. Github repo: https://git

Mystic 1 Apr 4, 2022