Skip to main content

A Flask auto importer that allows your Flask apps to grow big.

Project description

Flask-Imp

tests PyPI version License Downloads black

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.txt
pip install -r requirements_dev.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_md folder. Edit these files then run the following command to generate the docs.

flask --app gdocs compile

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

flask --app gdocs compile --watch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_imp-4.0.0.tar.gz (76.1 kB view hashes)

Uploaded Source

Built Distribution

flask_imp-4.0.0-py3-none-any.whl (73.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page