engin 0.0.1__tar.gz → 0.0.2__tar.gz

{engin-0.0.1 → engin-0.0.2}/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.2] - 2025-01-10
+
+### Added
+
+- The `ext` sub-package is now explicitly exported in the package `__init__.py`
+
+
 ## [0.0.1] - 2024-12-12
 
 ### Added

engin-0.0.2/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: engin
+Version: 0.0.2
+Summary: An async-first modular application framework
+License-File: LICENSE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Engin 🏎️
+
+Engin is a zero-dependency application framework for modern Python.
+
+## Features ✨
+
+- **Lightweight**: Engin has no dependencies.
+- **Async First**: Engin provides first-class support for applications. 
+- **Dependency Injection**: Engin promotes a modular decoupled architecture in your application.
+- **Lifecycle Management**: Engin provides an simple, portable approach for implememting
+  startup and shutdown tasks.
+- **Ecosystem Compatability**: seamlessly integrate with frameworks such as FastAPI without
+  having to migrate your dependencies.
+- **Code Reuse**: Engin's modular components work great as packages and distributions. Allowing
+  low boiler-plate code reuse within your Organisation.
+
+## Installation
+
+Engin is available on PyPI, install using your favourite dependency manager:
+
+- **pip**:`pip install engin`
+- **poetry**: `poetry add engin`
+- **uv**: `uv add engin`
+
+## Getting Started
+
+A minimal example:
+
+```python
+import asyncio
+
+from httpx import AsyncClient
+
+from engin import Engin, Invoke, Provide
+
+
+def httpx_client() -> AsyncClient:
+    return AsyncClient()
+
+
+async def main(http_client: AsyncClient) -> None:
+    print(await http_client.get("https://httpbin.org/get"))
+
+engin = Engin(Provide(httpx_client), Invoke(main))
+
+asyncio.run(engin.run())
+```
+

engin-0.0.2/README.md

@@ -0,0 +1,48 @@
+# Engin 🏎️
+
+Engin is a zero-dependency application framework for modern Python.
+
+## Features ✨
+
+- **Lightweight**: Engin has no dependencies.
+- **Async First**: Engin provides first-class support for applications. 
+- **Dependency Injection**: Engin promotes a modular decoupled architecture in your application.
+- **Lifecycle Management**: Engin provides an simple, portable approach for implememting
+  startup and shutdown tasks.
+- **Ecosystem Compatability**: seamlessly integrate with frameworks such as FastAPI without
+  having to migrate your dependencies.
+- **Code Reuse**: Engin's modular components work great as packages and distributions. Allowing
+  low boiler-plate code reuse within your Organisation.
+
+## Installation
+
+Engin is available on PyPI, install using your favourite dependency manager:
+
+- **pip**:`pip install engin`
+- **poetry**: `poetry add engin`
+- **uv**: `uv add engin`
+
+## Getting Started
+
+A minimal example:
+
+```python
+import asyncio
+
+from httpx import AsyncClient
+
+from engin import Engin, Invoke, Provide
+
+
+def httpx_client() -> AsyncClient:
+    return AsyncClient()
+
+
+async def main(http_client: AsyncClient) -> None:
+    print(await http_client.get("https://httpbin.org/get"))
+
+engin = Engin(Provide(httpx_client), Invoke(main))
+
+asyncio.run(engin.run())
+```
+

{engin-0.0.1 → engin-0.0.2}/examples/fastapi/app.py

@@ -19,6 +19,7 @@ class AppBlock(Block):
 
     @invoke
     def add_health_endpoint(self, app: FastAPI) -> None:
-        @app.get("/health")
         async def health():
             return {"ok": True}
+
+        app.add_api_route(path="/health", endpoint=health)

{engin-0.0.1 → engin-0.0.2}/examples/fastapi/routes/cats/api.py

@@ -3,7 +3,7 @@ from typing import Annotated
 from fastapi import APIRouter
 from pydantic import BaseModel
 
-from engin.extensions.fastapi import Inject
+from engin.ext.fastapi import Inject
 from examples.fastapi.routes.cats.domain import Cat, CatPersonality
 from examples.fastapi.routes.cats.ports import CatRepository
 

{engin-0.0.1 → engin-0.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "engin"
-version = "0.0.1"
+version = "0.0.2"
 description = "An async-first modular application framework"
 readme = "README.md"
 requires-python = ">=3.10"

{engin-0.0.1 → engin-0.0.2}/src/engin/__init__.py

@@ -1,3 +1,4 @@
+from engin import ext
 from engin._assembler import Assembler
 from engin._block import Block, invoke, provide
 from engin._dependency import Entrypoint, Invoke, Provide, Supply
@@ -16,6 +17,7 @@ __all__ = [
     "Option",
     "Provide",
     "Supply",
+    "ext",
     "invoke",
     "provide",
 ]

{engin-0.0.1 → engin-0.0.2}/src/engin/_engin.py

@@ -35,13 +35,9 @@ class Engin:
     async def run(self):
         await self.start()
 
-        # lifecycle startup
-
         # wait till stop signal recieved
         await self._stop_event.wait()
 
-        # lifecycle shutdown
-
     async def start(self) -> None:
         LOG.info("starting engin")
         assembled_invocations: list[AssembledDependency] = [