engin 0.0.dev1__tar.gz

engin-0.0.dev1/.github/workflows/publish.yaml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-to-pypi:
+    name: python
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build the Project
+        run: uv build
+
+      - name: Publish
+        run: uv publish

engin-0.0.dev1/.gitignore

@@ -0,0 +1,165 @@
+# 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
+
+# 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/
+
+# Python local version specifier
+.python-version
+
+# 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/

engin-0.0.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tim OSullivan
+
+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.

engin-0.0.dev1/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.3
+Name: engin
+Version: 0.0.dev1
+Summary: An async-first modular application framework
+License-File: LICENSE
+Requires-Python: >=3.10

engin-0.0.dev1/examples/asgi/app.py

@@ -0,0 +1,34 @@
+from pydantic_settings import BaseSettings
+from starlette.applications import Starlette
+from starlette.endpoints import HTTPEndpoint
+from starlette.requests import Request
+from starlette.responses import JSONResponse, Response
+from starlette.routing import Mount, Route
+
+from engin import Block, invoke, provide
+from engin.extensions.asgi import ASGIType
+
+
+class AppConfig(BaseSettings):
+    debug: bool = False
+
+
+class HealthCheckEndpoint(HTTPEndpoint):
+    async def get(self, _: Request) -> Response:
+        return JSONResponse({"ok": True})
+
+
+class AppBlock(Block):
+    @provide
+    def app_factory(
+        self, routes: list[Route], mounts: list[Mount], app_config: AppConfig
+    ) -> ASGIType:
+        return Starlette(routes=[*routes, *mounts], debug=app_config.debug)
+
+    @provide
+    def default_routes(self) -> list[Route]:
+        return [Route("/health", HealthCheckEndpoint)]
+
+    @provide
+    def default_config(self) -> AppConfig:
+        return AppConfig()

engin-0.0.dev1/examples/asgi/common/db/adapaters/memory.py

@@ -0,0 +1,17 @@
+from typing import Any
+
+from examples.asgi.common.db.ports import DatabaseInterface
+
+
+class InMemoryDatabase(DatabaseInterface):
+    def __init__(self) -> None:
+        self._data = {}
+
+    def get(self, key: str) -> Any:
+        return self._data.get(key)
+
+    def set(self, key: str, value: Any) -> Any:
+        self._data[key] = value
+
+    def list(self) -> Any:
+        return list(self._data.values())

engin-0.0.dev1/examples/asgi/common/db/block.py

@@ -0,0 +1,9 @@
+from engin import Block, provide
+from examples.asgi.common.db.adapaters.memory import InMemoryDatabase
+from examples.asgi.common.db.ports import DatabaseInterface
+
+
+class DatabaseBlock(Block):
+    @provide
+    def database(self) -> DatabaseInterface:
+        return InMemoryDatabase()

engin-0.0.dev1/examples/asgi/common/db/ports.py

@@ -0,0 +1,13 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class DatabaseInterface(ABC):
+    @abstractmethod
+    def get(self, key: str) -> Any: ...
+
+    @abstractmethod
+    def list(self) -> Any: ...
+
+    @abstractmethod
+    def set(self, key: str, value: Any) -> Any: ...

engin-0.0.dev1/examples/asgi/common/starlette/endpoint.py

@@ -0,0 +1,47 @@
+from abc import ABC, abstractmethod
+from collections.abc import Iterable
+from typing import ClassVar
+
+from starlette.exceptions import HTTPException
+from starlette.requests import Request
+from starlette.responses import PlainTextResponse, Response
+from starlette.types import Receive, Scope, Send
+
+
+class Endpoint(ABC):
+    """
+    Base class for implementing Starlette endpoints in a way that's compatible with DI, as
+    HTTPEndpoint does not allow you to control class initialisation.
+    """
+
+    ALLOWED_METHODS: ClassVar[Iterable[str]] = (
+        "GET",
+        "HEAD",
+        "POST",
+        "PUT",
+        "PATCH",
+        "DELETE",
+        "OPTIONS",
+    )
+
+    @abstractmethod
+    async def exec(self, request: Request) -> Response: ...
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        request = Request(scope, receive=receive)
+
+        if request.method not in self.ALLOWED_METHODS:
+            response = await self.method_not_allowed(request)
+        else:
+            response = await self.exec(request)
+
+        await response(scope, receive, send)
+
+    async def method_not_allowed(self, request: Request) -> Response:
+        # If we're running inside a starlette application then raise an
+        # exception, so that the configurable exception handler can deal with
+        # returning the response. For plain ASGI apps, just return the response.
+        headers = {"Allow": ", ".join(self.ALLOWED_METHODS)}
+        if "app" in request.scope:
+            raise HTTPException(status_code=405, headers=headers)
+        return PlainTextResponse("Method Not Allowed", status_code=405, headers=headers)

engin-0.0.dev1/examples/asgi/features/cats/api/get.py

@@ -0,0 +1,32 @@
+import json
+
+from starlette.requests import Request
+from starlette.responses import JSONResponse, Response
+
+from examples.asgi.common.db.ports import DatabaseInterface
+from examples.asgi.common.starlette.endpoint import Endpoint
+from examples.asgi.features.cats.domain import Cat
+
+
+class GetCatEndpoint(Endpoint):
+    ALLOWED_METHODS = ("GET",)
+
+    def __init__(self, db: DatabaseInterface) -> None:
+        self._db = db
+
+    async def exec(self, request: Request) -> Response:
+        name = request.path_params.get("name")
+        if name is None:
+            cat_dtos = self._db.list()
+            return JSONResponse(
+                content=[Cat.model_validate(cat_dto).model_dump() for cat_dto in cat_dtos]
+            )
+
+        cat_dto = self._db.get(name)
+
+        if cat_dto is None:
+            return Response(status_code=404)
+
+        cat = Cat.model_validate(cat_dto)
+
+        return JSONResponse(content=cat.model_dump_json())

engin-0.0.dev1/examples/asgi/features/cats/api/post.py

@@ -0,0 +1,26 @@
+from pydantic import ValidationError
+from starlette.requests import Request
+from starlette.responses import Response
+
+from examples.asgi.common.db.ports import DatabaseInterface
+from examples.asgi.common.starlette.endpoint import Endpoint
+from examples.asgi.features.cats.domain import Cat
+
+
+class PostCatEndpoint(Endpoint):
+    ALLOWED_METHODS = ("POST",)
+
+    def __init__(self, db: DatabaseInterface) -> None:
+        self._db = db
+
+    async def exec(self, request: Request) -> Response:
+        cat_dto = await request.json()
+
+        try:
+            cat = Cat.model_validate(cat_dto)
+        except ValidationError:
+            return Response(status_code=422)
+
+        self._db.set(cat.name, cat.model_dump())
+
+        return Response(status_code=204)

engin-0.0.dev1/examples/asgi/features/cats/block.py

@@ -0,0 +1,45 @@
+from starlette.routing import Mount, Route
+
+from engin import Block, provide
+from examples.asgi.common.db.ports import DatabaseInterface
+from examples.asgi.features.cats.api.get import GetCatEndpoint
+from examples.asgi.features.cats.api.post import PostCatEndpoint
+
+
+class CatBlock(Block):
+    @provide
+    def get_cat_route(self, db: DatabaseInterface) -> GetCatEndpoint:
+        return GetCatEndpoint(db=db)
+
+    @provide
+    def post_cat_route(self, db: DatabaseInterface) -> PostCatEndpoint:
+        return PostCatEndpoint(db=db)
+
+    @provide
+    def mount(
+        self,
+        get_cat_endpoint: GetCatEndpoint,
+        post_cat_endpoint: PostCatEndpoint,
+    ) -> list[Mount]:
+        return [
+            Mount(
+                "/cats",
+                routes=[
+                    Route(
+                        "/{name:str}",
+                        get_cat_endpoint,
+                        methods=get_cat_endpoint.ALLOWED_METHODS,
+                    ),
+                    Route(
+                        "/",
+                        get_cat_endpoint,
+                        methods=get_cat_endpoint.ALLOWED_METHODS,
+                    ),
+                    Route(
+                        "/",
+                        post_cat_endpoint,
+                        methods=post_cat_endpoint.ALLOWED_METHODS,
+                    ),
+                ],
+            )
+        ]

engin-0.0.dev1/examples/asgi/features/cats/domain.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+from pydantic import BaseModel, ConfigDict
+
+
+class CatPersonality(Enum):
+    CUTE = "CUTE"
+    EVIL = "EVIL"
+
+
+class Cat(BaseModel):
+    model_config = ConfigDict(use_enum_values=True)
+
+    name: str
+    breed: str
+    age: float
+    personality: CatPersonality

engin-0.0.dev1/examples/asgi/main.py

@@ -0,0 +1,15 @@
+import logging
+
+import uvicorn
+
+from engin import Supply
+from engin.extensions.asgi import ASGIEngin
+from examples.asgi.app import AppBlock, AppConfig
+from examples.asgi.common.db.block import DatabaseBlock
+from examples.asgi.features.cats.block import CatBlock
+
+logging.basicConfig(level=logging.DEBUG)
+
+app = ASGIEngin(AppBlock(), DatabaseBlock(), CatBlock(), Supply(AppConfig(debug=True)))
+
+uvicorn.run(app)

engin-0.0.dev1/examples/simple/main.py

@@ -0,0 +1,19 @@
+import asyncio
+
+from httpx import AsyncClient
+
+from engin import Engin, Invoke, Provide
+
+
+def new_httpx_client() -> AsyncClient:
+    return AsyncClient()
+
+
+async def main(http_client: AsyncClient) -> None:
+    res = await http_client.get("https://httpbin.org/get")
+    print(res)
+
+
+engin = Engin(Provide(new_httpx_client), Invoke(main))
+
+asyncio.run(engin.run())

engin-0.0.dev1/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "engin"
+version = "0.0.dev1"
+description = "An async-first modular application framework"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv]
+dev-dependencies = [
+    "httpx>=0.27.2",
+    "mypy>=1",
+    "pydantic-settings>=2.6.0",
+    "pydantic>=2.9.2",
+    "pytest-asyncio>=0.24.0",
+    "pytest>=8",
+    "ruff>=0",
+    "starlette>=0.39.2",
+    "uvicorn>=0.31.1",
+]
+
+[tool.ruff]
+line-length = 95
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "RUF"]
+ignore = []
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"

engin-0.0.dev1/src/engin/__init__.py

@@ -0,0 +1,21 @@
+from engin._assembler import Assembler
+from engin._block import Block, invoke, provide
+from engin._dependency import Entrypoint, Invoke, Provide, Supply
+from engin._engin import Engin, Option
+from engin._exceptions import AssemblyError
+from engin._lifecycle import Lifecycle
+
+__all__ = [
+    "Assembler",
+    "AssemblyError",
+    "Engin",
+    "Entrypoint",
+    "Invoke",
+    "Lifecycle",
+    "Block",
+    "Option",
+    "Provide",
+    "Supply",
+    "invoke",
+    "provide",
+]