ab-bff-service 0.2.0__py3-none-any.whl

ab_bff_service-0.2.0.dist-info/METADATA

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: ab-bff-service
+Version: 0.2.0
+Summary: Auth Broker BFF Service.
+Author-email: Matthew Coulter <53892067+mattcoulter7@users.noreply.github.com>
+License-File: LICENSE
+Requires-Python: <4,>=3.12
+Requires-Dist: ab-alembic-auto-migrate<1,>=0.2.0
+Requires-Dist: ab-client-auth-client>=0.1.0
+Requires-Dist: ab-client-token-validator>=0.1.0
+Requires-Dist: ab-client-user>=0.1.0
+Requires-Dist: ab-database[postgres-async,postgres-sync,sqlite-async]<1,>=0.2.2
+Requires-Dist: ab-identity-context[fastapi]>=0.1.1
+Requires-Dist: ab-logging>=0.1.2
+Requires-Dist: fastapi<0.116,>=0.115.14
+Requires-Dist: pydantic[email]<3,>=2.11.7
+Requires-Dist: uvicorn<0.36,>=0.35.0
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# Auth Broker BFF
+
+The template repository for creating python packages, shared across auth-broker.
+
+![Python](https://img.shields.io/badge/Python-3.12-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+![UV](https://img.shields.io/badge/UV-Fast-6E40C9?style=for-the-badge)
+![Hatchling](https://img.shields.io/badge/Hatchling-PEP517-6E40C9?style=for-the-badge)
+![Ruff](https://img.shields.io/badge/Ruff-Lint-000000?style=for-the-badge)
+![Pre-commit](https://img.shields.io/badge/Pre--commit-Hooks-000000?style=for-the-badge)
+![Pytest](https://img.shields.io/badge/Pytest-Unit%2BAsync-08979C?style=for-the-badge)
+![Coverage](https://img.shields.io/badge/Cov-Reports-08979C?style=for-the-badge)
+![GitHub Actions](https://img.shields.io/badge/Actions-CI%2FCD-F7B500?style=for-the-badge&logo=github-actions)
+![PyPI](https://img.shields.io/badge/PyPI-Publish-6E40C9?style=for-the-badge)
+![Docker](https://img.shields.io/badge/Docker-Builds-2496ED?style=for-the-badge&logo=docker)
+![Compose](https://img.shields.io/badge/Compose-Local-2496ED?style=for-the-badge&logo=docker)
+![Makefile](https://img.shields.io/badge/Makefile-Scripts-F7B500?style=for-the-badge)
+
+🦜🕸️
+
+[![CI](https://github.com/auth-broker/service-template/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/auth-broker/service-template/actions/workflows/ci.yaml)
+
+</div>
+
+______________________________________________________________________
+
+## Table of Contents
+
+<!-- toc -->
+
+- [Introduction](#introduction)
+- [Quick Start](#quick-start)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Formatting and linting](#formatting-and-linting)
+- [CICD](#cicd)
+
+<!-- tocstop -->
+
+______________________________________________________________________
+
+## Introduction
+
+This template repository aims to create a reusable package template which
+streamlines the creation and publishing of isolated python packages in auth-broker.
+This is aligned with the engineering vision @ auth-broker for better modularisation and
+reusability of code.
+
+______________________________________________________________________
+
+## Quick Start
+
+Since this is just a package, and not a service, there is no real "run" action.
+But you can run the tests immediately.
+
+Here are a list of available commands via make.
+
+### Bare Metal (i.e. your machine)
+
+1. `make install` - install the required dependencies.
+1. `make test` - runs the tests.
+
+### Docker
+
+1. `make build-docker` - build the docker image.
+1. `make run-docker` - run the docker compose services.
+1. `make test-docker` - run the tests in docker.
+1. `make clean-docker` - remove all docker containers etc.
+
+______________________________________________________________________
+
+## Installation
+
+### For Dev work on the repo
+
+Install `uv`, (_if you haven't already_)
+https://docs.astral.sh/uv/getting-started/installation/#installation-methods
+
+```shell
+brew install uv
+```
+
+Initialise pre-commit (validates ruff on commit.)
+
+```shell
+uv run pre-commit install
+```
+
+Install dependencies (including dev dependencies)
+
+```shell
+uv sync
+```
+
+If you are adding a new dev dependency, please run:
+
+```shell
+uv add --dev {your-new-package}
+```
+
+### Namespaces
+
+Packages all share the same namespace `ab_core`. To import this package into
+your project:
+
+```python
+from ab_core.template import placeholder_func
+```
+
+We encourage you to make your package available to all of ab via this
+`ab_core` namespace. The goal is to streamline development, POCs and overall
+collaboration.
+
+______________________________________________________________________
+
+## Usage
+
+### Adding the dependency to your project
+
+The library is available on PyPI. You can install it using the following
+command:
+
+**Using pip**:
+
+```shell
+pip install service-bff
+```
+
+**Using UV**
+
+Note: there is currently no nice way like poetry, hence we still needd to
+provide the full url. https://github.com/astral-sh/uv/issues/10140
+
+Add the dependency
+
+```shell
+uv add service-bff
+```
+
+**Using poetry**:
+
+Then run the following command to install the package:
+
+```shell
+poetry add service-bff
+```
+
+### How tos
+
+**Example Usage**
+
+```python
+# Please update this based on your package!
+
+from ab_core.template import placeholder_func
+
+
+if __name__ == "__main__":
+    print("This is a placeholder: ", placeholdder_func())
+```
+
+______________________________________________________________________
+
+## Formatting and linting
+
+We use Ruff as the formatter and linter. The pre-commit has hooks which runs
+checking and applies linting automatically. The CI validates the linting,
+ensuring main is always looking clean.
+
+You can manually use these commands too:
+
+1. `make lint` - check for linting issues.
+1. `make format` - fix linting issues.
+
+______________________________________________________________________
+
+## CICD
+
+### Publishing to PyPI
+
+We publish to PyPI using Github releases. Steps are as follows:
+
+1. Manually update the version in `pyproject.toml` file using a PR and merge to
+   main. Use `uv version --bump {patch/minor/major}` to update the version.
+1. Create a new release in Github with the tag name as the version number. This
+   will trigger the `publish` workflow. In the Release window, type in the
+   version number and it will prompt to create a new tag.
+1. Verify the release in
+   [PyPI](https://pypi.org/project/service-bff/)

ab_bff_service-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ab_service/bff/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ab_service/bff/main.py,sha256=PduGR-AxBbdgedkI2r-VS55QLp7CDZmuy11ft1wpYuA,1858
+ab_service/bff/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ab_service/bff/routes/identity_context.py,sha256=2WNGG35EgbY6ohB-V-zj15Q16wgYu9LrS-JU6pKs9Yk,704
+ab_bff_service-0.2.0.dist-info/METADATA,sha256=HpDzCf8SKwyousTuPsl2NPa8annuMcgBE-ofSqtgPWg,6079
+ab_bff_service-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ab_bff_service-0.2.0.dist-info/licenses/LICENSE,sha256=REBFOD_HdKi9ZZ38nP3A_NjpLFaijF1A6_PDiMglbLk,1072
+ab_bff_service-0.2.0.dist-info/RECORD,,

ab_bff_service-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ab_bff_service-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matthew Coulter
+
+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.

ab_service/bff/main.py

@@ -0,0 +1,55 @@
+"""Main application for the User Service."""
+
+from contextlib import asynccontextmanager
+from typing import Annotated
+
+from ab_client_auth_client.client import Client as AuthClient
+from ab_client_token_validator.client import Client as TokenValidatorClient
+from ab_client_user.client import Client as UserClient
+from ab_core.alembic_auto_migrate.service import AlembicAutoMigrate
+from ab_core.database.databases import Database
+from ab_core.dependency import Depends, inject
+from ab_core.dependency.loaders.environment_object import ObjectLoaderEnvironment
+from ab_core.logging.config import LoggingConfig
+from fastapi import FastAPI
+
+from ab_service.bff.routes.identity_context import router as identity_context_router
+
+
+@inject
+@asynccontextmanager
+async def lifespan(
+    _app: FastAPI,
+    _db: Annotated[
+        Database,
+        Depends(Database, persist=True),
+    ],  # cold start load db into cache
+    logging_config: Annotated[
+        LoggingConfig,
+        Depends(LoggingConfig, persist=True),
+    ],
+    alembic_auto_migrate: Annotated[
+        AlembicAutoMigrate,
+        Depends(AlembicAutoMigrate, persist=True),
+    ],
+    _auth_client: Annotated[
+        AuthClient,
+        Depends(ObjectLoaderEnvironment[AuthClient](env_prefix="AUTH_SERVICE"), persist=True),
+    ],
+    _token_validator_client: Annotated[
+        TokenValidatorClient,
+        Depends(ObjectLoaderEnvironment[TokenValidatorClient](env_prefix="TOKEN_VALIDATOR_SERVICE"), persist=True),
+    ],
+    _user_client: Annotated[
+        UserClient,
+        Depends(ObjectLoaderEnvironment[UserClient](env_prefix="USER_SERVICE"), persist=True),
+    ],
+):
+    """Lifespan context manager to handle startup and shutdown events."""
+    logging_config.apply()
+    alembic_auto_migrate.run()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+app.include_router(identity_context_router)

ab_service/bff/routes/identity_context.py

@@ -0,0 +1,20 @@
+"""User-related API routes."""
+
+from typing import Annotated
+
+from ab_core.database.session_context import db_session_async
+from ab_core.identity_context.dependency import IdentityContext, get_identity_context
+from fastapi import APIRouter
+from fastapi import Depends as FDepends
+from sqlalchemy.ext.asyncio import AsyncSession
+
+router = APIRouter(prefix="/identity-context", tags=["Identity Context"])
+
+
+@router.get("", response_model=IdentityContext)
+async def me(
+    _db_session: Annotated[AsyncSession, FDepends(db_session_async)],
+    identity_context: Annotated[IdentityContext, FDepends(get_identity_context)],
+):
+    """Return the current user's identity context."""
+    return identity_context