Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usmanmusa1920/flask-unity
An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, connecting other flask extensions, database migrations, and other annoying stuffs.
https://github.com/usmanmusa1920/flask-unity
flask python
Last synced: 2 months ago
JSON representation
An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, connecting other flask extensions, database migrations, and other annoying stuffs.
- Host: GitHub
- URL: https://github.com/usmanmusa1920/flask-unity
- Owner: usmanmusa1920
- License: mit
- Created: 2023-08-06T06:10:57.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-22T14:36:33.000Z (3 months ago)
- Last Synced: 2024-10-29T09:06:34.620Z (2 months ago)
- Topics: flask, python
- Language: Python
- Homepage: https://flask-unity.readthedocs.io
- Size: 2.09 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# Flask-Unity
An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, connecting other flask extensions, database migrations, and other annoying stuffs.
[](https://pypi.org/project/flask-unity)
[](https://pypi.org/project/flask-unity)
[](https://pypi.org/project/flask-unity)
[](https://pypi.org/project/flask-unity)
## Installation
Install and update the latest release from pypi, we recomend you to create a virtual environment to avoid conflict (upgrade/downgrade of some of your system libraries) when installing flask-unity, this is just a recomendation, it still work even if you install it without using virtual environment. Basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution), this software (library) is compatible and also tested with `windows OS`, `linux`, `macOS` and possibly can be compabible with others too!.
```sh
pip install --upgrade flask_unity
```
## Create flask project
After the installation paste either (one) of the following command on your termianl
```sh
flaskunity -p schoolsite
# or
flaskunity --project schoolsite
```
This will create a project called `schoolsite` now cd into the `schoolsite` directory, if you do `ls` within the directory you just enter you will see a module called `run.py`, `alembic.ini` and some directories (some in the form of package) `media`, `static`, `templates`, `migrations` and a directory with the same name of your base directory name, in our case it is `schoolsite`.
Next make migrations by:
```sh
flaskunity db makemigrations
```
If you do **ls** after making the migrations you will see it initiate a **default.db** file (an sqlite file) which is our default database. Apply the migrations:
```sh
flaskunity db migrate
```
> **Note**
> As soon as you create the project make migrations and apply the migrations to avoid errors!
Now ready to boot up the flask server by running the below command
```sh
python run.py boot
```
Visit the local url `http://127.0.0.1:5000` this will show you index page of your project
## Create flask app within your project (schoolsite)
For you to start an app within your project `schoolsite` shutdown the flask development server by pressing `CTRL+C` and then run the following command, by giving the name you want your app to be, in our case we will call our app `exam`
```sh
python run.py create_app -a exam
```
this will create an app (a new package called `exam`) within your project `(schoolsite)`
## Register an app
Once the app is created open a file `schoolsite/routes.py` and import your `exam` blueprint which is in (`exam/views.py`), default name given to an app blueprint, is the app name so our `exam` app blueprint name is `exam`, after importing it, append (register) the app blueprint in a function called `reg_blueprints_func`, which was assigned to `reg_blueprints` in that same file of `schoolsite/routes.py`
importing blueprint
```py
from exam.views import exam
```
registering blueprint
```py
reg_blueprints = reg_blueprints_func(
base,
exam,
)
```
once you register the app, boot up the flask webserver again by
```sh
python run.py boot
```
visit `http://127.0.0.1:5000` which is your project landing page
visit `http://127.0.0.1:5000/exam` this will take you to your app landing page (exam)
visit `http://127.0.0.1:5000/admin` this will take you to admin page. From there you are ready to go.
Tutorials here!
More documentations here!
### Flask-unity default page
[](https://flask-unity.readthedocs.io)
## Useful links
- Documentation: https://flask-unity.readthedocs.io
- Repository: https://github.com/usmanmusa1920/flask-unity
- PYPI Release: https://pypi.org/project/flask-unity
Pull requests are welcome