Flask Functional-Structured FrameworkΒΆ

☯️ flask_func_struct is framework for Flask web apps.

Developed in 🐍 python code.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

python checker python package github issues documentation status github contributors

InstallationΒΆ

Navigate to release page download and extract release archive πŸ“¦.

To install flask_func_struct πŸ“¦ type the following

tar xvzf flask_func_struct-x.y.z.tar.gz
cd flask_func_struct-x.y.z/
pip install -r requirements.txt
cp manage.py /FlaskApp/
cp -R /manage_commands/ /FlaskApp/
cp -R /app_server/ /Flask/

You can use Docker to create image/container 🚒.

github docker checker

DependenciesΒΆ

flask_func_struct requires next modules and libraries

alembic                           1.6.5
Flask                             1.1.4
Flask-Bcrypt                      1.0.1
Flask-Bootstrap                   3.3.7.1
Flask-Cors                        3.0.10
Flask-DebugToolbar                0.13.1
Flask-Login                       0.5.0
Flask-Mail                        0.9.1
Flask-Migrate                     2.6.0
Flask-Script                      2.0.6
Flask-SQLAlchemy                  2.5.1
Flask-Testing                     0.8.1
Flask-WTF                         0.14.3
SQLAlchemy                        1.4.27
Werkzeug                          1.0.1
WTForms                           2.3.3

Library structureΒΆ

flask_func_struct is based on OOP

🧰 Framework structure

.
β”œβ”€β”€ app_server/
β”‚Β Β  β”œβ”€β”€ configuration/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ database/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ development_config.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ production_config.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── test_config.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ development_config.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ mail/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ development_config.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ production_config.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── test_config.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ production_config.py
β”‚Β Β  β”‚Β Β  └── test_config.py
β”‚Β Β  β”œβ”€β”€ forms/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ base/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ contact.py
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── __init__.py
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  └── user/
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ edit.py
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ login.py
β”‚Β Β  β”‚Β Β      └── register.py
β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”œβ”€β”€ models/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ __init__.py
β”‚Β Β  β”‚Β Β  └── model_user.py
β”‚Β Β  β”œβ”€β”€ static/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ base.css
β”‚Β Β  β”‚Β Β  └── favicon.ico
β”‚Β Β  β”œβ”€β”€ templates/
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ base/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ about.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ contact.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── home.html
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ _base.html
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ errors/
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ 401.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ 403.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ 404.html
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── 500.html
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ footer.html
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ header.html
β”‚Β Β  β”‚Β Β  └── user/
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ administration.html
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ edit.html
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ login.html
β”‚Β Β  β”‚Β Β      β”œβ”€β”€ members.html
β”‚Β Β  β”‚Β Β      └── register.html
β”‚Β Β  └── views/
β”‚Β Β      β”œβ”€β”€ base/
β”‚Β Β      β”‚Β Β  β”œβ”€β”€ about.py
β”‚Β Β      β”‚Β Β  β”œβ”€β”€ contact.py
β”‚Β Β      β”‚Β Β  β”œβ”€β”€ home.py
β”‚Β Β      β”‚Β Β  └── __init__.py
β”‚Β Β      β”œβ”€β”€ __init__.py
β”‚Β Β      └── user/
β”‚Β Β          β”œβ”€β”€ administration.py
β”‚Β Β          β”œβ”€β”€ edit.py
β”‚Β Β          β”œβ”€β”€ __init__.py
β”‚Β Β          β”œβ”€β”€ login.py
β”‚Β Β          β”œβ”€β”€ logout.py
β”‚Β Β          β”œβ”€β”€ members.py
β”‚Β Β          └── register.py
β”œβ”€β”€ manage_commands/
β”‚Β Β  β”œβ”€β”€ create_database.py
β”‚Β Β  β”œβ”€β”€ create_data.py
β”‚Β Β  β”œβ”€β”€ create_superuser.py
β”‚Β Β  β”œβ”€β”€ drop_database.py
β”‚Β Β  └── __init__.py
└── manage.py

Indices and tablesΒΆ