Flask-Imp

What is Flask-Imp?

Flask-Imp's main purpose is to help simplify the importing of blueprints, resources, and models. It has a few extra features built in to help with securing pages and password authentication.

Documentation

https://cheesecake87.github.io/flask-imp/

Getting Started

Setup.

Create a new project folder and navigate to it.

# Linux
cd /path/to/project-folder

# Windows
cd C:\path\to\project-folder

Create a virtual environment and activate it.

Linux / MacOS

python3 -m venv venv

source venv/bin/activate

Windows

python -m venv venv

.\venv\Scripts\activate

Install Flask-Imp

pip install flask-imp

Create a new project.

flask-imp init

Working on this project.

Setup.

Create a new project folder and navigate to it in the terminal, then clone this repository.

git clone https://github.com/CheeseCake87/flask-imp.git

Create a virtual environment and activate it.

Linux / MacOS

python3 -m venv venv

source venv/bin/activate

Windows

python -m venv venv

.\venv\Scripts\activate

Install the requirements.

pip install -r requirements/development.txt

Install the local version of Flask-Imp.

flit install

Run the included Flask app.

Flask run --debug

Run the tests.

pytest

Run the tests under multiple Python versions using docker.

python3 test_docker

Info

The Flask app is located in the app folder.

The tests are located in the tests folder.

The test Flask app is located in the tests/test_app folder.

The tests are linked to the tests blueprint located at test_app/blueprints/tests.

Building the docs.

All docs are generated from the docs folder.

Edit these files, then run the following command to generate the docs.

flask --app docs compile

You can set it to watch for changes and automatically recompile the docs by adding the --watch flag.

flask --app gdocs compile --watch