Transition to pyproject.toml

Author: Dev-iL

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
           pip install --upgrade pip
           pip install -r requirements/dev.txt
       - name: black
-        run: black --check setup.py flask_appbuilder
+        run: black --check flask_appbuilder
       - name: flake8
         run: flake8 flask_appbuilder
       - name: mypy

MANIFEST.in

@@ -15,6 +15,6 @@ Release protocol
 
 7 - checkout and pull master branch
 
-8 - Upload package to Pypi: `python setup.py sdist upload`
+8 - Upload package to PyPI: `python -m build && twine upload dist/*`
 
 9 - Update readthedocs with the new master version

RELEASE.rst

@@ -1,6 +1,13 @@
 __author__ = "Daniel Vaz Gaspar"
 __version__ = "5.2.0"
 
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("Flask-AppBuilder")
+except PackageNotFoundError:
+    pass
+
 from .actions import action  # noqa: F401
 from .api import ModelRestApi  # noqa: F401
 from .base import AppBuilder  # noqa: F401

flask_appbuilder/__init__.py

@@ -158,7 +158,7 @@ def _get_chart_widget(
         direct=None,
         height=None,
         definition="",
-        **args
+        **args,
     ):
         height = height or self.height
         widgets = widgets or dict()
@@ -186,7 +186,7 @@ def _get_chart_widget(
             height=height,
             value_columns=value_columns,
             modelview_name=self.__class__.__name__,
-            **args
+            **args,
         )
         return widgets
 
@@ -290,7 +290,7 @@ def _get_chart_widget(
         widgets=None,
         group_by=None,
         height=None,
-        **args
+        **args,
     ):
         height = height or self.height
         widgets = widgets or dict()
@@ -308,7 +308,7 @@ def _get_chart_widget(
             height=height,
             value_columns=value_columns,
             modelview_name=self.__class__.__name__,
-            **args
+            **args,
         )
         return widgets
 
@@ -344,7 +344,7 @@ def _get_chart_widget(
         widgets=None,
         direct=None,
         height=None,
-        **args
+        **args,
     ):
         height = height or self.height
         widgets = widgets or dict()
@@ -367,7 +367,7 @@ def _get_chart_widget(
             height=height,
             value_columns=value_columns,
             modelview_name=self.__class__.__name__,
-            **args
+            **args,
         )
         return widgets
 
@@ -427,7 +427,7 @@ def _get_chart_widget(
         group_by=None,
         period=None,
         height=None,
-        **args
+        **args,
     ):
         height = height or self.height
         widgets = widgets or dict()
@@ -451,7 +451,7 @@ def _get_chart_widget(
             height=height,
             value_columns=value_columns,
             modelview_name=self.__class__.__name__,
-            **args
+            **args,
         )
         return widgets
 

flask_appbuilder/charts/views.py

@@ -33,7 +33,7 @@ def __init__(
         datamodel=None,
         col_name=None,
         is_related=True,
-        **kwargs
+        **kwargs,
     ):
         super(AJAXSelectField, self).__init__(label, validators, **kwargs)
         self.datamodel = datamodel
@@ -95,7 +95,7 @@ def __init__(
         get_label=None,
         allow_blank=False,
         blank_text="",
-        **kwargs
+        **kwargs,
     ):
         super(QuerySelectField, self).__init__(label, validators, **kwargs)
         self.query_func = query_func
@@ -281,7 +281,7 @@ def coerce(value):
             default=default,
             coerce=coerce,
             choices=choices,
-            **kwargs
+            **kwargs,
         )
 
     def pre_validate(self, form):

flask_appbuilder/fields.py

@@ -26,7 +26,7 @@ def __init__(
         namegen=None,
         allowed_extensions=None,
         permission=0o755,
-        **kwargs
+        **kwargs,
     ):
         if "UPLOAD_FOLDER" in current_app.config and not base_path:
             base_path = current_app.config["UPLOAD_FOLDER"]
@@ -91,7 +91,7 @@ def __init__(
         thumbgen=None,
         thumbnail_size=None,
         permission=0o755,
-        **kwargs
+        **kwargs,
     ):
         # Check if PIL is installed
         if Image is None:
@@ -123,7 +123,7 @@ def __init__(
             namegen=namegen,
             allowed_extensions=allowed_extensions,
             permission=permission,
-            **kwargs
+            **kwargs,
         )
 
     def get_url(self, filename):

flask_appbuilder/filemanager.py

@@ -66,7 +66,7 @@ def link_order_filter(self, column, modelview_name):
             args["_od_" + modelview_name] = "asc"
         return url_for(
             request.endpoint,
-            **dict(list(new_args.items()) + list(args.to_dict().items()))
+            **dict(list(new_args.items()) + list(args.to_dict().items())),
         )
 
     @app_template_filter("link_page")
@@ -79,7 +79,7 @@ def link_page_filter(self, page, modelview_name):
         args["page_" + modelview_name] = page
         return url_for(
             request.endpoint,
-            **dict(list(new_args.items()) + list(args.to_dict().items()))
+            **dict(list(new_args.items()) + list(args.to_dict().items())),
         )
 
     @app_template_filter("link_page_size")
@@ -92,7 +92,7 @@ def link_page_size_filter(self, page_size, modelview_name):
         args["psize_" + modelview_name] = page_size
         return url_for(
             request.endpoint,
-            **dict(list(new_args.items()) + list(args.to_dict().items()))
+            **dict(list(new_args.items()) + list(args.to_dict().items())),
         )
 
     @app_template_filter("get_link_next")

flask_appbuilder/filters.py

@@ -0,0 +1,141 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "Flask-AppBuilder"
+dynamic = ["version"]
+description = "Simple and rapid application development framework, built on top of Flask. includes detailed security, auto CRUD generation for your models, google charts and much more."
+readme = "README.rst"
+license = "BSD-3-Clause"
+requires-python = ">=3.9"
+authors = [
+    { name = "Daniel Vaz Gaspar", email = "danielvazgaspar@gmail.com" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "apispec[yaml]>=6.0.0, <7",
+    "colorama>=0.3.9, <1",
+    "click>=8, <9",
+    "email_validator>=1.0.5",
+    "Flask>=2, <4",
+    "Flask-Babel>=3, <5",
+    "Flask-Limiter>3, <4",
+    "Flask-Login>=0.3, <0.7",
+    "Flask-SQLAlchemy>=2.4.0, <4",
+    "Flask-WTF>=0.14.2, <2",
+    "Flask-JWT-Extended>=4.0.0, <5.0.0",
+    "jsonschema>=3, <5",
+    "marshmallow>=3.18.0, <5",
+    "marshmallow-sqlalchemy>=0.22.0, <3.0.0",
+    "python-dateutil>=2.3, <3",
+    "prison>=0.2.1, <1.0.0",
+    "PyJWT>=2.0.0, <3.0.0",
+    "SQLAlchemy>=1.4.0, <3",
+    "sqlalchemy-utils>=0.32.21, <1",
+    "WTForms<4",
+    "werkzeug<4",
+]
+
+[project.optional-dependencies]
+jmespath = ["jmespath>=0.9.5"]
+oauth = ["Authlib>=0.14, <2.0.0"]
+saml = ["python3-saml>=1.15.0"]
+talisman = ["flask-talisman>=1.0.0, <2.0"]
+
+[project.urls]
+Homepage = "https://github.com/dpgaspar/flask-appbuilder/"
+
+[project.entry-points."flask.commands"]
+fab = "flask_appbuilder.cli:fab"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["flask_appbuilder*"]
+
+[tool.setuptools.package-data]
+flask_appbuilder = [
+    "static/**/*",
+    "templates/**/*",
+    "translations/**/*",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "flask_appbuilder.__version__" }
+
+[tool.mypy]
+follow_imports = "skip"
+ignore_missing_imports = true
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.validators"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.base"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.cli"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.models.sqla"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.models.sqla.interface"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.models.sqla.base"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[[tool.mypy.overrides]]
+module = "flask_appbuilder.api.convert"
+ignore_errors = false
+check_untyped_defs = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+warn_unused_ignores = false
+
+[tool.coverage.run]
+source = ["flask_appbuilder"]

pyproject.toml

@@ -1,13 +1,12 @@
 echo #
-echo Removing old dist files
+echo Removing old build artifacts
 echo #
-rm -Rf ./dist
+rm -Rf ./dist ./build
 echo #
 echo Generating dist
 echo #
-python setup.py clean --all sdist bdist_wheel
+python -m build
 echo #
 echo Upload to Pypi
 echo #
 twine upload dist/*
-