Merge pull request #44 from LeanderCS/31

Finalize version 0.4.0 and update docs

Author: LeanderCS

.github/workflows/deploy-docs.yaml

@@ -23,7 +23,7 @@ jobs:
           python-version: '3.x'
 
       - name: Install Dependencies
-        run: pip install sphinx sphinx_rtd_theme
+        run: pip install sphinx sphinx_rtd_theme sphinx_design
 
       - name: Build Documentation
         run: sphinx-build -b html docs/source/ _build

.github/workflows/test-lib-building.yaml

@@ -1,10 +1,6 @@
 name: Build and Test Library
 
-on:
-  push:
-    branches:
-      - main
-  pull_request:
+on: [push]
 
 jobs:
   build-and-test-pure:
@@ -28,16 +24,29 @@ jobs:
         id: build
 
       - name: Install built library
-        run: pip install "$(ls dist/*.tar.gz | head -n 1)[optional]"
+        run: | 
+          pip install "$(ls dist/*.tar.gz | head -n 1)[optional]"
+          rm -rf flask_inputfilter
 
-      - name: Verify library usage - Part I
+      - name: Verify library usage - Part I - installation
         run: |
           python -c "import flask_inputfilter.InputFilter"
           python -c "from flask_inputfilter import InputFilter"
 
-      - name: Verify library usage - Part II
+      - name: Verify library usage - Part II - functional test
         run: pytest tests/
 
+      - name: Verify library usage - Part III - correct version
+        run: |
+          output=$(python -c "from flask_inputfilter import InputFilter; print(InputFilter)")
+
+          if [ "$output" = "<class 'flask_inputfilter.InputFilter.InputFilter'>" ]; then
+            echo "Test passed: Correct class returned"
+          else
+            echo "Test failed: Unexpected output - $output"
+            exit 1
+          fi
+
   build-and-test-cython:
     runs-on: ubuntu-latest
 
@@ -59,12 +68,40 @@ jobs:
         id: build
 
       - name: Install built library
-        run: pip install "$(ls dist/*.tar.gz | head -n 1)[optional]"
+        run: | 
+          pip install "$(ls dist/*.tar.gz | head -n 1)[optional]"
+          rm -rf flask_inputfilter
 
-      - name: Verify library usage - Part I
+      - name: Verify library usage - Part I - installation
         run: |
           python -c "import flask_inputfilter.InputFilter"
           python -c "from flask_inputfilter import InputFilter"
 
-      #- name: Verify library usage - Part II
-      #  run: pytest tests/
+      - name: Verify library usage - Part II - functional test
+        run: pytest tests/
+
+      - name: Verify library usage - Part III - correct version
+        run: |
+          output=$(python -c "from flask_inputfilter import InputFilter; print(InputFilter)")
+
+          if [ "$output" = "<class 'flask_inputfilter._InputFilter.InputFilter'>" ]; then
+            echo "Test passed: Correct class returned"
+          else
+            echo "Test failed: Unexpected output - $output"
+            exit 1
+          fi
+          
+          # Creates and uses compiled file instead of pyximport
+          
+          module_path=$(python -c "import flask_inputfilter; print(flask_inputfilter.__file__)")
+
+          module_dir=$(dirname "$module_path")
+          
+          so_files=$(find "$module_dir" -maxdepth 1 -name "*.so")
+          
+          if [ -n "$so_files" ]; then
+            echo ".so-files found:"
+            echo "$so_files"
+          else
+            echo "No .so-files found."
+          fi

MANIFEST.in

@@ -3,3 +3,4 @@ include LICENSE
 include docs/source/changelog.rst
 recursive-include flask_inputfilter *.py *.pyx *.c *.cpp
 prune tests
+recursive-prune __pycache__

README.rst

@@ -67,6 +67,7 @@ Definition
 
     class UpdateZipcodeInputFilter(InputFilter):
         def __init__(self):
+            super().__init__()
 
             self.add(
                 'id',

docs/source/changelog.rst

@@ -3,6 +3,15 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+[0.4.0] - 2025-04-20
+--------------------
+
+Added
+^^^^^
+- Added possibility to use ``cython`` for performance improvements.
+  View :doc:`the guide <guides/compile>` for more information.
+
+
 [0.4.0a2] - 2025-04-17
 ----------------------
 

docs/source/conf.py

@@ -1,9 +1,9 @@
 project = "flask-inputfilter"
 copyright = "2025, Leander Cain Slotosch"
 author = "Leander Cain Slotosch"
-release = "0.4.0a2"
+release = "0.4.0"
 
-extensions = ["sphinx_rtd_theme"]
+extensions = ["sphinx_rtd_theme", "sphinx_design"]
 
 templates_path = []
 exclude_patterns = []

docs/source/guides/compile.rst

@@ -0,0 +1,76 @@
+Use compiled version
+====================
+
+By default the pure python version of the lib is used as a fallback.
+Using the compiled version is not mandatory but highly advised and
+will give you a performance boost.
+
+Getting started
+---------------
+
+To use the compiled version you will first need the cython module,
+you can install the corresponding version by also installing the
+``[compile]`` dependencies of the library.
+
+.. code-block:: bash
+
+    pip install flask-inputfilter[compile]
+
+Secondly, you will need the c++ compiler.
+
+Normally this is already installed on your system, but if not,
+depending on your os, you can use:
+
+.. grid:: 1
+    :gutter: 2
+
+    .. grid-item::
+        .. card:: Linux
+
+            Install the gcc compiler using apt.
+
+            .. code-block:: bash
+
+                sudo apt install g++
+
+    .. grid-item::
+        .. card:: MacOS
+
+            Either install the Xcode command line tools or use homebrew:
+
+            .. code-block:: bash
+
+                xcode-select --install g++
+
+            .. code-block:: bash
+
+                brew install g++
+
+    .. grid-item::
+        .. card:: Windows
+
+            1. Download MinGW:
+                https://www.mingw-w64.org
+            2. Install and add ``g++.exe`` to PATH.
+
+If you have the c++ compiler installed and reinstall the library,
+with or without the ``[compile]`` flag, depending if you already installed it,
+it will automatically compile the files, that offer an optimized version.
+
+After these steps you can use the library normally and should not get the warning in the console.
+
+Verify Installation
+-------------------
+
+If you followed the steps above, you should not see the warning message in the console.
+
+Additionally, you can verify if the compiled versions are
+being used by running the following commands:
+
+.. code-block:: bash
+
+    python -c "import flask_inputfilter"
+    python -c "InputFilter"
+
+If the result is ``<class 'flask_inputfilter._InputFilter.InputFilter'>``,
+the compiled version is being used.

docs/source/guides/index.rst

@@ -7,3 +7,4 @@ Guides
 
     create_own_components
     frontend_validation
+    compile

docs/source/index.rst

@@ -33,7 +33,7 @@ Available functions:
 
 .. note::
 
-    If you like the project, please consider giving it a star on GitHub.
+    If you like the project, please consider giving it a star on `GitHub <https://github.com/LeanderCS/flask-inputfilter>`_.
 
 Installation
 ------------

env_configs/cython.Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.7-slim
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y g++ python3-dev git
+RUN apt-get update && apt-get install -y g++ git
 
 COPY pyproject.toml /app