FlaskSpark 0.1.0__tar.gz

flaskspark-0.1.0/FlaskSpark.egg-info/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: FlaskSpark
+Version: 0.1.0
+Summary: FlaskSpark is a lightweight and customizable Flask boilerplate designed to ignite your web application development process.
+Author: berofa
+License: MIT License
+        
+        Copyright (c) 2025 berofa
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: authlib
+Requires-Dist: flask>=2.0
+Requires-Dist: flask-assets
+Requires-Dist: flask-babel
+Requires-Dist: flask-login
+Requires-Dist: flask-migrate
+Requires-Dist: flask-session
+Requires-Dist: flask-sqlalchemy
+Requires-Dist: libsass
+Requires-Dist: python-dotenv
+Requires-Dist: rcssmin
+Requires-Dist: requests
+Requires-Dist: rjsmin
+Dynamic: license-file
+
+# FlaskSpark
+
+FlaskSpark is a lightweight Flask framework with a clear project structure, automatic class-based view registration, built-in SQLAlchemy + Flask-Migrate wiring, optional OAuth/OIDC login, and an asset pipeline for SCSS/JS.
+
+## Features
+- App bootstrap with configurable `app_module`
+- Auto-registration of class-based views (`as_view()`)
+- SQLAlchemy + Flask-Migrate integration
+- Pluggable login providers (`Default`, `OAuth`)
+- OAuth/OIDC support via `authlib`
+- Built-in i18n with Flask-Babel
+- Static/template fallback (app first, FlaskSpark second)
+- Optional SCSS/JS bundling via Flask-Assets
+
+## Requirements
+- Python 3.8+
+- pip
+
+## Installation
+```bash
+pip install FlaskSpark
+```
+
+Development (editable):
+```bash
+pip install -e .
+```
+
+## Quick Start
+```python
+from flaskspark import FlaskSpark
+
+app = FlaskSpark(
+    app_module="app",
+    config={
+        "SECRET_KEY": "change-me",
+        "SQLALCHEMY_DATABASE_URI": "sqlite:///instance/app.db",
+        "BABEL_SUPPORTED_LOCALES": ["en", "de"],
+    },
+).app
+```
+
+Expected app layout:
+```text
+app/
+  __init__.py
+  views/
+    home.py
+  models/
+    __init__.py
+  templates/
+  static/
+```
+
+## Class-Based Views
+Any class in `app.views` implementing `as_view()` is auto-registered.
+
+```python
+from flaskspark.views.flaskspark_method_view import FlaskSparkMethodView
+from flask import render_template
+
+class HomeView(FlaskSparkMethodView):
+    url = "/"
+    endpoint = "home"
+
+    def get(self):
+        return render_template("index.html")
+```
+
+## OAuth (OIDC) Login Provider
+Enable OAuth provider:
+```python
+FlaskSpark(login_provider="OAuth")
+```
+
+Required config:
+```text
+OAUTH_NAME
+OAUTH_AUTHORIZE_URL
+OAUTH_ACCESS_TOKEN_URL
+OAUTH_USERINFO_ENDPOINT
+OAUTH_JWKS_URI
+OAUTH_CLIENT_ID
+OAUTH_CLIENT_SECRET
+OAUTH_SCOPE
+```
+
+Optional role mapping:
+```text
+OAUTH_GROUPS_CLAIM=groups
+OAUTH_ROLE_PRIORITY=admins,editors,users
+OAUTH_ROLE_MAP=admins:Administrators,editors:Editors,users:Users
+```
+
+## Database & Migrations
+```bash
+FLASK_APP=app.py python -m flask db init
+FLASK_APP=app.py python -m flask db migrate -m "init"
+FLASK_APP=app.py python -m flask db upgrade
+```
+
+## Assets (SCSS / JS)
+FlaskSpark can build SCSS and JS bundles:
+
+```python
+FlaskSpark(
+    app_module="app",
+    config={
+        "ASSETS_ENABLE": True,
+        "ASSETS_AUTO_BUILD": True,
+        "ASSETS_BUNDLES": [
+            {
+                "name": "dashboard_js",
+                "type": "js",
+                "entry": "js/dashboard.js",
+                "output": "scripts/dashboard.min.js",
+                "filters": "rjsmin",
+            },
+        ],
+    },
+)
+```
+
+## i18n
+FlaskSpark initializes Babel and provides a client-side translation endpoint:
+
+```text
+GET /_flaskspark/i18n?keys=Key%201,Key%202
+```
+
+## Configuration
+Common keys:
+```python
+SECRET_KEY = "..."
+SQLALCHEMY_DATABASE_URI = "sqlite:///instance/app.db"
+APP_BIND_HOST = "0.0.0.0"
+APP_PORT = 5067
+BABEL_DEFAULT_LOCALE = "en"
+BABEL_SUPPORTED_LOCALES = ["en", "de"]
+```
+
+## License
+MIT License. See `LICENSE`.

flaskspark-0.1.0/FlaskSpark.egg-info/SOURCES.txt

@@ -0,0 +1,45 @@
+LICENSE
+README.md
+pyproject.toml
+FlaskSpark.egg-info/PKG-INFO
+FlaskSpark.egg-info/SOURCES.txt
+FlaskSpark.egg-info/dependency_links.txt
+FlaskSpark.egg-info/requires.txt
+FlaskSpark.egg-info/top_level.txt
+flaskspark/__init__.py
+flaskspark/app.py
+flaskspark/config.py
+flaskspark/exceptions/__init__.py
+flaskspark/exceptions/database_connection_error.py
+flaskspark/exceptions/database_incomplete_error.py
+flaskspark/helpers/login_provider.py
+flaskspark/helpers/login_provider_default.py
+flaskspark/helpers/login_provider_oauth.py
+flaskspark/helpers/user_utilities.py
+flaskspark/models/role.py
+flaskspark/models/user.py
+flaskspark/static/images/favicon/android-chrome-192x192.png
+flaskspark/static/images/favicon/android-chrome-512x512.png
+flaskspark/static/images/favicon/apple-touch-icon.png
+flaskspark/static/images/favicon/favicon-16x16.png
+flaskspark/static/images/favicon/favicon-32x32.png
+flaskspark/static/images/favicon/favicon.ico
+flaskspark/static/images/favicon/site.webmanifest
+flaskspark/static/scripts/app.js
+flaskspark/static/scripts/webpack.js
+flaskspark/static/scss/app.scss
+flaskspark/static/scss/maps.scss
+flaskspark/static/scss/styles.scss
+flaskspark/static/scss/variables.scss
+flaskspark/templates/base.html
+flaskspark/templates/layouts/default.html
+flaskspark/templates/layouts/detached.html
+flaskspark/templates/layouts/horizontal.html
+flaskspark/templates/partials/footer.html
+flaskspark/templates/partials/navigation-main.html
+flaskspark/templates/partials/navigation-user.html
+flaskspark/templates/partials/sidebar.html
+flaskspark/templates/views/main/get.html
+flaskspark/views/__init__.py
+flaskspark/views/flaskspark_method_view.py
+flaskspark/views/main.py

flaskspark-0.1.0/FlaskSpark.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flaskspark-0.1.0/FlaskSpark.egg-info/requires.txt

@@ -0,0 +1,13 @@
+authlib
+flask>=2.0
+flask-assets
+flask-babel
+flask-login
+flask-migrate
+flask-session
+flask-sqlalchemy
+libsass
+python-dotenv
+rcssmin
+requests
+rjsmin

flaskspark-0.1.0/FlaskSpark.egg-info/top_level.txt

@@ -0,0 +1 @@
+flaskspark

flaskspark-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 berofa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flaskspark-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: FlaskSpark
+Version: 0.1.0
+Summary: FlaskSpark is a lightweight and customizable Flask boilerplate designed to ignite your web application development process.
+Author: berofa
+License: MIT License
+        
+        Copyright (c) 2025 berofa
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: authlib
+Requires-Dist: flask>=2.0
+Requires-Dist: flask-assets
+Requires-Dist: flask-babel
+Requires-Dist: flask-login
+Requires-Dist: flask-migrate
+Requires-Dist: flask-session
+Requires-Dist: flask-sqlalchemy
+Requires-Dist: libsass
+Requires-Dist: python-dotenv
+Requires-Dist: rcssmin
+Requires-Dist: requests
+Requires-Dist: rjsmin
+Dynamic: license-file
+
+# FlaskSpark
+
+FlaskSpark is a lightweight Flask framework with a clear project structure, automatic class-based view registration, built-in SQLAlchemy + Flask-Migrate wiring, optional OAuth/OIDC login, and an asset pipeline for SCSS/JS.
+
+## Features
+- App bootstrap with configurable `app_module`
+- Auto-registration of class-based views (`as_view()`)
+- SQLAlchemy + Flask-Migrate integration
+- Pluggable login providers (`Default`, `OAuth`)
+- OAuth/OIDC support via `authlib`
+- Built-in i18n with Flask-Babel
+- Static/template fallback (app first, FlaskSpark second)
+- Optional SCSS/JS bundling via Flask-Assets
+
+## Requirements
+- Python 3.8+
+- pip
+
+## Installation
+```bash
+pip install FlaskSpark
+```
+
+Development (editable):
+```bash
+pip install -e .
+```
+
+## Quick Start
+```python
+from flaskspark import FlaskSpark
+
+app = FlaskSpark(
+    app_module="app",
+    config={
+        "SECRET_KEY": "change-me",
+        "SQLALCHEMY_DATABASE_URI": "sqlite:///instance/app.db",
+        "BABEL_SUPPORTED_LOCALES": ["en", "de"],
+    },
+).app
+```
+
+Expected app layout:
+```text
+app/
+  __init__.py
+  views/
+    home.py
+  models/
+    __init__.py
+  templates/
+  static/
+```
+
+## Class-Based Views
+Any class in `app.views` implementing `as_view()` is auto-registered.
+
+```python
+from flaskspark.views.flaskspark_method_view import FlaskSparkMethodView
+from flask import render_template
+
+class HomeView(FlaskSparkMethodView):
+    url = "/"
+    endpoint = "home"
+
+    def get(self):
+        return render_template("index.html")
+```
+
+## OAuth (OIDC) Login Provider
+Enable OAuth provider:
+```python
+FlaskSpark(login_provider="OAuth")
+```
+
+Required config:
+```text
+OAUTH_NAME
+OAUTH_AUTHORIZE_URL
+OAUTH_ACCESS_TOKEN_URL
+OAUTH_USERINFO_ENDPOINT
+OAUTH_JWKS_URI
+OAUTH_CLIENT_ID
+OAUTH_CLIENT_SECRET
+OAUTH_SCOPE
+```
+
+Optional role mapping:
+```text
+OAUTH_GROUPS_CLAIM=groups
+OAUTH_ROLE_PRIORITY=admins,editors,users
+OAUTH_ROLE_MAP=admins:Administrators,editors:Editors,users:Users
+```
+
+## Database & Migrations
+```bash
+FLASK_APP=app.py python -m flask db init
+FLASK_APP=app.py python -m flask db migrate -m "init"
+FLASK_APP=app.py python -m flask db upgrade
+```
+
+## Assets (SCSS / JS)
+FlaskSpark can build SCSS and JS bundles:
+
+```python
+FlaskSpark(
+    app_module="app",
+    config={
+        "ASSETS_ENABLE": True,
+        "ASSETS_AUTO_BUILD": True,
+        "ASSETS_BUNDLES": [
+            {
+                "name": "dashboard_js",
+                "type": "js",
+                "entry": "js/dashboard.js",
+                "output": "scripts/dashboard.min.js",
+                "filters": "rjsmin",
+            },
+        ],
+    },
+)
+```
+
+## i18n
+FlaskSpark initializes Babel and provides a client-side translation endpoint:
+
+```text
+GET /_flaskspark/i18n?keys=Key%201,Key%202
+```
+
+## Configuration
+Common keys:
+```python
+SECRET_KEY = "..."
+SQLALCHEMY_DATABASE_URI = "sqlite:///instance/app.db"
+APP_BIND_HOST = "0.0.0.0"
+APP_PORT = 5067
+BABEL_DEFAULT_LOCALE = "en"
+BABEL_SUPPORTED_LOCALES = ["en", "de"]
+```
+
+## License
+MIT License. See `LICENSE`.

flaskspark-0.1.0/README.md

@@ -0,0 +1,143 @@
+# FlaskSpark
+
+FlaskSpark is a lightweight Flask framework with a clear project structure, automatic class-based view registration, built-in SQLAlchemy + Flask-Migrate wiring, optional OAuth/OIDC login, and an asset pipeline for SCSS/JS.
+
+## Features
+- App bootstrap with configurable `app_module`
+- Auto-registration of class-based views (`as_view()`)
+- SQLAlchemy + Flask-Migrate integration
+- Pluggable login providers (`Default`, `OAuth`)
+- OAuth/OIDC support via `authlib`
+- Built-in i18n with Flask-Babel
+- Static/template fallback (app first, FlaskSpark second)
+- Optional SCSS/JS bundling via Flask-Assets
+
+## Requirements
+- Python 3.8+
+- pip
+
+## Installation
+```bash
+pip install FlaskSpark
+```
+
+Development (editable):
+```bash
+pip install -e .
+```
+
+## Quick Start
+```python
+from flaskspark import FlaskSpark
+
+app = FlaskSpark(
+    app_module="app",
+    config={
+        "SECRET_KEY": "change-me",
+        "SQLALCHEMY_DATABASE_URI": "sqlite:///instance/app.db",
+        "BABEL_SUPPORTED_LOCALES": ["en", "de"],
+    },
+).app
+```
+
+Expected app layout:
+```text
+app/
+  __init__.py
+  views/
+    home.py
+  models/
+    __init__.py
+  templates/
+  static/
+```
+
+## Class-Based Views
+Any class in `app.views` implementing `as_view()` is auto-registered.
+
+```python
+from flaskspark.views.flaskspark_method_view import FlaskSparkMethodView
+from flask import render_template
+
+class HomeView(FlaskSparkMethodView):
+    url = "/"
+    endpoint = "home"
+
+    def get(self):
+        return render_template("index.html")
+```
+
+## OAuth (OIDC) Login Provider
+Enable OAuth provider:
+```python
+FlaskSpark(login_provider="OAuth")
+```
+
+Required config:
+```text
+OAUTH_NAME
+OAUTH_AUTHORIZE_URL
+OAUTH_ACCESS_TOKEN_URL
+OAUTH_USERINFO_ENDPOINT
+OAUTH_JWKS_URI
+OAUTH_CLIENT_ID
+OAUTH_CLIENT_SECRET
+OAUTH_SCOPE
+```
+
+Optional role mapping:
+```text
+OAUTH_GROUPS_CLAIM=groups
+OAUTH_ROLE_PRIORITY=admins,editors,users
+OAUTH_ROLE_MAP=admins:Administrators,editors:Editors,users:Users
+```
+
+## Database & Migrations
+```bash
+FLASK_APP=app.py python -m flask db init
+FLASK_APP=app.py python -m flask db migrate -m "init"
+FLASK_APP=app.py python -m flask db upgrade
+```
+
+## Assets (SCSS / JS)
+FlaskSpark can build SCSS and JS bundles:
+
+```python
+FlaskSpark(
+    app_module="app",
+    config={
+        "ASSETS_ENABLE": True,
+        "ASSETS_AUTO_BUILD": True,
+        "ASSETS_BUNDLES": [
+            {
+                "name": "dashboard_js",
+                "type": "js",
+                "entry": "js/dashboard.js",
+                "output": "scripts/dashboard.min.js",
+                "filters": "rjsmin",
+            },
+        ],
+    },
+)
+```
+
+## i18n
+FlaskSpark initializes Babel and provides a client-side translation endpoint:
+
+```text
+GET /_flaskspark/i18n?keys=Key%201,Key%202
+```
+
+## Configuration
+Common keys:
+```python
+SECRET_KEY = "..."
+SQLALCHEMY_DATABASE_URI = "sqlite:///instance/app.db"
+APP_BIND_HOST = "0.0.0.0"
+APP_PORT = 5067
+BABEL_DEFAULT_LOCALE = "en"
+BABEL_SUPPORTED_LOCALES = ["en", "de"]
+```
+
+## License
+MIT License. See `LICENSE`.

flaskspark-0.1.0/flaskspark/__init__.py

@@ -0,0 +1,8 @@
+"""
+Initialization for the FlaskSpark package.
+"""
+
+from .app import FlaskSpark, db, migrate, login_manager
+
+# Export key symbols for convenience.
+__all__ = ["FlaskSpark", "db", "migrate", "login_manager"]