Flask-Exts 0.3.0__tar.gz → 0.3.1__tar.gz

{flask_exts-0.3.0 → flask_exts-0.3.1}/.gitignore

@@ -33,7 +33,7 @@ docs/_build/
 # sqlite db
 *.sqlite
 
-# npm front-end deps (symlinked into src/flask_exts/static/vendor; install via `npm ci`)
+# npm front-end deps
 node_modules/
 package-lock.json
 

flask_exts-0.3.1/CHANGES.rst

@@ -0,0 +1,39 @@
+v0.3.1
+------
+
+Released 2026-10-11
+
+- Improve SQLAlchemy lifecycle management, session configuration, and in-memory SQLite support.
+- Add reusable modal form flows and improve two-factor authentication setup.
+- Allow extensions to provide admin views for automatic registration, and clarify duplicate extension-name errors.
+
+v0.3.0
+------
+
+Released 2026-10-07
+
+- Add user registration, login, logout, profile management, and user-center views.
+- Add email verification, email change, password reset, and recovery workflows.
+- Add a SQLAlchemy-backed user store with user profiles and role management.
+- Add authentication and role-based authorization.
+- Add TOTP-based two-factor authentication and recovery codes.
+
+v0.2.0
+------
+
+Released 2026-01-07
+
+- Add an extension system with registration, dependency management, and lifecycle hooks.
+- Add an admin interface with model views, CRUD operations, filtering, sorting, pagination, and data export.
+- Add SQLAlchemy integration for database access, model forms, relationships, and queries.
+- Add form fields, widgets, validators, and CSRF protection.
+- Add email delivery and notification support.
+- Add frontend plugin management and Bootstrap-based components.
+- Add Babel integration for localization.
+
+v0.1.0
+------
+
+Released 2024-03-20
+
+- Initial release of the Flask-Exts package and documentation.

{flask_exts-0.3.0 → flask_exts-0.3.1}/Makefile

@@ -9,7 +9,7 @@ docs-serve:
 docs-clean:
 	rm -rf docs/_build
 
-pytest:
+test:
 	pytest
 
 pytest-last:

flask_exts-0.3.1/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.5
+Name: Flask-Exts
+Version: 0.3.1
+Summary: Flask extensions with admin, SQLAlchemy, Babel, forms, fields, widgets, and more.
+Project-URL: Documentation, https://flask-exts.readthedocs.io
+Project-URL: Source, https://github.com/ojso/flask-exts
+Project-URL: Homepage, https://github.com/ojso/flask-exts
+Project-URL: Issues, https://github.com/ojso/flask-exts/issues
+Project-URL: Changelog, https://flask-exts.readthedocs.io/en/latest/changes.html
+Author-email: David Hua <david.dong.hua@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.rst
+Keywords: admin,babel,flask,form,sqlalchemy,widget
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: email-validator>=2.0
+Requires-Dist: flask-babel>=4.0
+Requires-Dist: flask-login>=0.6
+Requires-Dist: flask>=3.0
+Requires-Dist: pyjwt>=2.0
+Requires-Dist: pyotp>=2.0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: tablib>=3.0
+Requires-Dist: wtforms>=3.0
+Provides-Extra: dev
+Requires-Dist: djlint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/x-rst
+
+Flask-Exts
+==========
+
+Flask-Exts is a toolkit for building Flask applications with an integrated
+admin interface, SQLAlchemy support, forms, localization, and user-account
+features. It brings common application components together behind a
+dependency-aware extension system. The project is inspired by
+`Flask-Admin <https://github.com/pallets-eco/flask-admin/>`_ and
+`Bootstrap <https://getbootstrap.com/>`_.
+
+Highlights
+----------
+
+- **Modern frontend:** Uses Bootstrap 5 and native browser APIs, with no
+  jQuery dependency or Bootstrap 4 frontend.
+- **Composable extensions:** Initializes extensions in dependency order and
+  lets extensions contribute views to the admin interface.
+- **Built-in account features:** Provides authentication, email verification
+  and recovery flows, TOTP-based two-factor authentication, and recovery
+  codes.
+- **Integrated admin and data tools:** Includes SQLAlchemy integration,
+  model management, forms, filtering, and data export.
+- **Localization support:** Integrates Babel for translating application
+  interfaces.
+
+Installation
+------------
+
+Flask-Exts requires Python 3.10 or later. Install it with pip:
+
+.. code-block:: console
+
+   pip install flask-exts
+
+Quick start
+-----------
+
+Create a Flask application and initialize the extension manager:
+
+.. code-block:: python
+
+   from flask import Flask
+   from flask_exts import ExtensionManager
+
+   app = Flask(__name__)
+   app.config["SECRET_KEY"] = "change-this-for-local-development"
+   app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///app.sqlite"
+
+   extensions = ExtensionManager()
+   extensions.init_app(app)
+
+   if __name__ == "__main__":
+       app.run(debug=True)
+
+For a complete example with a custom admin view and database setup, see
+``examples/simple``.
+
+Documentation
+-------------
+
+- `Documentation <https://flask-exts.readthedocs.io/>`_
+- `Runnable examples <https://github.com/ojso/flask-exts/tree/main/examples>`_
+- `Changelog <https://flask-exts.readthedocs.io/en/latest/changes.html>`_
+
+License
+-------
+
+Flask-Exts is distributed under the terms of the
+`MIT License <https://opensource.org/licenses/MIT>`_.

flask_exts-0.3.1/README.rst

@@ -0,0 +1,69 @@
+Flask-Exts
+==========
+
+Flask-Exts is a toolkit for building Flask applications with an integrated
+admin interface, SQLAlchemy support, forms, localization, and user-account
+features. It brings common application components together behind a
+dependency-aware extension system. The project is inspired by
+`Flask-Admin <https://github.com/pallets-eco/flask-admin/>`_ and
+`Bootstrap <https://getbootstrap.com/>`_.
+
+Highlights
+----------
+
+- **Modern frontend:** Uses Bootstrap 5 and native browser APIs, with no
+  jQuery dependency or Bootstrap 4 frontend.
+- **Composable extensions:** Initializes extensions in dependency order and
+  lets extensions contribute views to the admin interface.
+- **Built-in account features:** Provides authentication, email verification
+  and recovery flows, TOTP-based two-factor authentication, and recovery
+  codes.
+- **Integrated admin and data tools:** Includes SQLAlchemy integration,
+  model management, forms, filtering, and data export.
+- **Localization support:** Integrates Babel for translating application
+  interfaces.
+
+Installation
+------------
+
+Flask-Exts requires Python 3.10 or later. Install it with pip:
+
+.. code-block:: console
+
+   pip install flask-exts
+
+Quick start
+-----------
+
+Create a Flask application and initialize the extension manager:
+
+.. code-block:: python
+
+   from flask import Flask
+   from flask_exts import ExtensionManager
+
+   app = Flask(__name__)
+   app.config["SECRET_KEY"] = "change-this-for-local-development"
+   app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///app.sqlite"
+
+   extensions = ExtensionManager()
+   extensions.init_app(app)
+
+   if __name__ == "__main__":
+       app.run(debug=True)
+
+For a complete example with a custom admin view and database setup, see
+``examples/simple``.
+
+Documentation
+-------------
+
+- `Documentation <https://flask-exts.readthedocs.io/>`_
+- `Runnable examples <https://github.com/ojso/flask-exts/tree/main/examples>`_
+- `Changelog <https://flask-exts.readthedocs.io/en/latest/changes.html>`_
+
+License
+-------
+
+Flask-Exts is distributed under the terms of the
+`MIT License <https://opensource.org/licenses/MIT>`_.

flask_exts-0.3.1/docs/advanced/database.rst

@@ -0,0 +1,123 @@
+Database
+========
+
+This page documents the database helpers and SQLAlchemy integration used by Flask-Exts.
+
+Overview
+--------
+
+Flask-Exts ships a small SQLAlchemy wrapper, :class:`~flask_exts.datastore.sqla.database.SqlaDb`,
+instead of depending on Flask-SQLAlchemy. A ready-to-use singleton is
+exposed as ``db``::
+
+    from flask_exts.datastore.sqla import db
+
+``db`` is created at import time but stays unbound (``db.engine`` and
+``db.session`` are ``None``) until :meth:`~flask_exts.datastore.sqla.database.SqlaDb.init_app`
+runs -- which happens automatically when the built-in ``database`` extension
+initializes. This two-step lifecycle is what lets model modules do::
+
+    from flask_exts.datastore.sqla import db
+
+    class User(db.Model):
+        __tablename__ = "users"
+        ...
+
+at import time, before any Flask application exists yet.
+
+.. warning::
+
+   ``db`` is a **single-application** singleton. Calling ``init_app()``
+   while it is still bound to an application -- whether that's the same
+   app again or a different one -- raises ``RuntimeError`` rather than
+   silently swapping out ``db.engine``/``db.session``. Call
+   :meth:`~flask_exts.datastore.sqla.database.SqlaDb.dispose` first if you
+   genuinely intend to rebind this instance to a different app (this is
+   how the test suite reuses one ``db`` across many short-lived apps,
+   calling ``dispose()`` in each test's teardown). For a long-running
+   process that serves more than one Flask application at once, create a
+   separate ``SqlaDb()`` instance per application instead.
+
+Configuration
+-------------
+
+.. list-table:: Database configuration options
+   :header-rows: 1
+   :widths: 28 72
+
+   * - Name
+     - Description
+   * - ``SQLALCHEMY_DATABASE_URI``
+     - **Required.** SQLAlchemy connection URL, e.g.
+       ``"sqlite:///app.db"`` or ``"postgresql+psycopg://user:pass@host/db"``.
+       ``init_app()`` raises ``RuntimeError`` if this is unset.
+   * - ``SQLALCHEMY_ECHO``
+     - Set to ``True`` to log every SQL statement. Default is ``False``.
+   * - ``SQLALCHEMY_ENGINE_OPTIONS``
+     - Dict of keyword arguments forwarded to SQLAlchemy's
+       ``create_engine()``. Use this for ``pool_size``, ``pool_recycle``,
+       ``pool_pre_ping``, etc. Takes precedence over the two options above
+       when keys overlap.
+   * - ``SQLALCHEMY_SESSION_OPTIONS``
+     - Dict of keyword arguments forwarded to ``sessionmaker()``, e.g.
+       ``{"expire_on_commit": False}``. Default is ``{}``.
+
+In-memory SQLite
+-----------------
+
+When ``SQLALCHEMY_DATABASE_URI`` points at an in-memory SQLite database
+(``"sqlite://"`` or any URI containing ``":memory:"``), ``init_app()``
+automatically pins the engine to a single shared connection
+(``poolclass=StaticPool``, ``connect_args={"check_same_thread": False}``).
+
+This matters because SQLite's default pooling for in-memory databases hands
+each thread its *own*, separately empty, in-memory database -- so without
+this override, a request served on a different thread than the one that
+created the schema would see no tables at all. This is the same workaround
+Flask-SQLAlchemy applies for this case.
+
+You can override the pool explicitly via ``SQLALCHEMY_ENGINE_OPTIONS`` if
+you need different behavior.
+
+Long-lived connections (MySQL/PostgreSQL)
+------------------------------------------
+
+Database servers often close idle connections after a timeout (MySQL's
+``wait_timeout`` is a common culprit). If your process keeps a connection
+pool open across requests, configure ``pool_pre_ping`` and/or
+``pool_recycle`` to avoid "server has gone away"-style errors::
+
+    app.config["SQLALCHEMY_ENGINE_OPTIONS"] = {
+        "pool_pre_ping": True,
+        "pool_recycle": 280,
+    }
+
+Session scope
+-------------
+
+``db.session`` is a SQLAlchemy ``scoped_session`` keyed on the current Flask
+application context, matching Flask-SQLAlchemy's behavior: accessing
+``db.session`` inside a request (or any ``with app.app_context():`` block)
+always returns the same session object for that context, and a fresh one
+once the context ends. The session is removed automatically via
+``teardown_appcontext``.
+
+Shutdown
+--------
+
+:meth:`~flask_exts.datastore.sqla.database.SqlaDb.dispose` releases the
+session registry and the engine's connection pool, and marks the instance
+unbound again (``db.app`` becomes ``None``), allowing a subsequent
+``init_app()`` call with a different app. It tolerates being called with
+no active application context (e.g. from a shutdown hook that isn't
+running inside a request), in which case it skips removing the session
+registry entry (there's nothing addressable without a context) but still
+disposes the engine.
+
+API reference
+--------------
+
+.. automodule:: flask_exts.datastore.sqla._db
+
+.. automodule:: flask_exts.datastore.sqla.database
+   :members:

{flask_exts-0.3.0 → flask_exts-0.3.1}/pyproject.toml

@@ -5,10 +5,11 @@ build-backend = "hatchling.build"
 [project]
 name = "Flask-Exts"
 dynamic = ["version"]
-description = 'Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.'
+description = "Flask extensions with admin, SQLAlchemy, Babel, forms, fields, widgets, and more."
 readme = "README.rst"
-license = { file = "LICENSE.rst" }
-keywords = ["flask","babel", "admin", "form", "widget", "sql"]
+license = "MIT"
+license-files = ["LICENSE.rst"]
+keywords = ["flask", "admin", "sqlalchemy", "babel", "form", "widget"]
 authors = [
   { name = "David Hua", email = "david.dong.hua@gmail.com" },
 ]
@@ -17,8 +18,9 @@ classifiers = [
   "Environment :: Web Environment",
   "Framework :: Flask",
   "Intended Audience :: Developers",
-  "License :: OSI Approved :: MIT License",
-  "Topic :: Software Development :: Build Tools",
+  "Operating System :: OS Independent",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.10",
@@ -28,40 +30,49 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "Flask>=3.0",
-    "WTForms>=3.0",
-    "SQLAlchemy>=2.0",
-    "flask-babel>=4.0",
-    "Flask-Login>=0.6",
-    "tablib>=3.0",
-    "PyJWT>=2.0",
-    "pyotp>=2.0",
-    "email-validator>=2.0",
+  "Flask>=3.0",
+  "WTForms>=3.0",
+  "SQLAlchemy>=2.0",
+  "flask-babel>=4.0",
+  "Flask-Login>=0.6",
+  "tablib>=3.0",
+  "PyJWT>=2.0",
+  "pyotp>=2.0",
+  "email-validator>=2.0",
 ]
 
+[project.optional-dependencies]
+dev = ["pytest", "djlint", "ruff"]
+
 [project.urls]
 Documentation = "https://flask-exts.readthedocs.io"
 Source = "https://github.com/ojso/flask-exts"
 Homepage = "https://github.com/ojso/flask-exts"
 Issues = "https://github.com/ojso/flask-exts/issues"
-
-[tool.hatch.version]
-path = "src/flask_exts/__about__.py"
+Changelog = "https://flask-exts.readthedocs.io/en/latest/changes.html"
 
 [project.entry-points."flask.commands"]
 security = "flask_exts.commands:security_cli"
 datastore = "flask_exts.commands:datastore_cli"
 
+[tool.hatch.version]
+path = "src/flask_exts/__about__.py"
+source = "code"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/flask_exts"]
+
 [tool.djlint]
-profile="jinja"
-indent=2
-no_indent_inner_html=true
-max_attribute_length=180
-max_line_length=180
-sort_attributes=true
-preserve_blank_lines=true
-ignore="T003"
+profile = "jinja"
+indent = 2
+no_indent_inner_html = true
+max_attribute_length = 180
+max_line_length = 180
+sort_attributes = true
+preserve_blank_lines = true
+ignore = "T003"
 
 [tool.pytest.ini_options]
+minversion = "8.0"
 testpaths = ["tests"]
-addopts = "-ra"
+addopts = "-ra --strict-markers --strict-config"

flask_exts-0.3.1/src/flask_exts/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.3.1"

{flask_exts-0.3.0 → flask_exts-0.3.1}/src/flask_exts/admin/model/filter_mixin.py

@@ -119,7 +119,6 @@ class FilterMixin:
             name:
                 Name of the field
         """
-        return None
 
     def _get_filter_arg(self, index, flt):
         """
@@ -148,8 +147,8 @@ class FilterMixin:
 
         if active_filters:
             for i, pair in enumerate(active_filters):
-                idx, flt_name, value = pair
-                key = "flt%d_%s" % (i, self._get_filter_arg(idx, self._filters[idx]))
+                idx, _flt_name, value = pair
+                key = f"flt{i}_{self._get_filter_arg(idx, self._filters[idx])}"
                 kwargs[key] = value
 
         return kwargs

{flask_exts-0.3.0 → flask_exts-0.3.1}/src/flask_exts/admin/model/view.py

@@ -10,8 +10,8 @@ from flask import (
 )
 from flask_babel import gettext, ngettext
 
-from ..exposer import expose_url
 from ...security.urls import safe_redirect_target
+from ..exposer import expose_url
 from .base import BaseModelView
 from .type_formatters import BASE_FORMATTERS, DETAIL_FORMATTERS, EXPORT_FORMATTERS
 
@@ -315,17 +315,16 @@ class ModelView(BaseModelView):
 
         form = self._edit_form_class(obj=model)
 
-        if form.validate_on_submit():
-            if self.update_model(form, model):
-                flash(gettext("Record was successfully saved."), "success")
-                if "_add_another" in request.form:
-                    return redirect(self.get_url(".create_view", url=return_url))
-                elif "_continue_editing" in request.form:
-                    return redirect(
-                        self.get_url(".edit_view", id=self.get_pk_value(model))
-                    )
-                else:
-                    return redirect(self.get_save_return_url(model, is_created=False))
+        if form.validate_on_submit() and self.update_model(form, model):
+            flash(gettext("Record was successfully saved."), "success")
+            if "_add_another" in request.form:
+                return redirect(self.get_url(".create_view", url=return_url))
+            elif "_continue_editing" in request.form:
+                return redirect(
+                    self.get_url(".edit_view", id=self.get_pk_value(model))
+                )
+            else:
+                return redirect(self.get_save_return_url(model, is_created=False))
 
         form_opts = {"widget_args": self.form_widget_args}
 

{flask_exts-0.3.0 → flask_exts-0.3.1}/src/flask_exts/builtin_extensions/__init__.py

@@ -4,8 +4,8 @@ from .database_ext import DatabaseExtension
 from .emailer_ext import EmailerExtension
 from .frontend_ext import FrontendExtension
 from .login_ext import LoginExtension
+from .portal_ext import PortalExtension
 from .security_ext import SecurityExtension
-from .startup_ext import StartupExtension
 from .usercenter_ext import UserCenterExtension
 from .userstore_ext import UserStoreExtension
 
@@ -19,7 +19,7 @@ BUILTIN_EXTENSIONS = (
     UserCenterExtension,
     UserStoreExtension,
     AdminExtension,
-    StartupExtension,
+    PortalExtension,
 )
 
 

flask_exts-0.3.1/src/flask_exts/builtin_extensions/portal_ext.py

@@ -0,0 +1,14 @@
+from ..extension_core.base import Extension
+from ..portal.index_view import IndexView
+
+
+class PortalExtension(Extension):
+    @property
+    def name(self) -> str:
+        return "portal"
+
+    def init_app(self, app):
+        pass
+
+    def get_admin_views(self):
+        return [(IndexView(), False)]

flask_exts-0.3.1/src/flask_exts/builtin_extensions/security_ext.py

@@ -0,0 +1,24 @@
+from ..extension_core.base import Extension
+from ..security.core import Security
+from ..signals import user_registered
+
+
+class SecurityExtension(Extension):
+    @property
+    def name(self) -> str:
+        return "security"
+
+    def init_app(self, app):
+        self._security = Security()
+        self._security.init_app(app)
+        self._subscribe_signals(app)
+
+    def get_security(self):
+        return self._security
+
+    def _subscribe_signals(self, app):
+        @user_registered.connect_via(app)
+        def on_user_registered(sender, user, **extra):
+            """Send an email-verification token to freshly registered users."""
+            if user.email and not user.email_verified:
+                self._security.get_plugin("email_verification").send_token(user)

{flask_exts-0.3.0 → flask_exts-0.3.1}/src/flask_exts/builtin_extensions/usercenter_ext.py

@@ -8,15 +8,9 @@ class UserCenterExtension(Extension):
     def name(self) -> str:
         return "usercenter"
 
-    @property
-    def dependencies(self) -> list[str]:
-        return ["admin"]
-
     def init_app(self, app):
         self._usercenter = UserCenter()
         self._usercenter.init_app(app)
-        self.register_views(app)
 
-    def register_views(self, app):
-        admin = app.extensions["exts"].get_extension("admin").get_admin()
-        admin.register_view(UserView(), is_menu=False)
+    def get_admin_views(self):
+        return [(UserView(), False)]