Flask-Exts 0.1.7__tar.gz → 0.2.0__tar.gz

{flask_exts-0.1.7 → flask_exts-0.2.0}/CHANGES.rst

@@ -1,9 +1,30 @@
+v0.2.0
+------
+
+Released 2025-01-07
+
+- update templates.macros
+
+v0.1.9
+------
+
+Released 2024-12-01
+
+- add index_view
+
+v0.1.8
+------
+
+Released 2024-11-24
+
+- add user_view
+
 v0.1.7
 ------
 
 Released 2024-10-13
 
-- add theme for templating
+- add theme for template
 - admin view framework
 
 v0.1.6
@@ -14,7 +35,6 @@ Released 2024-09-14
 - merge translations of wtforms, flask_exts and app into flask_babel.get_translations()
 - update FileField and ImageField
 - add url for template.static
-- use namespace ns.bootstrap to control bootstrap's css and js
 
 v0.1.5
 ------

{flask_exts-0.1.7 → flask_exts-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: Flask-Exts
-Version: 0.1.7
+Version: 0.2.0
 Summary: Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
 Project-URL: Documentation, https://flask-exts.readthedocs.io
 Project-URL: Source, https://github.com/ojso/flask-exts
@@ -42,6 +42,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
 Requires-Dist: flask-babel>=4.0
+Requires-Dist: flask-login>=0.6
 Requires-Dist: flask-sqlalchemy>=3.0
 Requires-Dist: flask>=3.0
 Requires-Dist: wtforms>=3.0

flask_exts-0.2.0/docs/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Flask-Exts'
+copyright = '2024, David Dong Hua'
+author = 'David Dong Hua'
+
+# -- General configuration ---------------------------------------------------
+# -- General configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+]
+
+intersphinx_mapping = {
+    "rtd": ("https://docs.readthedocs.io/en/stable/", None),
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+templates_path = ["_templates"]
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

flask_exts-0.1.7/docs/usage.rst → flask_exts-0.2.0/docs/configure.rst

@@ -1,17 +1,6 @@
-=====
-Usage
-=====
-
-.. _installation:
-
-Installation
-==============
-
-To use Flask-Exts, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install flask-exts
+==========
+Configure
+==========
 
 Configuration
 ==============
@@ -23,38 +12,23 @@ Configuration
                            Default is ``None``.
 ``BABEL_DEFAULT_TIMEZONE`` Set to ``Asia/Shanghai`` to babel's default timezone.
                            Default is ``None``.
-``TEMPLATE_ENABLED``       Set to ``False`` to disable templating extension.
+``CSRF_ENABLED``           Set to ``False`` to enable form's CSRF .
                            Default is ``True``.
-``TEMPLATE_THEME``         Set to ``theme`` to create custom theme                           
-                           Default is ``templating.theme.DefaultTheme()``
-``JQUERY_JS_URL``          Set to ``jquery js url`` to active ``jquery``.
-                           Default is in ``jsdelivr``.
-``BOOTSTRAP_CSS_URL``      Set to ``bootstrap css url`` to active ``bootstrap css``.
-                           Default is in ``jsdelivr``.
-``BOOTSTRAP_JS_URL``       Set to ``bootstrap js url`` to active ``bootstrap js``.
-                           Default is in ``jsdelivr``.
-``ICON_SPRITE_URL``        Set to ``icon url`` to active ``icon``.
-                           Default is in ``/template/static/vendor/bootstrap-icons/bootstrap-icons.svg``.
-``CSRF_ENABLED``           Set to ``True`` to enable form's CSRF .
-                           Default is ``False``.
 ``CSRF_SECRET_KEY``        Random data for generating secure tokens.
                            If this is not set then ``SECRET_KEY`` is used.
 ``CSRF_FIELD_NAME``        Name of the form field and session key that holds the CSRF token.
                            Default is ``csrf_token``.
 ``CSRF_TIME_LIMIT``        Max age in seconds for CSRF tokens. 
                            Default is ``1800``. 
+``TEMPLATE_ENABLED``       Set to ``False`` to disable templating extension.
+                           Default is ``True``.
+``TEMPLATE_THEME``         Set to ``theme`` to create custom theme                           
+                           Default is ``template.theme.BootstrapTheme(4)``
+``USER_ENABLED``           Set to ``False`` to disable ``User`` support. 
+                           Default is ``True``. 
+``USER_CENTER``            set to ``user center`` to create custom user_center
+                           Default is ``users.user_center.DefaultUserCenter()``
+``FLASK_LOGIN_ENABLED``    Set to ``False`` to disable ``Flask-Login``. 
+                           Default is ``True``. 
 ========================== =====================================================================
 
-Start
-======
-
-.. code-block:: python
-
-   from flask_exts import Manager
-   from flask import Flask   
-
-   manager = Manager()
-   app = Flask(__name__)
-
-   # init Manager
-   manager.init_app(app)

flask_exts-0.1.7/docs/translation.rst → flask_exts-0.2.0/docs/develop.rst

@@ -1,10 +1,56 @@
-Translations
-============
+=======
+Develop
+=======
 
-src
----
+Install
+=======
 
-pybabel::
+.. code-block:: console
+
+    $ pip install -e .
+    $ pip install -r requirements/develop.in
+
+Test
+====
+Tests are run with `pytest <https://pytest.org/>`_.
+To run the tests, from the project directory:
+
+.. code-block:: console
+
+    # requirements
+    $ pip install -r requirements/test.in    
+
+    # update translation
+    $ pybabel compile -d src/flask_exts/translations -D messages
+    $ pybabel compile -d tests/translations
+    
+    # test
+    $ pytest
+
+Docs
+====
+
+.. code-block:: console
+
+    $ pip install -r docs/requirements.txt
+    $ cd docs
+    $ make html
+
+Publish
+=======
+
+.. code-block:: console
+
+    $ pip install -r requirements/build.in
+    $ python -m build
+
+Translation
+=============
+
+pybabel
+-------------
+
+.. code-block:: console
 
     # extract messages from source files and generate a POT file
     pybabel extract -F babel.cfg -o babel/messages.pot src/
@@ -27,7 +73,7 @@ pybabel::
 tests
 -----
 
-pybabel::
+.. code-block:: console
 
 
     cd tests/
@@ -47,9 +93,4 @@ pybabel::
 
     # compile message catalogs to MO files
 
-    pybabel compile -d translations
-
-
-
-
-
+    pybabel compile -d translations

{flask_exts-0.1.7 → flask_exts-0.2.0}/docs/index.rst

@@ -8,16 +8,33 @@ Welcome to Flask-Exts's documentation!
 
 **Flask-Exts** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
 
+.. _installation:
+
+Installation
+==============
+
+To use Flask-Exts, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install flask-exts
+
+Examples
+===========
+
+``python simple.py`` to run a simple example.
+
+.. literalinclude:: ../examples/simple.py
+  :language: python
+
+More examples, please click :doc:`examples`.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   usage
-   api
-   forms
-   templating
+   configure
    develop
-   translation
    examples
    changes
 

flask_exts-0.2.0/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme

{flask_exts-0.1.7 → flask_exts-0.2.0}/examples/README.rst

@@ -2,7 +2,7 @@
 Examples
 ========================
 
-Install
+Download
 =========
 
 Type these commands in the terminal:
@@ -14,50 +14,50 @@ Type these commands in the terminal:
     $ python3 -m venv venv
     $ source venv/bin/activate
     $ pip install flask-exts
-    
 
-Run the demo applications
-==========================
+Run the examples
+===============================
 
-Type the command in the terminal:
+Type the command in the terminal, then go to http://localhost:5000.
 
-.. code-block:: bash
+Start
+----------
 
-    $ flask --app start run --debug --port=5000
+simple 
+---------
 
-Bootstrap 4
------------------
+run only one file.
 
 .. code-block:: bash
 
-    $ flask --app bootstrap4/app.py run
+    $ python simple.py
 
-Bootstrap 5
+demo
 -----------------
 
+With sqlite db.
+
 .. code-block:: bash
     
-    $ flask --app bootstrap5/app.py run
-
-Now go to http://localhost:5000.
+    $ flask --app demo run --debug --port=5000
 
-admin
+Bootstrap 4
 -----------------
 
 .. code-block:: bash
-    
-    $ flask --app admin/simple run
-
-Now go to http://localhost:5000.
 
+    $ flask --app bootstrap4/app.py run
 
-Overview of icons
+Bootstrap 5
 -----------------
 
-When Bootstrap-Flask updates the icon file, the overview page can be upgraded with:
-
-
 .. code-block:: bash
+    
+    $ flask --app bootstrap5/app.py run
 
-    $ python3 update-icons.py
+fileadmin
+-----------------
 
+.. code-block:: bash
+    
+    $ flask --app admin/fileadmin run

flask_exts-0.2.0/examples/admin/fileadmin/admin_app.py

@@ -0,0 +1,17 @@
+import os.path as op
+from flask_exts.admin import Admin
+from flask_exts.admin.file_admin import LocalFileAdmin
+
+class FileAdmin(LocalFileAdmin):
+    upload_modal = True
+    rename_modal = True
+
+# Create admin interface
+admin = Admin(name="Example: File Admin Views")
+
+# Create file admin view
+path = op.join(op.dirname(__file__), "tmp")
+file_admin_view = FileAdmin(path, name="TmpFiles")
+# file_admin_view.rename_modal=True
+
+admin.add_view(file_admin_view)

{flask_exts-0.1.7 → flask_exts-0.2.0}/examples/bootstrap4/app.py

@@ -6,7 +6,7 @@ from wtforms.validators import DataRequired, Length, Regexp
 from wtforms.fields import *
 from flask_sqlalchemy import SQLAlchemy
 from flask_exts.forms.form import FlaskForm
-from flask_exts.forms.fields.switch import SwitchField
+from flask_exts.forms.fields import SwitchField
 from flask_exts import Manager
 
 manager = Manager()
@@ -32,7 +32,7 @@ class ExampleForm(FlaskForm):
     email = EmailField()
     url = URLField()
     telephone = TelField()
-    image = FileField(render_kw={'class': 'my-class'}, validators=[Regexp('.+\.jpg$')])  # add your class
+    image = FileField(render_kw={'class': 'my-class'}, validators=[Regexp(r'.+\.jpg$')])  # add your class
     option = RadioField(choices=[('dog', 'Dog'), ('cat', 'Cat'), ('bird', 'Bird'), ('alien', 'Alien')])
     select = SelectField(choices=[('dog', 'Dog'), ('cat', 'Cat'), ('bird', 'Bird'), ('alien', 'Alien')])
     select_multiple = SelectMultipleField(choices=[('dog', 'Dog'), ('cat', 'Cat'), ('bird', 'Bird'), ('alien', 'Alien')])

{flask_exts-0.1.7 → flask_exts-0.2.0}/examples/bootstrap4/templates/mybase.html

@@ -6,6 +6,7 @@
 {% block title %}Flask-Exts Bootstrap 4 Demo Application{% endblock %}
 
 {% block styles %}
+{{ super() }}
 <style>
     pre {
         background: #ddd;

{flask_exts-0.1.7 → flask_exts-0.2.0}/examples/bootstrap5/app.py

@@ -7,11 +7,11 @@ from wtforms.fields import *
 from flask_sqlalchemy import SQLAlchemy
 
 from flask_exts.forms.form import FlaskForm
-from flask_exts.forms.fields.switch import SwitchField
+from flask_exts.forms.fields import SwitchField
 from flask_exts import Manager
-from flask_exts.templating.theme import DefaultTheme
+from flask_exts.template.theme import BootstrapTheme
 
-theme = DefaultTheme(bootstrap_version=5)
+theme = BootstrapTheme(version=5)
 
 manager = Manager()
 app = Flask(__name__)
@@ -47,7 +47,7 @@ class ExampleForm(FlaskForm):
     url = URLField()
     telephone = TelField()
     image = FileField(
-        render_kw={"class": "my-class"}, validators=[Regexp(".+\.jpg$")]
+        render_kw={"class": "my-class"}, validators=[Regexp(r".+\.jpg$")]
     )  # add your class
     option = RadioField(
         choices=[("dog", "Dog"), ("cat", "Cat"), ("bird", "Bird"), ("alien", "Alien")]

{flask_exts-0.1.7 → flask_exts-0.2.0}/examples/bootstrap5/templates/mybase.html

@@ -6,6 +6,7 @@
 {% block title %}Flask-Exts Bootstrap 5 Demo Application{% endblock %}
 
 {% block styles %}
+{{ super() }}
 <style>
 pre {
     background: #ddd;

flask_exts-0.2.0/examples/demo/__init__.py

@@ -0,0 +1 @@
+from .make_app import create_app

flask_exts-0.2.0/examples/demo/make_app.py

@@ -0,0 +1,52 @@
+import os.path
+from flask import Flask
+from flask_exts import Manager
+from flask_exts.admin import Admin
+from .models import db
+from .user_center import UserCenter
+from .views.my_view import myview
+
+
+def get_sqlite_path():
+    app_dir = os.path.realpath(os.path.dirname(__file__))
+    database_path = os.path.join(app_dir, "sample.sqlite")
+    return database_path
+
+
+def build_sample_db(app):
+    # db.drop_all()
+    db.create_all()
+    user_center = app.config["USER_CENTER"]
+    user_center.register_user("admin", "admin", "admin@example.com")
+
+
+def create_app():
+    app = Flask(__name__)
+    app.config["SECRET_KEY"] = "dev"
+    # app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
+    app.config["DATABASE_FILE"] = get_sqlite_path()
+    app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///" + app.config["DATABASE_FILE"]
+
+    app.config["USER_CENTER"] = UserCenter()
+
+    init_app(app)
+
+    return app
+
+
+def init_app(app: Flask):
+    from .models import init_db
+
+    init_db(app)
+
+    manager = Manager()
+    manager.init_app(app)
+
+    admin = Admin(name="Demo")
+    admin.init_app(app)
+    admin.add_view(myview)
+
+    if not os.path.exists(app.config["DATABASE_FILE"]):
+        with app.app_context():
+            build_sample_db(app)
+

flask_exts-0.2.0/examples/demo/models/__init__.py

@@ -0,0 +1,16 @@
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy import select
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+db = SQLAlchemy(model_class=Base)
+
+
+def init_db(app):
+    db.init_app(app)
+
+    from . import user

flask_exts-0.2.0/examples/demo/models/user.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+from sqlalchemy.orm import Mapped
+from sqlalchemy.orm import mapped_column
+from flask_login import UserMixin
+from . import db
+
+
+class User(db.Model, UserMixin):
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str]
+    email: Mapped[str]
+    password: Mapped[str]
+    created_at: Mapped[datetime] = mapped_column(default=datetime.now)
+    updated_at: Mapped[datetime] = mapped_column(
+        default=datetime.now, onupdate=datetime.now
+    )

flask_exts-0.2.0/examples/demo/templates/my/index.html

@@ -0,0 +1,6 @@
+{% extends 'admin/master.html' %}
+{% block main %}
+<div>
+    Demo:my:index
+</div>
+{% endblock %}

flask_exts-0.2.0/examples/demo/user_center.py

@@ -0,0 +1,54 @@
+from werkzeug.security import generate_password_hash, check_password_hash
+from flask_exts.users.default_usercenter import DefaultUserCenter
+from .models import db,select
+from .models.user import User
+
+class UserCenter(DefaultUserCenter):
+    user_class = User
+
+    def __init__(self):
+        self.users = []
+
+    def user_loader(self, user_id):
+        user = db.session.get(User, int(user_id))
+        return user
+
+    def get_users(self):
+        stmt = select(User).order_by("id")
+        users = db.session.execute(stmt).scalars()
+        return users
+
+    def get_user_by_id(self, id):
+        user = db.session.get(User, id)
+        return user
+
+    def login_user_by_username_password(self, username, password):
+        stmt = select(User).filter_by(username=username)
+        user = db.session.execute(stmt).scalar()
+        if user is None:
+            return (None, "invalid username")
+        elif not check_password_hash(user.password, password):
+            return (None, "invalid password")
+        else:
+            return (user, None)
+
+    def register_user(self, username, password, email):
+        stmt_filter_username = select(User).filter_by(username=username)
+        user_filter_username = db.session.execute(stmt_filter_username).scalar()
+        if user_filter_username is not None:
+            return (None, "invalid username")
+        
+        stmt_filter_email = select(User).filter_by(email=email)
+        user_filter_email = db.session.execute(stmt_filter_email).scalar()
+        if user_filter_email is not None:
+            return (None, "invalid email")
+        
+        user = self.user_class(username=username)
+        user.password = generate_password_hash(password)
+        user.email = email
+        db.session.add(user)
+        db.session.commit()
+        return (user, None)
+
+    def remove_user(self, user_id):
+        return NotImplemented

flask_exts-0.2.0/examples/demo/views/my_view.py

@@ -0,0 +1,10 @@
+from flask_exts.admin import expose
+from flask_exts.admin import BaseView
+
+
+class MyView(BaseView):
+    @expose("/")
+    def index(self):
+        return self.render("my/index.html")
+    
+myview = MyView(name="MyView") 

flask_exts-0.2.0/examples/simple.py

@@ -0,0 +1,17 @@
+# simple.py
+
+from flask import Flask
+from flask_exts import Manager
+from flask_exts.admin import Admin
+
+app = Flask(__name__)
+app.config["SECRET_KEY"] = "dev"
+# Manager init
+manager = Manager()
+manager.init_app(app)
+# Admin init for index_view and user_view
+admin = Admin()
+admin.init_app(app)
+
+if __name__ == "__main__":
+    app.run(debug=True)

{flask_exts-0.1.7 → flask_exts-0.2.0}/pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "WTForms>=3.0",
     "flask-babel>=4.0",
     "Flask-SQLAlchemy>=3.0",
+    "Flask-Login>=0.6",
 ]
 
 [project.urls]

flask_exts-0.2.0/src/flask_exts/__about__.py

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