qena-shared-lib 0.1.0__py3-none-any.whl

qena_shared_lib-0.1.0.dist-info/METADATA

@@ -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")
+    ]
+)
+    ...
+```

qena_shared_lib-0.1.0.dist-info/RECORD

@@ -0,0 +1,31 @@
+qena_shared_lib/__init__.py,sha256=WokKEFaMNow6h2ZY_fyB-tiYnic-Ed6K6kyzKgg3Rlw,371
+qena_shared_lib/application.py,sha256=2bpoEHW9FXRjNgBUuij2djfTLbhk01zymqp6kwasRq0,5470
+qena_shared_lib/background.py,sha256=upWeJ747-4S4xsBOR-P2_oNar1YiaxCpnLhEDvnArmQ,3097
+qena_shared_lib/exception_handlers.py,sha256=od_4g2Ro0HTeiIip_Saq6OCW0FMNjwLuaGevVWRPwFo,4824
+qena_shared_lib/exceptions.py,sha256=cNeksC8ZavKgoqKLBik1NR-lCcdLZzITHMXww5deY5Y,6789
+qena_shared_lib/http.py,sha256=90bmDfs522KxKBj2o0vO-MgmDqa3EZOfaNUFp1DuUdQ,23864
+qena_shared_lib/logging.py,sha256=JL6bAmkK1BJA84rZNpvDEmrec3dogQRpSug4fj1Omkw,1618
+qena_shared_lib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qena_shared_lib/scheduler.py,sha256=kqrOpLpqaDIlbENWNkNtLQDmpuhBCvvnc8eentWh8Qk,11966
+qena_shared_lib/security.py,sha256=mDozOTcazVz6QPN3Np8-IM2g9REqo_UCcQDE9HKlUEw,6005
+qena_shared_lib/utils.py,sha256=bvPnjaFx7npVGSUO6IKdpiAHfUECsGRCeDW8UOjVckU,845
+qena_shared_lib/dependencies/__init__.py,sha256=W12RgJbhqZ9GiSV1nLlHmpwPzvQv8t7f4JEoazM_WYg,350
+qena_shared_lib/dependencies/http.py,sha256=3KopQjq05qbYROMPZjji2Zz7qQLU6_2u3qKisLrjLks,1469
+qena_shared_lib/dependencies/miscellaneous.py,sha256=iGwAjatXb_JVSF13n1vdTRAgSKv19VtHo9ZbjjbkIco,753
+qena_shared_lib/logstash/__init__.py,sha256=KlWFXqwPGwKM3yWnz0lTmeZymkobxFPPNeOgyfdGu4g,315
+qena_shared_lib/logstash/_base.py,sha256=b_wWbdIpl9aIqGdnNI-oYuZmiiUhx5rWXIbZzURyOnU,15722
+qena_shared_lib/logstash/_http_sender.py,sha256=Sq3bJOXuOafqloROGblnmyUd0RuU3zF0QLpQDYjiy-g,1765
+qena_shared_lib/logstash/_tcp_sender.py,sha256=ncvc3wYxOJPkB7c_0W8vboaxMRJ_1UYGdA8LN2NXUpo,2306
+qena_shared_lib/rabbitmq/__init__.py,sha256=WKAcKpRXXX9kqfHVEkyX6p2yIWzB07TMsBBWbV8nrKA,1209
+qena_shared_lib/rabbitmq/_base.py,sha256=2_HYL5zHIl201H8O2Vu_R3aNC2S1SHstEU6ttHvtj3c,24224
+qena_shared_lib/rabbitmq/_channel.py,sha256=R0xzZvLkeE4YWsyLhx8bPDramsTFDZIcCgfsDyFmSB4,5429
+qena_shared_lib/rabbitmq/_exception_handlers.py,sha256=bhz-oteXcIEvYA-f4Mj6nFy66z-iVqk5rOARSx_8zSg,4733
+qena_shared_lib/rabbitmq/_exceptions.py,sha256=Mg56Uk4eBEwTnWC91_WPS3_8d-yaqNkbb_32IpX_R-c,1208
+qena_shared_lib/rabbitmq/_listener.py,sha256=1c6Qrz87hL10kaGobTZhI48v3ou88A5u371QdkyZIXA,44153
+qena_shared_lib/rabbitmq/_pool.py,sha256=1_ftW0D3sPHI6v5c72oA03s05up4-1QqZ7d8icnZeNs,1951
+qena_shared_lib/rabbitmq/_publisher.py,sha256=48JdpvNzFaw3Bw5LhunFxcjm3qNWz3AXKyXtcpzcohQ,2380
+qena_shared_lib/rabbitmq/_rpc_client.py,sha256=E-J5PIfA1T3j1y9KoxjNTzSLdK95MbaePulNxiqGb-M,8724
+qena_shared_lib/rabbitmq/_utils.py,sha256=5WZjYm4MdDrjL1dsrZuT8eKKiWfUef29_FJ262-hfSM,438
+qena_shared_lib-0.1.0.dist-info/METADATA,sha256=0j068cW5vBiRC-PU30xRTayhck7EpqOZ1qlmIi-Zw7o,7809
+qena_shared_lib-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+qena_shared_lib-0.1.0.dist-info/RECORD,,

qena_shared_lib-0.1.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