oe-python-template-example 0.2.10__py3-none-any.whl → 0.2.12__py3-none-any.whl

oe_python_template_example/api.py

@@ -41,7 +41,7 @@ def get_service() -> Generator[Service, None, None]:
         pass
 
 
-api = FastAPI(
+app = FastAPI(
     root_path="/api",
     title=TITLE,
     contact={
@@ -177,5 +177,5 @@ async def echo_v2(request: Utterance) -> Echo:
     return Service.echo(request)
 
 
-api.mount("/v1", api_v1)
-api.mount("/v2", api_v2)
+app.mount("/v1", api_v1)
+app.mount("/v2", api_v2)

oe_python_template_example/cli.py

@@ -66,7 +66,7 @@ def serve(
     os.environ["UVICORN_HOST"] = host
     os.environ["UVICORN_PORT"] = str(port)
     uvicorn.run(
-        "oe_python_template_example.api:api",
+        "oe_python_template_example.api:app",
         host=host,
         port=port,
         reload=watch,

{oe_python_template_example-0.2.10.dist-info → oe_python_template_example-0.2.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.2.10
+Version: 0.2.12
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/
@@ -126,19 +126,20 @@ Projects generated with this template come with a comprehensive development tool
 7. CI/CD pipeline automated with [GitHub Actions](https://github.com/features/actions)
 8. CI/CD pipeline can be run locally with [act](https://github.com/nektos/act)
 9. Code quality and security checks with [SonarQube](https://www.sonarsource.com/products/sonarcloud) and [GitHub CodeQL](https://codeql.github.com/)
-10. Dependency monitoring with [pip-audit](https://pypi.org/project/pip-audit/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
-11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/) and published as release artifacts in CSV and JSON format for compliance checks
-12. Software Bill of Materials (SBOM) generated with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) and published as release artifact
-13. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
-14. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
-15. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
-16. Documentation published to [Read The Docs](https://readthedocs.org/)
-17. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
-18. Python package published to [PyPI](https://pypi.org/)
-19. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
-20. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
-21. Settings for use with [VSCode](https://code.visualstudio.com/)
-22. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
+10. Dependency monitoring and vulnerability scanning with [pip-audit](https://pypi.org/project/pip-audit/), [trivy](https://trivy.dev/latest/), [Renovate](https://github.com/renovatebot/renovate), and [GitHub Dependabot](https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide)
+11. Licenses of dependencies extracted with [pip-licenses](https://pypi.org/project/pip-licenses/), matched with allow list, and published as release artifacts in CSV and JSON format for further compliance checks
+12. Generation of attributions from extracted licenses
+13. Software Bill of Materials (SBOM) generated in [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) formats with [cyclonedx-python](https://github.com/CycloneDX/cyclonedx-python) resp. [trivy](https://trivy.dev/latest/), published as release artifacts
+14. Version and release management with [bump-my-version](https://callowayproject.github.io/bump-my-version/)
+15. Changelog and release notes generated with [git-cliff](https://git-cliff.org/)
+16. Documentation generated with [Sphinx](https://www.sphinx-doc.org/en/master/) including reference documentation and PDF export
+17. Documentation published to [Read The Docs](https://readthedocs.org/)
+18. Interactive OpenAPI specification with [Swagger](https://swagger.io/)
+19. Python package published to [PyPI](https://pypi.org/)
+20. Docker images published to [Docker.io](https://hub.docker.com/) and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) with [artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)
+21. One-click development environments with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces)
+22. Settings for use with [VSCode](https://code.visualstudio.com/)
+23. Settings and custom instructions for use with [GitHub Copilot](https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
 
 ### Application Features
 
@@ -152,6 +153,7 @@ Beyond development tooling, projects generated with this template include the co
 6. Simple Web UI with [Streamlit](https://streamlit.io/)
 7. Configuration to run the CLI and API in a Docker container including setup for [Docker Compose](https://docs.docker.com/get-started/docker-concepts/the-basics/what-is-docker-compose/)
 8. Documentation including badges, setup instructions, contribution guide and security policy
+9. Preparation to deploy API as serverless function to Vercel
 
 Explore [here](https://github.com/helmut-hoffer-von-ankershoffen/oe-python-template-example) for what's generated out of the box.
 
@@ -302,6 +304,11 @@ uv sync --all-extras                                # Install streamlit dependen
 uv run streamlit run examples/streamlit.py          # Serve on localhost:8501, opens browser
 ```
 
+### Vercel Serverless Function
+
+Serve the API as a [serverless function on Vercel](https://oe-python-template-example.vercel.app/)
+
+
 ## Notebooks
 
 ### Jupyter
@@ -444,9 +451,11 @@ Nothing yet
 
 ## Further Reading
 
-* Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
+* Inspect our [security policy](https://oe-python-template-example.readthedocs.io/en/latest/security.html) with detailed documentation of checks, tools and principles.
 * Our [release notes](https://oe-python-template-example.readthedocs.io/en/latest/release-notes.html) provide a complete log of recent improvements and changes.
+* Check out the [reference](https://oe-python-template-example.readthedocs.io/en/latest/reference.html) with detailed documentation of public classes and functions.
 * In case you want to help us improve 🧠 OE Python Template Example: The [contribution guidelines](https://oe-python-template-example.readthedocs.io/en/latest/contributing.html) explain how to setup your development environment and create pull requests.
+* We gratefully acknowledge the [open source projects](ATTRIBUTIONS.md) that this project builds upon. Thank you to all these wonderful contributors!
 
 ## Star History
 

{oe_python_template_example-0.2.10.dist-info → oe_python_template_example-0.2.12.dist-info}/RECORD

@@ -1,12 +1,12 @@
 oe_python_template_example/__init__.py,sha256=Ks3KjkBuzEO1gaezabSfal_WVOsJbuweHwRCs58oRv4,435
-oe_python_template_example/api.py,sha256=_4-Xauw5jA9a6VPTJ5RBjBcbB7gd6Pn585b5OULF13A,5034
-oe_python_template_example/cli.py,sha256=xqIiE2iYkzkGIj9g94ISolGmRd09gxyjbyKhSV1OStM,3761
+oe_python_template_example/api.py,sha256=jP3nVgU06OHK0F9oi3h5_xZRWYsAu2fF80ezGshLk70,5034
+oe_python_template_example/cli.py,sha256=0Du3lJATAT1Gnh02WuJuGfHAbL0eYD7YZNvVP47_mNQ,3761
 oe_python_template_example/constants.py,sha256=6uQHr2CRgzWQWhUQCRRKiPuFhzKB2iblZk3dIRQ5dDc,358
 oe_python_template_example/models.py,sha256=IbegPBFJq0OCAWS70V-ozl6coMd0dC2OsHZY-nIumGs,846
 oe_python_template_example/service.py,sha256=2bxTQH9JeM4ugoQMpTp-pOdANOSZ0HZrQc4JpJzXBqg,1650
 oe_python_template_example/settings.py,sha256=mQu7Bl2EhR6taQLqbaK1s86Ngn3kLVeEoMyhCqbydig,751
-oe_python_template_example-0.2.10.dist-info/METADATA,sha256=SDNrgoCZoGOc5HYHUcCsZ4UsECYcMQUfvAWoDJ1qKCU,28971
-oe_python_template_example-0.2.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.2.10.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.2.10.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.2.10.dist-info/RECORD,,
+oe_python_template_example-0.2.12.dist-info/METADATA,sha256=NEPXbbspobLezIrlQ8A-Iam8wVDCKKxFAaLyBUR7wXo,29752
+oe_python_template_example-0.2.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.2.12.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.2.12.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.2.12.dist-info/RECORD,,