qena-shared-lib 0.1.0__tar.gz

qena_shared_lib-0.1.0/.gitignore

@@ -0,0 +1,176 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+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/
+
+# PyPI configuration file
+.pypirc
+
+# additional
+.ruff_cache
+.vscode
+scheduler.lock

qena_shared_lib-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.2
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

qena_shared_lib-0.1.0/PKG-INFO

@@ -0,0 +1,473 @@
+Metadata-Version: 2.4
+Name: qena-shared-lib
+Version: 0.1.0
+Summary: A shared tools for other services
+Requires-Python: >=3.10
+Requires-Dist: cronsim~=2.0
+Requires-Dist: fastapi[all]~=0.115.0
+Requires-Dist: httpx~=0.27.0
+Requires-Dist: jwt~=1.3.0
+Requires-Dist: passlib[bcrypt]~=1.7.0
+Requires-Dist: pika~=1.3.0
+Requires-Dist: prometheus-client~=0.21.0
+Requires-Dist: prometheus-fastapi-instrumentator~=7.0.0
+Requires-Dist: punq~=0.7.0
+Requires-Dist: pydantic~=2.10.0
+Description-Content-Type: text/markdown
+
+# Qena shared lib
+
+A shared tools for other services. It includes.
+
+- FastAPI app builder
+- A wrapper around fastapi to make it class based.
+- RabbitMQ utility class to listen, respond, publish and make rpc request.
+- Logstash utility class to log message in `ecs` ( elastic common schema ).
+- A simple task scheduler, to schedule task to run in specific time.
+- Background task runner.
+- Security tools ( password hasher, jwt, acl ).
+- IOC container to manager dependencies used across fastapi, rabbitmq manager and schedule manager.
+
+# Usage
+
+## Http
+
+To create fastapi app.
+
+``` py
+def main() -> FastAPI:
+    builder = (
+        Builder()
+        .with_title("Qena shared lib")
+        .with_description("A shared tools for other services.")
+        .with_version("0.1.0")
+        .with_environment(Environment.PRODUCTION)
+    )
+
+    app = builder.build()
+
+    return app
+```
+
+To run app
+
+``` sh
+$ uvicorn --factory main:main
+```
+
+### Lifespan
+
+``` py
+@asynccontextmanager
+def lifespan(app: FastAPI):
+    ...
+
+    yield
+
+    ...
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_lifespan(lifespan)
+
+    ...
+```
+
+### Dependencies
+
+``` py
+def main() -> FastAPI:
+    ...
+
+    builder.with_singleton(EmailService)
+    builder.with_transient(Database)
+
+    ...
+```
+
+### Controllers
+
+``` py
+@ApiController("/users")
+class UserController(ControllerBase):
+
+    def __init__(self, email_service: EmailService):
+        self._email_service = email_service
+
+    @post()
+    async def send_email(self, message: str):
+        await self._email_service.send(message)
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_controllers([
+        UserController
+    ])
+```
+
+### Routers
+
+``` py
+router = APIRouter(prefix="/auth")
+
+
+@router.post("")
+async def login(
+    db: Annotated[Database, DependsOn(Database)],
+    username: str,
+    password: str
+):
+    ...
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_routers([
+        router
+    ])
+
+    ...
+```
+
+To enable metrics.
+
+``` py
+def main() -> FastAPI:
+    ...
+
+    builder.with_metrics()
+
+    ...
+```
+
+## Logstash
+
+``` py
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    logstash = get_service(BaseLogstashSender)
+
+    await logstash.start()
+
+    yield
+
+    await logstash.stop()
+
+
+def main() -> FastAPI:
+    ...
+
+    logstash = HTTPSender(
+        service_name="qena-shared-lib",
+        url="http://127.0.0.1:18080",
+        user="logstash",
+        password="logstash",
+    )
+    # or
+    # logstash = TCPSender(
+    #   service_name="qena-shared-lib",
+    #   host="127.0.0.1",
+    #   port=18090
+    # )
+    builder.with_singleton(
+        service=BaseLogstashSender,
+        instance=logstash,
+    )
+
+    ...
+
+
+@router.get("")
+def log_message(
+    logstash: Annotated[
+        BaseLogstashSender,
+        DependsOn(BaseLogstashSender),
+    ],
+    message: str,
+):
+    logstash.info(message)
+```
+
+## Rabbitmq
+
+To create rabbitmq connection manager.
+
+``` py
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    rabbitmq = get_service(RabbitMqManager)
+
+    await rabbitmq.connect()
+
+    yield
+
+    rabbitmq.disconnect()
+
+
+@Consumer("UserQueue")
+class UserConsumer(ListenerBase):
+
+    def __init__(self, db: Database):
+        self._db = db
+
+    @consume()
+    async def store_user(self, user: User):
+        await self._db.save(user)
+
+
+def main() -> FastAPI:
+    ...
+
+    rabbitmq = RabbitMqManager(
+        listeners=[
+            UserConsumer
+        ],
+        logstash=logstash,
+        container=builder.container,
+    )
+
+    builder.add_singleton(
+        service=RabbitMqManager,
+        instance=rabbitmq,
+    )
+
+    ...
+```
+
+### Publisher
+
+``` py
+@router.post("")
+async def store_user(
+    rabbitmq: Annotated[
+        RabbitMqManager,
+        DependsOne(RabbitMqManager)
+    ],
+    user: User,
+)
+    publisher = rabbitmq.publisher("UserQueue")
+
+    await publisher.publish(user)
+    # await publisher.publish_with_arguments(user)
+```
+
+### RPC client
+
+``` py
+@router.get("")
+async def get_user(
+    rabbitmq: Annotated[
+        RabbitMqManager,
+        DependsOne(RabbitMqManager)
+    ],
+    user_id: str,
+)
+    rpc_client = rabbitmq.rpc_client("UserQueue")
+
+    user = await rpc_client.call(user_id)
+    # user = await rpc_client.call_with_arguments(user_id)
+
+    return user
+```
+
+## Scheduler
+
+``` py
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    schedule_manager = get_service(ScheduleManager)
+
+    rabbitmq.start()
+
+    yield
+
+    schedule_manager.stop()
+
+
+@Scheduler()
+class TaskScheduler(SchedulerBase):
+
+    def __init__(self, db: Database)
+
+    @schedule("* * * * *")
+    def do_task(
+        self,
+
+    ):
+        ...
+# or
+# scheduler = Scheduler()
+
+# @scheduler.schedule("* * * * *")
+# def do_task(
+#     db: Annotated[Database, DependsOn(Database)]
+# ):
+#     ...
+
+
+def main() -> FastAPI:
+    ...
+
+    schedule_manager = ScheduleManager(
+        schedulers=[
+            TaskScheduler
+        ],
+        logstash=logstash,
+        container=builder.container
+    )
+
+    builder.with_singleton(
+        service=ScheduleManager,
+        instance=schedule_manager,
+    )
+
+    ...
+```
+
+## Background
+
+``` py
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    background = get_service(Background)
+
+    background.start()
+
+    yield
+
+    background.stop()
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_singleton(
+        service=BaseLogstashSender,
+        instance=logstash,
+    )
+    builder.with_singleton(Background)
+
+    ...
+
+
+async data_processor(data: Data):
+    ...
+
+
+@router.get("")
+async def process_data(
+    background: Annotated[
+        Background,
+        DependsOne(Background)
+    ],
+    data: Data
+)
+    background.add_task(BackgroundTask(data_processor, data))
+```
+
+## Security
+
+### Password hasher
+
+``` py
+@ApiController("/users")
+class UserController(ControllerBase):
+
+    def __init__(self, password_hasher: PasswordHasher):
+        self._password_hasher = password_hasher
+
+    @post()
+    async def signup(self, user: User):
+        await self._password_hasher.hash(user.password)
+
+    @post()
+    async def login(self, user: User):
+        await self._password_hasher.verify(user.password)
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_singleton(PasswordHasher)
+    builder.with_controllers([
+        UserController
+    ])
+
+    ...
+```
+
+### JWT
+
+``` py
+@ApiController("/users")
+class UserController(ControllerBase):
+
+    def __init__(
+        self,
+
+        ...
+
+        jwt: JwtAdapter,
+    ):
+        ...
+
+        self._jwt = jwt
+
+    @post()
+    async def login(self, user: User):
+        payload = { ... }
+
+        await self._jwt.encode(payload)
+
+    @post
+    async def verifiy(self, token: str):
+        await self._jwt.decode(token)
+
+
+def main() -> FastAPI:
+    ...
+
+    builder.with_singleton(JwtAdapter)
+    builder.with_controllers([
+        UserController
+    ])
+
+    ...
+```
+
+### ACL
+
+``` py
+@ApiController("/users")
+class UserController(ControllerBase):
+
+    @post()
+    async def get_user(
+        self,
+        user: Annotated[
+            UserInfo,
+            EndpointACL(
+                user_type="ADMIN",
+                persmission=[
+                    "READ"
+                ],
+            )
+        ]
+    ):
+        ...
+
+
+@router.get("")
+async def get_users(
+    user: Annotated[
+        UserInfo,
+        EndpointACL("ADMIN")
+    ]
+)
+    ...
+```