Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vroncevic/flask_func_struct
Flask Monolith Project Template - Class-Functional Structure
https://github.com/vroncevic/flask_func_struct
coverage flask flask-bcrypt flask-bootstrap flask-debugtoolbar flask-login flask-migrate flask-script flask-sqlalchemy flask-testing flask-wtf project python wtforms
Last synced: 10 days ago
JSON representation
Flask Monolith Project Template - Class-Functional Structure
- Host: GitHub
- URL: https://github.com/vroncevic/flask_func_struct
- Owner: vroncevic
- License: gpl-3.0
- Created: 2017-03-18T11:53:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T23:04:16.000Z (6 months ago)
- Last Synced: 2024-12-07T03:45:17.287Z (16 days ago)
- Topics: coverage, flask, flask-bcrypt, flask-bootstrap, flask-debugtoolbar, flask-login, flask-migrate, flask-script, flask-sqlalchemy, flask-testing, flask-wtf, project, python, wtforms
- Language: Python
- Homepage: https://vroncevic.github.io/flask_func_struct
- Size: 6.4 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Flask Functional-Structured Framework
☯️ **flask_func_struct** is framework for managing Flask App.
Developed in 🐍 **[python](https://www.python.org/)** 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.
[](https://github.com/vroncevic/flask_func_struct/actions/workflows/flask_func_struct_python_checker.yml) [](https://github.com/vroncevic/flask_func_struct/actions/workflows/flask_func_struct_package_checker.yml) [](https://github.com/vroncevic/flask_func_struct/issues) [](https://github.com/vroncevic/flask_func_struct/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Package structure](#package-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and licence](#copyright-and-licence)
### Installation
Used next development environment
Navigate to **[release page](https://github.com/vroncevic/flask_func_struct/releases)** download and extract release archive 📦.
To install **flask_func_struct** 📦 type the following
```bash
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/
```
Or You can use Dockerfile to create image/container 🚢.
[](https://github.com/vroncevic/flask_func_struct/actions/workflows/flask_func_struct_docker_checker.yml)
### Usage
Create databse
```bash
$ python manage.py create_db
Create database/tables
Done
```
Init databse and prepare alembic table
```bash
$ python manage.py db init
Creating directory /data/dev/python/flask_func_struct/github/flask_func_struct/migrations ... done
Creating directory /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/versions ... done
Generating /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/env.pyc ... done
Generating /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/env.py ... done
Generating /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/alembic.ini ... done
Generating /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/README ... done
Generating /data/dev/python/flask_func_struct/github/flask_func_struct/migrations/script.py.mako ... done
Please edit configuration/connection/logging settings in
'/data/dev/python/flask_func_struct/github/flask_func_struct/migrations/alembic.ini' before proceeding.
```
Generate a migration script that makes the database match the models
```bash
$ python manage.py db migrate
INFO [alembic.runtime.migration] Context impl SQLiteImpl.
INFO [alembic.runtime.migration] Will assume non-transactional DDL.
INFO [alembic.env] No changes in schema detected.
```
Create super user
```bash
$ python manage.py createsuperuser
Creating superuser account
Insert username of superuser: adroot
Insert email of superuser: [email protected]
Insert password of superuser:
Done
```
Run application
```bash
$ python manage.py runserver
* Serving Flask app "app_server" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 226-526-932
```
### Dependencies
**flask_func_struct** requires other modules and libraries (Python 2.x)
```bash
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
```
### Package structure
🧰 Expected framework structure
```bash
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
```
### Docs
[](https://flask-func-struct.readthedocs.io/en/latest/?badge=latest)
📗 More documentation and info at
* [flask_func_struct.readthedocs.io](https://flask_func_struct.readthedocs.io/en/latest/)
* [www.python.org](https://www.python.org/)
### Contributing
🌎 🌍 🌏 [Contributing to config_flask](CONTRIBUTING.md)
### Copyright and licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2017 by [vroncevic.github.io/flask_func_struct](https://vroncevic.github.io/flask_func_struct/)
**flask_func_struct** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 2.x or,
at your option, any later version of Python 2 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://psfmember.org/index.php?q=civicrm/contribute/transact&reset=1&id=2)