muscles-asgi 1.0.0__tar.gz

muscles_asgi-1.0.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: muscles-asgi
+Version: 1.0.0
+Summary: Muscles ASGI runtime adapter for Web/API applications
+License: MIT
+Author: Denis B.
+Author-email: denis@butko.info
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: mime
+Provides-Extra: server
+Requires-Dist: dnspython (==2.6.1)
+Requires-Dist: jinja2 (==3.1.2)
+Requires-Dist: jsonschema (==4.16.0)
+Requires-Dist: muscles (>=1.0.0rc1,<2.0.0)
+Requires-Dist: python-magic (==0.4.27) ; extra == "mime"
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
+Requires-Dist: uwsgi (==2.0.20) ; extra == "server"
+Requires-Dist: watchdog (>=4.0.0,<5.0.0)
+Description-Content-Type: text/markdown
+
+# Muscles ASGI
+
+`muscles-asgi` is the ASGI runtime for Muscles. It mirrors the WSGI API model
+while using ASGI scopes/events for async-capable servers.
+
+## Installation
+
+```bash
+pip install muscles-asgi
+```
+
+Canonical ecosystem install matrix is documented in core:
+[Muscles installation matrix](https://github.com/butkoden/muscles/blob/master/docs/installation.md).
+
+## Related Repositories
+
+- [`muscles`](https://github.com/butkoden/muscles) - core contracts, routing, actions and canonical documentation.
+- [`muscles-wsgi`](https://github.com/butkoden/muscles-wsgi) - WSGI runtime with the same application model.
+- [`muscles-cli`](https://github.com/butkoden/muscles-cli) - CLI projection and developer commands.
+- [`muscles-sse`](https://github.com/butkoden/muscles-sse) - streaming projection for action results.
+- [`muscles-mcp`](https://github.com/butkoden/muscles-mcp) - MCP projection that can bind to ASGI entrypoints.
+- [`muscles-benchmarks`](https://github.com/butkoden/muscles-benchmarks) - ASGI regression and architecture checks.
+
+## Runtime
+
+An app binds `Context` to `AsgiStrategy`:
+
+```python
+from muscles import ApplicationMeta, Configurator, Context
+from muscles.asgi import AsgiStrategy
+
+
+class App(metaclass=ApplicationMeta):
+    config = Configurator(obj={"main": {"HOST": "0.0.0.0", "PORT": "8080"}})
+    context = Context(AsgiStrategy, params={})
+
+    def run(self, *args):
+        return self.context.execute(*args, shutup=True)
+```
+
+The ASGI package shares core schemas, route matching and OpenAPI generation with
+the other runtimes. It should not duplicate core itinerary code.
+
+## Schema Ownership
+
+ASGI does not ship its own `muscles.asgi.schema_` package. Framework schemas,
+columns, fields, request/response bodies, security objects and value objects
+belong to `muscles.core.schema` and should be imported from `muscles`:
+
+```python
+from muscles import Column, JsonRequestBody, Model, String
+```
+
+## REST API And Swagger
+
+`RestApi` controllers/actions are projected into OpenAPI automatically. Generated
+paths include the external API prefix, so a mounted route such as
+`/api/v1/bookings` appears in Swagger exactly as clients must call it.
+
+More detail: [docs/openapi-and-routing.md](docs/openapi-and-routing.md).
+Backend pipeline features are documented in
+[docs/backend-pipeline.md](docs/backend-pipeline.md).
+
+## Application Inspection
+
+Use `mount_api(app, api)` after declaring a `RestApi` to project ASGI routes into
+the core `ApplicationRegistry`. This makes routes visible to
+`inspect_application(app)` and CLI/doctor tooling without making the registry
+the HTTP dispatch source.
+
+Call it after all controllers/actions are registered and before running
+inspection, doctor checks or generators. It is safe to call more than once:
+already projected routes are skipped. `finalize_api(app, api)` is an alias for
+projects that prefer a "declare, then finalize" bootstrap style.
+`asgi_app(app)` also calls `mount_application_apis(app)` once when the ASGI
+entrypoint is created, so APIs stored as attributes on the application are
+visible to runtime inspection without additional app-side adapters.
+
+```python
+from muscles import inspect_application
+from muscles.asgi import RestApi, finalize_api
+
+app = App()
+api = RestApi(name="Api", prefix="/api")
+
+@api.init("/ping", method="get")
+def ping(request):
+    return {"ok": True}
+
+finalize_api(app, api)
+assert any(route["path"] == "/api/ping" for route in inspect_application(app)["routes"])
+```
+
+Request dispatch still uses the ASGI `RestApi` route tree. The projected routes
+are lightweight descriptors for tools that need to understand the application
+without knowing ASGI internals.
+
+When the application has a neutral `TelemetryProvider`, ASGI records a
+`muscles.server.dispatch` span for matched routes with app, route, method and
+HTTP status attributes.
+
+## Action Bridge
+
+`ActionAsgiAdapter` is an optional HTTP projection for Muscles actions. It keeps
+package-specific features out of ASGI routes: packages register normal core
+actions, and ASGI exposes only the actions explicitly allowed by the project.
+
+```python
+from muscles.asgi import ActionAsgiAdapter
+
+application = ActionAsgiAdapter.from_application(
+    app,
+    allowed_actions={"bookings.echo"},
+)
+```
+
+The bridge accepts JSON `POST /actions/<action-name>` requests, executes through
+core `ActionDispatcher(..., transport="http")`, returns JSON for non-stream
+results, and returns `application/problem+json` for core action errors. Stream
+actions should be projected through `muscles-sse`.
+
+## Request Handling
+
+Request parsing does not require `cgi`, `multipart` or `python-magic` at import
+time. Multipart form data uses the standard library path, and missing MIME
+detection falls back safely.
+
+ASGI request execution is stateless on `Context`: request-specific data
+(`scope`, `receive`, `send`) is passed directly into `context.execute(...)`
+per request. The strategy keeps a persistent server lifecycle while request
+state stays isolated.
+
+## Development
+
+Run tests with sibling packages on `PYTHONPATH`:
+
+```bash
+PYTHONPATH=../muscles/src:src python -m pytest -q
+```
+
+Production notes: [docs/production.md](docs/production.md).
+

muscles_asgi-1.0.0/README.md

@@ -0,0 +1,141 @@
+# Muscles ASGI
+
+`muscles-asgi` is the ASGI runtime for Muscles. It mirrors the WSGI API model
+while using ASGI scopes/events for async-capable servers.
+
+## Installation
+
+```bash
+pip install muscles-asgi
+```
+
+Canonical ecosystem install matrix is documented in core:
+[Muscles installation matrix](https://github.com/butkoden/muscles/blob/master/docs/installation.md).
+
+## Related Repositories
+
+- [`muscles`](https://github.com/butkoden/muscles) - core contracts, routing, actions and canonical documentation.
+- [`muscles-wsgi`](https://github.com/butkoden/muscles-wsgi) - WSGI runtime with the same application model.
+- [`muscles-cli`](https://github.com/butkoden/muscles-cli) - CLI projection and developer commands.
+- [`muscles-sse`](https://github.com/butkoden/muscles-sse) - streaming projection for action results.
+- [`muscles-mcp`](https://github.com/butkoden/muscles-mcp) - MCP projection that can bind to ASGI entrypoints.
+- [`muscles-benchmarks`](https://github.com/butkoden/muscles-benchmarks) - ASGI regression and architecture checks.
+
+## Runtime
+
+An app binds `Context` to `AsgiStrategy`:
+
+```python
+from muscles import ApplicationMeta, Configurator, Context
+from muscles.asgi import AsgiStrategy
+
+
+class App(metaclass=ApplicationMeta):
+    config = Configurator(obj={"main": {"HOST": "0.0.0.0", "PORT": "8080"}})
+    context = Context(AsgiStrategy, params={})
+
+    def run(self, *args):
+        return self.context.execute(*args, shutup=True)
+```
+
+The ASGI package shares core schemas, route matching and OpenAPI generation with
+the other runtimes. It should not duplicate core itinerary code.
+
+## Schema Ownership
+
+ASGI does not ship its own `muscles.asgi.schema_` package. Framework schemas,
+columns, fields, request/response bodies, security objects and value objects
+belong to `muscles.core.schema` and should be imported from `muscles`:
+
+```python
+from muscles import Column, JsonRequestBody, Model, String
+```
+
+## REST API And Swagger
+
+`RestApi` controllers/actions are projected into OpenAPI automatically. Generated
+paths include the external API prefix, so a mounted route such as
+`/api/v1/bookings` appears in Swagger exactly as clients must call it.
+
+More detail: [docs/openapi-and-routing.md](docs/openapi-and-routing.md).
+Backend pipeline features are documented in
+[docs/backend-pipeline.md](docs/backend-pipeline.md).
+
+## Application Inspection
+
+Use `mount_api(app, api)` after declaring a `RestApi` to project ASGI routes into
+the core `ApplicationRegistry`. This makes routes visible to
+`inspect_application(app)` and CLI/doctor tooling without making the registry
+the HTTP dispatch source.
+
+Call it after all controllers/actions are registered and before running
+inspection, doctor checks or generators. It is safe to call more than once:
+already projected routes are skipped. `finalize_api(app, api)` is an alias for
+projects that prefer a "declare, then finalize" bootstrap style.
+`asgi_app(app)` also calls `mount_application_apis(app)` once when the ASGI
+entrypoint is created, so APIs stored as attributes on the application are
+visible to runtime inspection without additional app-side adapters.
+
+```python
+from muscles import inspect_application
+from muscles.asgi import RestApi, finalize_api
+
+app = App()
+api = RestApi(name="Api", prefix="/api")
+
+@api.init("/ping", method="get")
+def ping(request):
+    return {"ok": True}
+
+finalize_api(app, api)
+assert any(route["path"] == "/api/ping" for route in inspect_application(app)["routes"])
+```
+
+Request dispatch still uses the ASGI `RestApi` route tree. The projected routes
+are lightweight descriptors for tools that need to understand the application
+without knowing ASGI internals.
+
+When the application has a neutral `TelemetryProvider`, ASGI records a
+`muscles.server.dispatch` span for matched routes with app, route, method and
+HTTP status attributes.
+
+## Action Bridge
+
+`ActionAsgiAdapter` is an optional HTTP projection for Muscles actions. It keeps
+package-specific features out of ASGI routes: packages register normal core
+actions, and ASGI exposes only the actions explicitly allowed by the project.
+
+```python
+from muscles.asgi import ActionAsgiAdapter
+
+application = ActionAsgiAdapter.from_application(
+    app,
+    allowed_actions={"bookings.echo"},
+)
+```
+
+The bridge accepts JSON `POST /actions/<action-name>` requests, executes through
+core `ActionDispatcher(..., transport="http")`, returns JSON for non-stream
+results, and returns `application/problem+json` for core action errors. Stream
+actions should be projected through `muscles-sse`.
+
+## Request Handling
+
+Request parsing does not require `cgi`, `multipart` or `python-magic` at import
+time. Multipart form data uses the standard library path, and missing MIME
+detection falls back safely.
+
+ASGI request execution is stateless on `Context`: request-specific data
+(`scope`, `receive`, `send`) is passed directly into `context.execute(...)`
+per request. The strategy keeps a persistent server lifecycle while request
+state stays isolated.
+
+## Development
+
+Run tests with sibling packages on `PYTHONPATH`:
+
+```bash
+PYTHONPATH=../muscles/src:src python -m pytest -q
+```
+
+Production notes: [docs/production.md](docs/production.md).

muscles_asgi-1.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry]
+name = "muscles-asgi"
+version = "1.0.0"
+description = "Muscles ASGI runtime adapter for Web/API applications"
+readme = "README.md"
+authors = ["Denis B. <denis@butko.info>"]
+license = "MIT"
+packages = [{include = "muscles", from = "src"}]
+
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+muscles = ">=1.0.0rc1,<2.0.0"
+watchdog = "^4.0.0"
+uwsgi = {version = "==2.0.20", optional = true}
+jinja2 = "==3.1.2"
+jsonschema = "==4.16.0"
+python-magic = {version = "==0.4.27", optional = true}
+requests = "^2.31.0"
+requests-toolbelt = "^1.0.0"
+dnspython = "==2.6.1"
+
+
+[tool.poetry.dev-dependencies]
+pytest = "==7.1.3"
+setuptools = "==69.0.2"
+
+[tool.poetry.extras]
+server = ["uwsgi"]
+mime = ["python-magic"]

muscles_asgi-1.0.0/src/muscles/asgi/Makefile

@@ -0,0 +1,26 @@
+# Makefile
+
+start:
+	docker-compose up -d
+	docker exec -it butkoinfo_core_1 bash
+
+
+stop:
+	docker-compose up -d
+	docker exec -it butkoinfo-core-1 bash
+
+
+console:
+	docker exec -it butkoinfo_core_1 bash
+
+
+logs:
+	docker-compose logs
+
+
+develop:
+	#docker exec -it butkoinfo_core_1 pipenv install
+	pipenv run python setup.py develop
+	pipenv install
+
+

muscles_asgi-1.0.0/src/muscles/asgi/__about__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+__name__ = "Muscular CLI Framework asgi"
+__version__ = "1.0.0.dev"
+__description__ = (
+    "Muscular CLI Framework"
+)

muscles_asgi-1.0.0/src/muscles/asgi/__init__.py

@@ -0,0 +1,62 @@
+from .asgi import *
+from .watchdog import *
+from .uwsgi import *
+from .template import Template
+from .template import *
+from .restful import *
+from .assets import *
+from .app import MuscularAsgiApp, asgi_app
+from .action_bridge import ActionAsgiAdapter
+from .providers import AsgiGeneratorProvider
+from .testing import TestClient, TestResponse
+
+
+__all__ = (
+    "Asset",
+    "RestApi",
+    "finalize_api",
+    "mount_api",
+    "mount_application_apis",
+    "TemplateLoader",
+    "Filters",
+    "Template",
+    "UwsgiReload",
+    "Watchdog",
+    "PatternMatchingHandler",
+    "ResponseErrorHandler",
+    "AsgiStrategy",
+    "ImproperBodyPartContentException",
+    "NonMultipartContentTypeException",
+    "BodyPart",
+    "FileStorage",
+    "FieldStorage",
+    "Request",
+    "Response",
+    "BadResponse",
+    "BaseResponse",
+    "MakeResponse",
+    "JsonResponse",
+    "HtmlResponse",
+    "code_status",
+    "Transport",
+    "AsgiTransport",
+    "AsgiServer",
+    "RouteRule",
+    "RouteRuleDefault",
+    "RouteRuleVar",
+    "RouteRuleInt",
+    "RouteRuleFloat",
+    "Itinerary",
+    "Node",
+    "Routes",
+    "Api",
+    "api",
+    "routes",
+    "itinerary",
+    "MuscularAsgiApp",
+    "asgi_app",
+    "ActionAsgiAdapter",
+    "AsgiGeneratorProvider",
+    "TestClient",
+    "TestResponse",
+)