bisslog-flask 0.0.1__tar.gz

bisslog_flask-0.0.1/.github/workflows/publish-pypi.yml

@@ -0,0 +1,66 @@
+name: Deploy to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  run-changes-reception:
+    uses: darwinhc/bisslog-flask/.github/workflows/receive-changes.yml@master
+
+  determine-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.set-version.outputs.VERSION }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools_scm
+
+      - name: Determine version for TestPyPI
+        id: set-version
+        run: |
+          VERSION=$(python -c "import setuptools_scm; print(setuptools_scm.get_version(version_scheme='post-release', local_scheme='no-local-version'))")
+          VERSION=$(echo "$VERSION" | sed -E 's/\.post([0-9]+)/.\1.${{ github.run_number }}/')
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: [run-changes-reception, determine-version]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine setuptools_scm
+      - name: Printing version to build
+        run: echo ${{ needs.determine-version.outputs.version }}
+
+      - name: Build package with correct version
+        run: |
+          python -m build
+        env:
+          SETUPTOOLS_SCM_PRETEND_VERSION: ${{ needs.determine-version.outputs.version }}
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

bisslog_flask-0.0.1/.github/workflows/publish-test-pypi.yml

@@ -0,0 +1,76 @@
+name: Deploy to TestPyPI
+
+on:
+  push:
+    branches:
+      - qa
+    paths:
+      - "bisslog_flask/**"
+      - "pyproject.toml"
+
+jobs:
+  run-changes-reception:
+    uses: darwinhc/bisslog-flask/.github/workflows/receive-changes.yml@master
+
+  determine-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.set-version.outputs.VERSION }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools_scm
+
+      - name: Determine version for TestPyPI
+        id: set-version
+        run: |
+          VERSION=$(python -c "import setuptools_scm; print(setuptools_scm.get_version(version_scheme='post-release', local_scheme='no-local-version'))")
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: [run-changes-reception, determine-version]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine setuptools_scm
+      - name: Printing version to build
+        run: echo ${{ needs.determine-version.outputs.version }}
+
+      - name: Build package with correct version
+        run: |
+          python -m build
+        env:
+          SETUPTOOLS_SCM_PRETEND_VERSION: ${{ needs.determine-version.outputs.version }}
+
+      - name: Publish to TestPyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        run: twine upload --skip-existing --verbose --repository testpypi dist/*
+
+      - name: Install from TestPyPI to verify
+        run: |
+          python -m venv test_env
+          source test_env/bin/activate
+          python -m pip install --index-url https://test.pypi.org/simple/ --no-deps bisslog_flask==${{ needs.determine-version.outputs.version }}
+          deactivate

bisslog_flask-0.0.1/.github/workflows/receive-changes.yml

@@ -0,0 +1,29 @@
+name: Analyze new changes
+
+on:
+  push:
+    branches:
+      - 'feature/**'
+      - 'fix/**'
+      - 'hotfix/**'
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  run-tests:
+    uses: darwinhc/bisslog-core-py/.github/workflows/pytest.yml@master
+    with:
+      coverage_threshold: ${{ vars.TEST_COVERAGE_THRESHOLD }}
+      target_folder: "bisslog_flask"
+
+  run-linter:
+    uses: darwinhc/bisslog-core-py/.github/workflows/pylint.yml@master
+    with:
+      pylint_threshold: ${{ vars.PYLINT_THRESHOLD }}
+      target_folder: "bisslog_flask"
+
+  run-complexity:
+    uses: darwinhc/bisslog-core-py/.github/workflows/radon.yml@master
+    with:
+      radon_threshold: ${{ vars.RADON_THRESHOLD }}
+      target_folder: "bisslog_flask"

bisslog_flask-0.0.1/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+.todo/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

bisslog_flask-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Darwin Herrera C.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bisslog_flask-0.0.1/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: bisslog_flask
+Version: 0.0.1
+Summary: It is an extension of the bisslog library to support processes with flask
+Author-email: Darwin Stiven Herrera Cartagena <darwinsherrerac@gmail.com>
+Project-URL: Homepage, https://github.com/darwinhc/bisslog-flask
+Keywords: hexagonal,adapters,bisslog,flask
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bisslog>=0.0.7
+Requires-Dist: bisslog-schema>=0.0.3
+Requires-Dist: flask
+Provides-Extra: websocket
+Requires-Dist: flask-socketio; extra == "websocket"
+Provides-Extra: cors
+Requires-Dist: flask-cors>=6.0.0; extra == "cors"
+Dynamic: license-file
+
+
+# bisslog-flask
+
+[![PyPI](https://img.shields.io/pypi/v/bisslog-flask)](https://pypi.org/project/bisslog-flask/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**bisslog-flask** is an extension of the bisslog library to support processes with Flask. It enables dynamic HTTP and WebSocket route registration from use case metadata, allowing developers to build clean, modular, and metadata-driven APIs with minimal boilerplate.
+
+Part of the bisslog ecosystem, it is designed to work seamlessly with domain-centric architectures like Hexagonal or Clean Architecture.
+
+## Features
+
+- 🔁 Dynamic route registration for HTTP and WebSocket triggers
+
+- 🧠 Metadata-driven setup – use YAML or JSON to declare your use cases
+
+- 🔒 Automatic CORS per endpoint using flask-cors
+
+- 🔌 Extensible resolver pattern – plug in your own processor
+
+- ⚙️ Mapper integration – maps HTTP request parts to domain function arguments
+
+
+
+## 📦 Installation
+
+~~~shell
+pip install bisslog-flask
+~~~
+
+
+
+
+## 🚀 Quickstart
+
+### Programmatically
+
+if you want to configure the app before bisslog touches it
+~~~python
+from flask import Flask
+from bisslog_flask import BisslogFlask
+
+app = Flask(__name__)
+BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases",
+    app=app
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+~~~
+
+or
+
+~~~python
+from bisslog_flask import BisslogFlask
+
+app = BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases"
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+~~~
+
+
+
+## 🔧 How It Works
+
+1. Loads metadata and discovers use case functions (or callables), then uses resolvers to register routes dynamically into a Flask app.
+
+
+## 🔐 CORS Handling
+
+CORS is applied only when allow_cors: true is specified in the trigger
+
+Fully dynamic: works even with dynamic Flask routes like /users/<id>
+
+Powered by `@cross_origin` from `flask-cors`
+
+
+## ✅ Requirements
+
+Python ≥ 3.7
+
+Flask ≥ 2.0
+
+bisslog-schema ≥ 0.0.3
+
+flask-cors
+
+(Optional) flask-socketio if using WebSocket triggers
+
+
+## 🧪 Testing Tip
+
+You can test the generated Flask app directly with `app.test_client()` if you take the programmatic way:
+
+```python
+from bisslog_flask import BisslogFlask
+
+def test_user_create():
+    app = BisslogFlask(metadata_file="metadata.yml", use_cases_folder_path="src/use_cases")
+    client = app.test_client()
+    response = client.post("/user", json={"name": "Ana", "email": "ana@example.com"})
+    assert response.status_code == 200
+```
+
+Not generating code or using the programmatic way you just need to test your use cases.
+
+
+
+## 📜 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+
+

bisslog_flask-0.0.1/README.md

@@ -0,0 +1,120 @@
+
+# bisslog-flask
+
+[![PyPI](https://img.shields.io/pypi/v/bisslog-flask)](https://pypi.org/project/bisslog-flask/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**bisslog-flask** is an extension of the bisslog library to support processes with Flask. It enables dynamic HTTP and WebSocket route registration from use case metadata, allowing developers to build clean, modular, and metadata-driven APIs with minimal boilerplate.
+
+Part of the bisslog ecosystem, it is designed to work seamlessly with domain-centric architectures like Hexagonal or Clean Architecture.
+
+## Features
+
+- 🔁 Dynamic route registration for HTTP and WebSocket triggers
+
+- 🧠 Metadata-driven setup – use YAML or JSON to declare your use cases
+
+- 🔒 Automatic CORS per endpoint using flask-cors
+
+- 🔌 Extensible resolver pattern – plug in your own processor
+
+- ⚙️ Mapper integration – maps HTTP request parts to domain function arguments
+
+
+
+## 📦 Installation
+
+~~~shell
+pip install bisslog-flask
+~~~
+
+
+
+
+## 🚀 Quickstart
+
+### Programmatically
+
+if you want to configure the app before bisslog touches it
+~~~python
+from flask import Flask
+from bisslog_flask import BisslogFlask
+
+app = Flask(__name__)
+BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases",
+    app=app
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+~~~
+
+or
+
+~~~python
+from bisslog_flask import BisslogFlask
+
+app = BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases"
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+~~~
+
+
+
+## 🔧 How It Works
+
+1. Loads metadata and discovers use case functions (or callables), then uses resolvers to register routes dynamically into a Flask app.
+
+
+## 🔐 CORS Handling
+
+CORS is applied only when allow_cors: true is specified in the trigger
+
+Fully dynamic: works even with dynamic Flask routes like /users/<id>
+
+Powered by `@cross_origin` from `flask-cors`
+
+
+## ✅ Requirements
+
+Python ≥ 3.7
+
+Flask ≥ 2.0
+
+bisslog-schema ≥ 0.0.3
+
+flask-cors
+
+(Optional) flask-socketio if using WebSocket triggers
+
+
+## 🧪 Testing Tip
+
+You can test the generated Flask app directly with `app.test_client()` if you take the programmatic way:
+
+```python
+from bisslog_flask import BisslogFlask
+
+def test_user_create():
+    app = BisslogFlask(metadata_file="metadata.yml", use_cases_folder_path="src/use_cases")
+    client = app.test_client()
+    response = client.post("/user", json={"name": "Ana", "email": "ana@example.com"})
+    assert response.status_code == 200
+```
+
+Not generating code or using the programmatic way you just need to test your use cases.
+
+
+
+## 📜 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+
+

bisslog_flask-0.0.1/bisslog_flask/__init__.py

@@ -0,0 +1,26 @@
+"""
+bisslog_flask
+
+An extension of the `bisslog` library to support service orchestration via Flask.
+
+This package enables dynamic registration of HTTP and WebSocket routes in a Flask
+application, using declarative metadata (YAML/JSON). It promotes clean separation
+between application logic and infrastructure concerns, aligning with hexagonal
+or clean architecture principles.
+
+
+Requirements
+------------
+- Flask >= 2.0
+- bisslog-schema >= 0.0.3
+- flask-cors
+- (optional) flask-socketio for WebSocket integration
+
+License
+-------
+MIT © Darwin Stiven Herrera Cartagena
+"""
+from .initializer.init_flask_app_manager import BisslogFlask
+from .socket_helper.socket_helper import BisslogFlaskSocketHelper
+
+__all__ = ["BisslogFlask", "BisslogFlaskSocketHelper"]