Flask-Exts 0.1.0__tar.gz → 0.1.2__tar.gz

{flask_exts-0.1.0 → flask_exts-0.1.2}/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 

flask_exts-0.1.2/.gitignore

@@ -0,0 +1,31 @@
+### vscode
+.vscode
+
+### JupyterNotebooks ###
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Environments
+venv/
+
+# Distribution / packaging
+dist/
+build/
+
+# Unit test / coverage reports
+.cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Translations
+*.mo
+
+# Sphinx documentation
+docs/_build/

flask_exts-0.1.2/.readthedocs.yaml

@@ -0,0 +1,21 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+    
+sphinx:
+  configuration: docs/conf.py
+
+
+
+
+
+

flask_exts-0.1.2/CHANGES.rst

@@ -0,0 +1,20 @@
+v0.1.2
+------
+
+Released 2024-03-22
+
+- .readthedocs.yaml
+
+v0.1.1
+------
+
+Released 2024-03-21
+
+- Init docs
+
+v0.1.0
+------
+
+Released 2024-03-20
+
+- Init release

{flask_exts-0.1.0 → flask_exts-0.1.2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: Flask-Exts
-Version: 0.1.0
+Version: 0.1.2
 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
 Project-URL: Homepage, https://github.com/ojso/flask-exts
-Project-URL: Documentation, https://github.com/ojso/flask-exts
 Project-URL: Issues, https://github.com/ojso/flask-exts/issues
-Project-URL: Source, https://github.com/ojso/flask-exts
 Author-email: huadong <david.dong.hua@gmail.com>
 License: MIT License
         
@@ -41,12 +41,10 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
-Requires-Dist: coverage>=7.0
 Requires-Dist: flask-babel>=4.0
 Requires-Dist: flask-migrate>=4.0
 Requires-Dist: flask-sqlalchemy>=3.0
 Requires-Dist: flask>=3.0
-Requires-Dist: pytest>=7.0
 Requires-Dist: python-dotenv>=1.0
 Requires-Dist: wtforms>=3.0
 Description-Content-Type: text/x-rst
@@ -60,8 +58,7 @@ Flask-Exts is mainly inspired by:
 - `Flask-WTF <https://github.com/wtforms/flask-wtf/>`_
 - `Flask-Admin <https://github.com/flask-admin/flask-admin/>`_
 
-
-Flask-Exts is part rewrited and well tested.
+Flask-Exts is part rewrited from above and well tested.
 
 License
 -------
@@ -76,15 +73,28 @@ Install and update using pip:
 
 .. code-block:: console
 
-    pip install -U Flask-Exts
+    $ pip install -U Flask-Exts
+
+Developing
+-----------
+
+.. code-block:: console
 
-Tests
------
-Tests are run with *pytest*. If you are not familiar with this package you can get some more info from `pytest <https://pytest.org/>`_.
+    $ pip install -e .
 
+Test
+----
+Tests are run with `pytest <https://pytest.org/>`_.
 To run the tests, from the project directory:
 
 .. code-block:: console
 
-    pytest
-    
+    $ pip install -r requirements/test.in
+    $ pytest
+
+Docs
+----
+
+.. code-block:: console
+
+    $ pip install -r docs/requirements.txt

{flask_exts-0.1.0 → flask_exts-0.1.2}/README.rst

@@ -7,8 +7,7 @@ Flask-Exts is mainly inspired by:
 - `Flask-WTF <https://github.com/wtforms/flask-wtf/>`_
 - `Flask-Admin <https://github.com/flask-admin/flask-admin/>`_
 
-
-Flask-Exts is part rewrited and well tested.
+Flask-Exts is part rewrited from above and well tested.
 
 License
 -------
@@ -23,15 +22,28 @@ Install and update using pip:
 
 .. code-block:: console
 
-    pip install -U Flask-Exts
+    $ pip install -U Flask-Exts
+
+Developing
+-----------
+
+.. code-block:: console
 
-Tests
------
-Tests are run with *pytest*. If you are not familiar with this package you can get some more info from `pytest <https://pytest.org/>`_.
+    $ pip install -e .
 
+Test
+----
+Tests are run with `pytest <https://pytest.org/>`_.
 To run the tests, from the project directory:
 
 .. code-block:: console
 
-    pytest
-    
+    $ pip install -r requirements/test.in
+    $ pytest
+
+Docs
+----
+
+.. code-block:: console
+
+    $ pip install -r docs/requirements.txt

flask_exts-0.1.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

flask_exts-0.1.2/docs/api.rst

@@ -0,0 +1,4 @@
+API
+===
+
+

flask_exts-0.1.2/docs/changes.rst

@@ -0,0 +1,4 @@
+Changes
+=======
+
+.. include:: ../CHANGES.rst

flask_exts-0.1.2/docs/conf.py

@@ -0,0 +1,36 @@
+from pallets_sphinx_themes import get_version
+from pallets_sphinx_themes import ProjectLink
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Flask-Exts'
+copyright = '2024, HuaDong'
+author = 'HuaDong'
+release, version = get_version("Flask-Exts")
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.doctest',    
+    'sphinx.ext.autosummary',    
+    "pallets_sphinx_themes",
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'flask'
+html_static_path = ['_static']
+html_title = f"Flask-Exts Documentation ({version})"

flask_exts-0.1.2/docs/index.rst

@@ -0,0 +1,24 @@
+.. Flask-Exts documentation master file, created by
+   sphinx-quickstart on Fri Mar 22 06:29:14 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Flask-Exts's documentation!
+======================================
+
+**Flask-Exts** is a Flask extensions with admin, SQLAlchemy, babel, forms, fields, widgets, and so on.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage
+   api
+   changes
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

flask_exts-0.1.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

flask_exts-0.1.2/docs/requirements.txt

@@ -0,0 +1,3 @@
+# Defining the exact version will make sure things don't break
+sphinx==7.2.6
+Pallets-Sphinx-Themes==2.1.1

flask_exts-0.1.2/docs/usage.rst

@@ -0,0 +1,15 @@
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To use Flask-Exts, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install flask-exts
+
+

{flask_exts-0.1.0 → flask_exts-0.1.2}/pyproject.toml

@@ -31,16 +31,14 @@ dependencies = [
     "flask-babel>=4.0",
     "Flask-SQLAlchemy>=3.0",
     "Flask-Migrate>=4.0",
-    "pytest>=7.0",
-    "coverage>=7.0",
     "python-dotenv>=1.0",
 ]
 
 [project.urls]
+Documentation = "https://flask-exts.readthedocs.io"
+Source = "https://github.com/ojso/flask-exts"
 Homepage = "https://github.com/ojso/flask-exts"
-Documentation = "https://github.com/ojso/flask-exts"
 Issues = "https://github.com/ojso/flask-exts/issues"
-Source = "https://github.com/ojso/flask-exts"
 
 [tool.hatch.version]
 path = "src/flask_exts/__about__.py"

flask_exts-0.1.2/requirements/build.in

@@ -0,0 +1,2 @@
+hatch
+build

flask_exts-0.1.2/requirements/test.in

@@ -0,0 +1,2 @@
+pytest
+coverage

flask_exts-0.1.2/src/flask_exts/__about__.py

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

flask_exts-0.1.0/.gitignore

@@ -1,19 +0,0 @@
-# edit
-.vscode
-.ipynb_checkpoints
-
-# venv/
-/venv/
-
-# Python : Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-.cache/
-.pytest_cache/
-.coverage
-htmlcov/
-dist/
-build/
-docs/_build
-

flask_exts-0.1.0/CHANGES.rst

@@ -1,6 +0,0 @@
-v0.0.1
-------
-
-Released 2024-03-20
-
--   Initial release.

flask_exts-0.1.0/src/flask_exts/__about__.py

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