.. Influxion documentation master file, created by
.. sphinx-quickstart on Thu Jun 26 09:49:40 2025.
.. You can adapt this file completely to your liking, but it should at least
.. contain the root `toctree` directive.

.. image:: _static/influxion_logo.png
   :alt: Influxion Logo
   :width: 600px
   :align: center

**Influxion** is a FastAPI-based microservice for generating PDFs from structured JSON data and HTML/CSS templates.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   pdf/generate
   pdf/sign
   pdf/standards
   pdf/fonts
   examples
   environment
   kubernetes
   azure-setup
   license
   ideas

To try it out, check the `Swagger UI <../swagger>`__ or the examples in the examples section.

Features
--------

- Accepts JSON input
- OAuth2 authentication through Entra ID.
- Supports optional custom HTML (Jinja2) and CSS templates
- Supports optional PDF standards (e.g., PDF/A, PDF/UA)
- Supports optional digital signing with Azure Key Vault certificate
- Query job status via ``/pdf/{job_id}``
- Download generated PDF via ``/pdf/{job_id}/download``
- Optional Celery worker for background PDF generation (configure via ``INFLUXION_USE_CELERY``, ``INFLUXION_CELERY_BROKER_URL``, and ``INFLUXION_CELERY_RESULT_BACKEND``)

It uses:

- `FastAPI <https://fastapi.tiangolo.com/>`__ for the API framework,
- `Jinja2 <https://jinja.palletsprojects.com/>`__ for templating,
- `Pydantic <https://pydantic-docs.helpmanual.io/>`__ for data validation,
- `WeasyPrint <https://weasyprint.org/>`__ for PDF rendering and supports optional custom templates,
- `PyHanko <https://pyhanko.readthedocs.io/en/latest/>`__ for digital signing of documents with certificates stored in Azure Key Vault.
- `Azure Key Vault <https://learn.microsoft.com/en-us/azure/key-vault/general/basic-concepts>`__ for secure certificate management.
- `Celery <https://docs.celeryq.dev/en/stable/>`__ for background task processing (optional).