.. core-apis documentation master file, created by
   sphinx-quickstart on Fri Mar 28 22:53:30 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

core-apis
===============================================================================

This project/library contains useful elements related to APIs and provides
basic structures to speed up the implementation of an API service using
the FastApi framework as base...

===============================================================================

.. image:: https://img.shields.io/pypi/pyversions/core-apis.svg
    :target: https://pypi.org/project/core-apis/
    :alt: Python Versions

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-apis/-/blob/main/LICENSE
    :alt: License

.. image:: https://gitlab.com/bytecode-solutions/core/core-apis/badges/release/pipeline.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-apis/-/pipelines
    :alt: Pipeline Status

.. image:: https://readthedocs.org/projects/core-apis/badge/?version=latest
    :target: https://readthedocs.org/projects/core-apis/
    :alt: Docs Status

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security


Documentation Contents
-------------------------------------------------------------------------------
.. toctree::
   :maxdepth: 1
   :caption: Contents:

   api
   decorators
   tests


Features
-------------------------------------------------------------------------------

**FastAPI Server Management**

* Quick server setup with uvicorn ASGI server
* Environment-based configuration (HOST, PORT, DEBUG, LOG_LEVEL)
* Secure defaults (localhost-only binding)

**Application Factory**

* ``AppConfig`` dataclass consolidating all application parameters (name, version, description, base_path, cors_config, debug)
* ``CorsConfig`` dataclass for CORS middleware (origins, methods, headers)
* ``create_application(app_config: AppConfig)`` factory with safe defaults

**Router Management**

* Plugin architecture: register routers at import time via ``add_router()``
* Runtime addition: attach routers to an existing app via ``app.include_router()``
* ``reset_routers()`` for clearing the registry between tests
* Built-in health check endpoint (``/api/ping``)

**Response Standardization**

* ``@wrap_response`` decorator for consistent API responses
* ``ApiResponse`` TypedDict contract: ``code``, ``status``, ``result``, ``error``
* HTTP status code mapping (2XX success, 4XX error, 5XX failure)
* Automatic exception handling for ``ServiceException`` and ``InternalServerError``

**Testing Utilities**

* ``BaseApiTestCases`` class for FastAPI testing with pre-configured ``TestClient``
* ``setUp()`` calls ``reset_routers()`` automatically to prevent cross-test pollution
* ``init_client(with_cors=True)`` for flexible test application initialization


Installation
-------------------------------------------------------------------------------

Install the package:

.. code-block:: bash

    pip install core-apis
    uv pip install core-apis    # Or using UV...
    pip install -e ".[dev]"     # For development...


How to use it
-------------------------------------------------------------------------------

The simple way to spin up the FastAPI server locally using `uvicorn`:

.. code-block:: python

    from core_apis.api import server
    server.run()

Creating an application with custom configuration (``AppConfig`` / ``CorsConfig``):

.. code-block:: python

    from core_apis.api import create_application, AppConfig, CorsConfig

    app = create_application(
        app_config=AppConfig(
            name="My Service",
            version="1.0.0",
            cors_config=CorsConfig(
                enabled=True,
                origins=["https://example.com"],
            ),
        ),
    )

Adding custom routers —> plugin architecture (recommended):

.. code-block:: python

    from fastapi import APIRouter

    from core_apis.api import server
    from core_apis.api.routers import add_router

    router = APIRouter()
    add_router(router)

    @router.get(path="/server_status")
    def get_server_status():
        return {"status": "OK"}

    server.run()

Adding routers at runtime (post-creation):

.. code-block:: python

    from fastapi import APIRouter

    from core_apis.api import create_application

    app = create_application()

    late_router = APIRouter()

    @late_router.get(path="/status")
    def get_status():
        return {"status": "OK"}

    app.include_router(late_router, prefix="/api")

For an example of the structure of a production-ready project
check: https://gitlab.com/bytecode-solutions/examples/fastapi-project


Setting Up Environment
-------------------------------------------------------------------------------

1. Install required libraries:

.. code-block:: bash

    pip install --upgrade pip
    pip install virtualenv

2. Create Python virtual environment:

.. code-block:: bash

    virtualenv --python=python3.12 .venv

3. Activate the virtual environment:

.. code-block:: bash

    source .venv/bin/activate

Install packages
-------------------------------------------------------------------------------

.. code-block:: bash

    pip install .
    pip install -e ".[dev]"

Check tests and coverage
-------------------------------------------------------------------------------

.. code-block:: bash

    python manager.py run-tests
    python manager.py run-coverage


Contributing
-------------------------------------------------------------------------------

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Write tests for new functionality
4. Ensure all tests pass: ``pytest -n auto``
5. Run linting: ``pylint core_apis``
6. Run security checks: ``bandit -r core_apis``
7. Submit a pull request


License
-------------------------------------------------------------------------------

This project is licensed under the MIT License. See the LICENSE file for details.


Links
-------------------------------------------------------------------------------

* **Documentation:** https://core-apis.readthedocs.io/en/latest/
* **Repository:** https://gitlab.com/bytecode-solutions/core/core-apis
* **Issues:** https://gitlab.com/bytecode-solutions/core/core-apis/-/issues
* **Changelog:** https://gitlab.com/bytecode-solutions/core/core-apis/-/blob/master/CHANGELOG.md
* **PyPI:** https://pypi.org/project/core-apis/


Support
-------------------------------------------------------------------------------

For questions or support, please open an issue on GitLab or contact the maintainers.


Authors
-------------------------------------------------------------------------------

* **Alejandro Cora González** - *Initial work* - alek.cora.glez@gmail.com