Flask Ignite
A simple Flask app creator that automatically generates a basic Flask project structure including models, routes, services, configuration, and more.
Getting Started
This repository contains a utility package that, once installed, provides a CLI command to create a Flask project structure automatically. The command is registered as a console script named flask-admin.
Prerequisites
- Python 3.7 or higher
- Flask
- Flask-SQLAlchemy
- Flask-Migrate
- python-dotenv
Setup and Usage
-
Clone the Repository
Clone this repository to your local machine.
-
Install the Package
From the root of the repository, install the package locally:
pip install flask-ignite
-
Run the Project Setup Command
Execute the following command to generate the Flask project structure:
flask-ignite --project <your_project_name> # defaults to flask_app
This will create a project structure similar to the following:
- flask_app/
- app/
- models/
__init__.pyuser.pypost.py
- routes/
__init__.pyuser_routes.pypost_routes.py
- services/
__init__.pyuser_service.py
- config/
__init__.pysettings.py
extensions.py__init__.py
- models/
- migrations/
.envconfig.pyrequirements.txtwsgi.pyrun.py
- app/
- flask_app/
-
Next Steps
After generating the project, follow these steps:
-
Navigate into the generated project directory:
cd flask_app
-
Create a virtual environment:
python -m venv venv
-
Activate the virtual environment:
- Windows:
venv\Scripts\activate
- Mac/Linux:
source venv/bin/activate
- Windows:
-
Install the project dependencies:
pip install -r requirements.txt
-
Initialize the database:
flask db init && flask db migrate -m "Initial migration" && flask db upgrade
-
Run the app:
python run.py
-
Project Structure Overview
- app/models: Contains database models (e.g.,
UserandPostdefined inuser.pyandpost.py). - app/routes: Defines routes using Blueprints for handling API endpoints (in
user_routes.pyandpost_routes.py). - app/services: Holds service functions for data manipulation or retrieval (in
user_service.py). - app/config: Stores configuration settings and environment-specific variables (in
settings.py). - app/extensions.py: Initializes Flask extensions like SQLAlchemy and Migrate.
- app/init.py: Creates and configures the Flask application.
License
This project is licensed under the MIT License.
Author
Nahom D
Email: nahom@nahom.eu.org
Metadata
Release files for flask-ignite 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| flask_ignite-0.1.4.tar.gz | 4.5 kB | Without provenance | Details for flask_ignite-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| flask_ignite-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for flask_ignite-0.1.4-py3-none-any.whl |
Total release size: 9.2 kB
Release files / flask_ignite-0.1.4.tar.gz
| Download URL | flask_ignite-0.1.4.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
53fa93db81cfe721684d33e812b420bfa2ce8c1cd5ba76dda0c4cb0c81cb5249
|
|
BLAKE2b-256 checksum How to use checksums |
0293ce6b3c2462cb7a4ddd23f5434a0eddec2138b0d675a3f77c7c9034f67583
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Release files / flask_ignite-0.1.4-py3-none-any.whl
| Download URL | flask_ignite-0.1.4-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
898f0c290c51873438cc1e08f422a43007766943e00e2b4b1150f456e4c4c72d
|
|
BLAKE2b-256 checksum How to use checksums |
dfe0d3b7093d936ccfd7afd2077894875edf9bd9f0d5014ef08af96e8a1da978
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Security for flask-ignite 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.