create-flask-api 0.0.7

This is a create-react-app analog that creates a base Flask Aplication structure with boilerplates.

Create Flask API

An simple to use cli to create your Flask API's!
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

Always when I wanted to start a new Flask API project I had to go through the same repetitive steps of creating a lot of folders, __init__.py's, configurations etc... and only then I would start coding. So I decided to create a Flask API factory that can very easily and fast create a base project that I can work on top of, increasing my productivity!

With this tool you can not only start a new project but also configure some features, listed down below:

• Start git versioning
• Choose a testintig package
• Choose a authentication package/configs
• Choose a serializer package
• Include Heroku config

Built With

This project was built using pure python and two packages, listed as follows:

• PyInquirer
• PyFiglet

Getting Started

This is a command line interface. When you install create-flask-api, it should be added to your local python modules folder, so then you can run it anytime in your machine using python -m command. But first you need to fulfill some prerequisites.

Prerequisites

To use this tool you will need to have pip (package intaller for python) and venv (python virtual environments provider) installed on your machine. If you don't have them installed take a look at their documentation: pip, venv Of course, you'll also need python (>=3.7).

Installation

The only thing you'll have to do is install this package using the following command:

pip install create-flask-api

Just like that.

NOTE: If you pip install this package inside a venv you'll be able to use it only inside the venv, so don't do that

Usage

To use it is very simple, just type the following command with your desired project name in your shell and it will automatically generate your project

python -m create_flask_api [-h] project_name

Positional arguments:

• project_name Here you should insert the project name.

Optional arguments:

• -h, --help show this help message and exit

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Pedro Henrique Germano Silva - [e-mail]

Project Link: https://github.com/peedrooh/create-flask-api