diff --git a/Makefile b/Makefile
index 5086101..d5379d4 100644
--- a/Makefile
+++ b/Makefile
@@ -25,7 +25,7 @@ format: .pdm
.PHONY: lint ## Lint python source files
lint: .pdm
- pdm run ruff $(sources)
+ pdm run ruff check $(sources)
pdm run ruff format --check $(sources)
.PHONY: codespell ## Use Codespell to do spellchecking
diff --git a/pdm.lock b/pdm.lock
index 448349c..228059a 100644
--- a/pdm.lock
+++ b/pdm.lock
@@ -2,10 +2,10 @@
# It is not intended for manual editing.
[metadata]
-groups = ["default", "linting", "testing", "docs", "reload", "local-run", "rabbitmq"]
+groups = ["default", "linting", "testing", "docs", "reload", "local-run", "rabbitmq", "async-api-schema"]
strategy = ["cross_platform"]
lock_version = "4.4.1"
-content_hash = "sha256:014e81ab012600f3c8d1ed42590f55e645c9abf48e30112043531095ff26a422"
+content_hash = "sha256:d28330e5af1d25e0f029fd764c260b4eedb7e0929bc39116958584242bc5a7f1"
[[package]]
name = "annotated-types"
@@ -17,22 +17,6 @@ files = [
{file = "annotated_types-0.6.0.tar.gz", hash = "sha256:563339e807e53ffd9c267e99fc6d9ea23eb8443c08f112651963e24e22f84a5d"},
]
-[[package]]
-name = "anyio"
-version = "4.3.0"
-requires_python = ">=3.8"
-summary = "High level compatibility layer for multiple asynchronous event loop implementations"
-dependencies = [
- "exceptiongroup>=1.0.2; python_version < \"3.11\"",
- "idna>=2.8",
- "sniffio>=1.1",
- "typing-extensions>=4.1; python_version < \"3.11\"",
-]
-files = [
- {file = "anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8"},
- {file = "anyio-4.3.0.tar.gz", hash = "sha256:f75253795a87df48568485fd18cdd2a3fa5c4f7c5be8e5e36637733fce06fed6"},
-]
-
[[package]]
name = "babel"
version = "2.14.0"
@@ -813,15 +797,15 @@ files = [
[[package]]
name = "pyright"
-version = "1.1.355"
+version = "1.1.356"
requires_python = ">=3.7"
summary = "Command line wrapper for pyright"
dependencies = [
"nodeenv>=1.6.0",
]
files = [
- {file = "pyright-1.1.355-py3-none-any.whl", hash = "sha256:bf30b6728fd68ae7d09c98292b67152858dd89738569836896df786e52b5fe48"},
- {file = "pyright-1.1.355.tar.gz", hash = "sha256:dca4104cd53d6484e6b1b50b7a239ad2d16d2ffd20030bcf3111b56f44c263bf"},
+ {file = "pyright-1.1.356-py3-none-any.whl", hash = "sha256:a101b0f375f93d7082f9046cfaa7ba15b7cf8e1939ace45e984c351f6e8feb99"},
+ {file = "pyright-1.1.356.tar.gz", hash = "sha256:f05b8b29d06b96ed4a0885dad5a31d9dff691ca12b2f658249f583d5f2754021"},
]
[[package]]
@@ -1072,16 +1056,6 @@ files = [
{file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
]
-[[package]]
-name = "sniffio"
-version = "1.3.1"
-requires_python = ">=3.7"
-summary = "Sniff out which async library your code is running under"
-files = [
- {file = "sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2"},
- {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"},
-]
-
[[package]]
name = "tomli"
version = "2.0.1"
@@ -1094,16 +1068,16 @@ files = [
[[package]]
name = "typer"
-version = "0.10.0"
-requires_python = ">=3.6"
+version = "0.11.0"
+requires_python = ">=3.7"
summary = "Typer, build great CLIs. Easy to code. Based on Python type hints."
dependencies = [
- "click<9.0.0,>=7.1.1",
+ "click>=8.0.0",
"typing-extensions>=3.7.4.3",
]
files = [
- {file = "typer-0.10.0-py3-none-any.whl", hash = "sha256:b8a587aa06d3c5422c09c2e9935eb80b4c9de8605fd5ab702b2f92d72246ca48"},
- {file = "typer-0.10.0.tar.gz", hash = "sha256:597f974754520b091665f993f88abdd088bb81c56b3042225434ced0b50a788b"},
+ {file = "typer-0.11.0-py3-none-any.whl", hash = "sha256:049cc47bef39f46b043eddd9165492209fdd9bc7d79afa7ba9cc5cd017caa817"},
+ {file = "typer-0.11.0.tar.gz", hash = "sha256:a6ce173c0f03d3a41b49c0a945874cc489e91f88faabf76517b2b91c670fcde7"},
]
[[package]]
@@ -1166,68 +1140,6 @@ files = [
{file = "watchdog-4.0.0.tar.gz", hash = "sha256:e3e7065cbdabe6183ab82199d7a4f6b3ba0a438c5a512a68559846ccb76a78ec"},
]
-[[package]]
-name = "watchfiles"
-version = "0.21.0"
-requires_python = ">=3.8"
-summary = "Simple, modern and high performance file watching and code reload in python."
-dependencies = [
- "anyio>=3.0.0",
-]
-files = [
- {file = "watchfiles-0.21.0-cp310-cp310-macosx_10_7_x86_64.whl", hash = "sha256:27b4035013f1ea49c6c0b42d983133b136637a527e48c132d368eb19bf1ac6aa"},
- {file = "watchfiles-0.21.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c81818595eff6e92535ff32825f31c116f867f64ff8cdf6562cd1d6b2e1e8f3e"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:6c107ea3cf2bd07199d66f156e3ea756d1b84dfd43b542b2d870b77868c98c03"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0d9ac347653ebd95839a7c607608703b20bc07e577e870d824fa4801bc1cb124"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5eb86c6acb498208e7663ca22dbe68ca2cf42ab5bf1c776670a50919a56e64ab"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f564bf68404144ea6b87a78a3f910cc8de216c6b12a4cf0b27718bf4ec38d303"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3d0f32ebfaa9c6011f8454994f86108c2eb9c79b8b7de00b36d558cadcedaa3d"},
- {file = "watchfiles-0.21.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b6d45d9b699ecbac6c7bd8e0a2609767491540403610962968d258fd6405c17c"},
- {file = "watchfiles-0.21.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:aff06b2cac3ef4616e26ba17a9c250c1fe9dd8a5d907d0193f84c499b1b6e6a9"},
- {file = "watchfiles-0.21.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:d9792dff410f266051025ecfaa927078b94cc7478954b06796a9756ccc7e14a9"},
- {file = "watchfiles-0.21.0-cp310-none-win32.whl", hash = "sha256:214cee7f9e09150d4fb42e24919a1e74d8c9b8a9306ed1474ecaddcd5479c293"},
- {file = "watchfiles-0.21.0-cp310-none-win_amd64.whl", hash = "sha256:1ad7247d79f9f55bb25ab1778fd47f32d70cf36053941f07de0b7c4e96b5d235"},
- {file = "watchfiles-0.21.0-cp311-cp311-macosx_10_7_x86_64.whl", hash = "sha256:668c265d90de8ae914f860d3eeb164534ba2e836811f91fecc7050416ee70aa7"},
- {file = "watchfiles-0.21.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3a23092a992e61c3a6a70f350a56db7197242f3490da9c87b500f389b2d01eef"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:e7941bbcfdded9c26b0bf720cb7e6fd803d95a55d2c14b4bd1f6a2772230c586"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:11cd0c3100e2233e9c53106265da31d574355c288e15259c0d40a4405cbae317"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d78f30cbe8b2ce770160d3c08cff01b2ae9306fe66ce899b73f0409dc1846c1b"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6674b00b9756b0af620aa2a3346b01f8e2a3dc729d25617e1b89cf6af4a54eb1"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fd7ac678b92b29ba630d8c842d8ad6c555abda1b9ef044d6cc092dacbfc9719d"},
- {file = "watchfiles-0.21.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9c873345680c1b87f1e09e0eaf8cf6c891b9851d8b4d3645e7efe2ec20a20cc7"},
- {file = "watchfiles-0.21.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:49f56e6ecc2503e7dbe233fa328b2be1a7797d31548e7a193237dcdf1ad0eee0"},
- {file = "watchfiles-0.21.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:02d91cbac553a3ad141db016e3350b03184deaafeba09b9d6439826ee594b365"},
- {file = "watchfiles-0.21.0-cp311-none-win32.whl", hash = "sha256:ebe684d7d26239e23d102a2bad2a358dedf18e462e8808778703427d1f584400"},
- {file = "watchfiles-0.21.0-cp311-none-win_amd64.whl", hash = "sha256:4566006aa44cb0d21b8ab53baf4b9c667a0ed23efe4aaad8c227bfba0bf15cbe"},
- {file = "watchfiles-0.21.0-cp311-none-win_arm64.whl", hash = "sha256:c550a56bf209a3d987d5a975cdf2063b3389a5d16caf29db4bdddeae49f22078"},
- {file = "watchfiles-0.21.0-cp312-cp312-macosx_10_7_x86_64.whl", hash = "sha256:51ddac60b96a42c15d24fbdc7a4bfcd02b5a29c047b7f8bf63d3f6f5a860949a"},
- {file = "watchfiles-0.21.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:511f0b034120cd1989932bf1e9081aa9fb00f1f949fbd2d9cab6264916ae89b1"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:cfb92d49dbb95ec7a07511bc9efb0faff8fe24ef3805662b8d6808ba8409a71a"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3f92944efc564867bbf841c823c8b71bb0be75e06b8ce45c084b46411475a915"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:642d66b75eda909fd1112d35c53816d59789a4b38c141a96d62f50a3ef9b3360"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d23bcd6c8eaa6324fe109d8cac01b41fe9a54b8c498af9ce464c1aeeb99903d6"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:18d5b4da8cf3e41895b34e8c37d13c9ed294954907929aacd95153508d5d89d7"},
- {file = "watchfiles-0.21.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1b8d1eae0f65441963d805f766c7e9cd092f91e0c600c820c764a4ff71a0764c"},
- {file = "watchfiles-0.21.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1fd9a5205139f3c6bb60d11f6072e0552f0a20b712c85f43d42342d162be1235"},
- {file = "watchfiles-0.21.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a1e3014a625bcf107fbf38eece0e47fa0190e52e45dc6eee5a8265ddc6dc5ea7"},
- {file = "watchfiles-0.21.0-cp312-none-win32.whl", hash = "sha256:9d09869f2c5a6f2d9df50ce3064b3391d3ecb6dced708ad64467b9e4f2c9bef3"},
- {file = "watchfiles-0.21.0-cp312-none-win_amd64.whl", hash = "sha256:18722b50783b5e30a18a8a5db3006bab146d2b705c92eb9a94f78c72beb94094"},
- {file = "watchfiles-0.21.0-cp312-none-win_arm64.whl", hash = "sha256:a3b9bec9579a15fb3ca2d9878deae789df72f2b0fdaf90ad49ee389cad5edab6"},
- {file = "watchfiles-0.21.0-pp310-pypy310_pp73-macosx_10_7_x86_64.whl", hash = "sha256:ab03a90b305d2588e8352168e8c5a1520b721d2d367f31e9332c4235b30b8994"},
- {file = "watchfiles-0.21.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:927c589500f9f41e370b0125c12ac9e7d3a2fd166b89e9ee2828b3dda20bfe6f"},
- {file = "watchfiles-0.21.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1bd467213195e76f838caf2c28cd65e58302d0254e636e7c0fca81efa4a2e62c"},
- {file = "watchfiles-0.21.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:02b73130687bc3f6bb79d8a170959042eb56eb3a42df3671c79b428cd73f17cc"},
- {file = "watchfiles-0.21.0-pp38-pypy38_pp73-macosx_10_7_x86_64.whl", hash = "sha256:08dca260e85ffae975448e344834d765983237ad6dc308231aa16e7933db763e"},
- {file = "watchfiles-0.21.0-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:3ccceb50c611c433145502735e0370877cced72a6c70fd2410238bcbc7fe51d8"},
- {file = "watchfiles-0.21.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:57d430f5fb63fea141ab71ca9c064e80de3a20b427ca2febcbfcef70ff0ce895"},
- {file = "watchfiles-0.21.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0dd5fad9b9c0dd89904bbdea978ce89a2b692a7ee8a0ce19b940e538c88a809c"},
- {file = "watchfiles-0.21.0-pp39-pypy39_pp73-macosx_10_7_x86_64.whl", hash = "sha256:be6dd5d52b73018b21adc1c5d28ac0c68184a64769052dfeb0c5d9998e7f56a2"},
- {file = "watchfiles-0.21.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:b3cab0e06143768499384a8a5efb9c4dc53e19382952859e4802f294214f36ec"},
- {file = "watchfiles-0.21.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c6ed10c2497e5fedadf61e465b3ca12a19f96004c15dcffe4bd442ebadc2d85"},
- {file = "watchfiles-0.21.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:43babacef21c519bc6631c5fce2a61eccdfc011b4bcb9047255e9620732c8097"},
- {file = "watchfiles-0.21.0.tar.gz", hash = "sha256:c76c635fabf542bb78524905718c39f736a98e5ab25b23ec6d4abede1a85a6a3"},
-]
-
[[package]]
name = "zipp"
version = "3.18.1"
diff --git a/pyproject.toml b/pyproject.toml
index 5e46e5f..0e99164 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[project]
name = "message-flow"
-version = "0.3.3"
+version = "0.3.4"
description = "Asynchronous Communication Framework"
authors = [
{name = "Valentin Vorobyev", email = "voro6yov.valentin@gmail.com"},
diff --git a/src/message_flow/cli/_async_api_schema/__init__.py b/src/message_flow/cli/_async_api_schema/__init__.py
new file mode 100644
index 0000000..bf650ef
--- /dev/null
+++ b/src/message_flow/cli/_async_api_schema/__init__.py
@@ -0,0 +1,3 @@
+from ...utils import init_package
+
+init_package(__name__)
diff --git a/src/message_flow/cli/_async_api_schema/__init__.pyi b/src/message_flow/cli/_async_api_schema/__init__.pyi
new file mode 100644
index 0000000..05be764
--- /dev/null
+++ b/src/message_flow/cli/_async_api_schema/__init__.pyi
@@ -0,0 +1,2 @@
+from .request_handler import *
+from .server import *
diff --git a/src/message_flow/cli/_async_api_schema/request_handler.py b/src/message_flow/cli/_async_api_schema/request_handler.py
new file mode 100644
index 0000000..8e81041
--- /dev/null
+++ b/src/message_flow/cli/_async_api_schema/request_handler.py
@@ -0,0 +1,93 @@
+import json
+from http.server import BaseHTTPRequestHandler
+
+from ...utils import internal
+
+
+@internal
+class RequestHandler(BaseHTTPRequestHandler):
+ schema: str
+
+ def do_GET(self):
+ if self.path == "/async-api-docs":
+ self._send_async_api_schema()
+ else:
+ self._send_not_found()
+
+ def _send_async_api_schema(self) -> None:
+ self._set_headers()
+ self.wfile.write(self._make_asyncapi_html().encode())
+
+ def _send_not_found(self) -> None:
+ self._set_headers(404, "text/plain")
+ self.wfile.write(b"404 Not Found")
+
+ def _set_headers(self, status: int = 200, content_type: str = "text/html"):
+ self.send_response(status)
+ self.send_header("Content-type", content_type)
+ self.end_headers()
+
+ def _make_asyncapi_html(
+ self,
+ ) -> str:
+ config = {
+ "schema": self.schema,
+ "config": {
+ "show": {
+ "sidebar": True,
+ "info": True,
+ "servers": True,
+ "operations": True,
+ "messages": True,
+ "schemas": True,
+ "errors": True,
+ },
+ "expand": {
+ "messageExamples": True,
+ },
+ "sidebar": {
+ "showServers": "byDefault",
+ "showOperations": "byDefault",
+ },
+ },
+ }
+
+ return (
+ """
+
+
+
+ """
+ f"""
+ MessageFlow AsyncAPI
+ """
+ """
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ """
+ )
diff --git a/src/message_flow/cli/_async_api_schema/server.py b/src/message_flow/cli/_async_api_schema/server.py
new file mode 100644
index 0000000..a1ad8c4
--- /dev/null
+++ b/src/message_flow/cli/_async_api_schema/server.py
@@ -0,0 +1,17 @@
+from http.server import HTTPServer
+
+from .request_handler import RequestHandler
+
+__all__ = ["serve_schema"]
+
+
+def serve_schema(
+ schema: str,
+ host: str,
+ port: int,
+) -> None:
+ RequestHandler.schema = schema
+
+ httpd = HTTPServer((host, port), RequestHandler)
+
+ httpd.serve_forever()
diff --git a/src/message_flow/cli/cli_app.py b/src/message_flow/cli/cli_app.py
index e48c6eb..18f6fee 100644
--- a/src/message_flow/cli/cli_app.py
+++ b/src/message_flow/cli/cli_app.py
@@ -24,7 +24,7 @@ class CLIApp:
},
)
- def __init__(self, app_path: str, log_level: LoggingLevel) -> None:
+ def __init__(self, app_path: str, log_level: LoggingLevel = LoggingLevel.INFO) -> None:
self.app_path = app_path
self.instance.set_logging_level(self.LOGGING_LEVELS[log_level])
@@ -77,6 +77,9 @@ def instance(self) -> MessageFlow:
def dispatch(self) -> None:
self.instance.dispatch()
+ def make_async_api_schema(self) -> str:
+ return self.instance.make_async_api_schema()
+
def _import(self) -> MessageFlow:
spec = spec_from_file_location(
"mode",
diff --git a/src/message_flow/cli/main.py b/src/message_flow/cli/main.py
index 04270c2..facd096 100644
--- a/src/message_flow/cli/main.py
+++ b/src/message_flow/cli/main.py
@@ -1,5 +1,6 @@
import typer
+from ._async_api_schema import serve_schema
from .cli_app import CLIApp
from .logging_level import LoggingLevel
@@ -29,8 +30,31 @@ def dispatch(
),
):
"""
- Shoot the portal gun
+ Starts message dispatching
"""
cli_app = CLIApp(app, log_level)
cli_app.dispatch()
+
+
+@cli.command()
+def docs(
+ app: str = typer.Argument(
+ ...,
+ help="[python_module:MessageFlow] - path to your application",
+ ),
+ host: str = typer.Option(
+ "localhost",
+ help="documentation hosting address",
+ ),
+ port: int = typer.Option(
+ 8000,
+ help="documentation hosting port",
+ ),
+):
+ """
+ Starts Async API schema serving
+ """
+ cli_app = CLIApp(app)
+
+ serve_schema(schema=cli_app.make_async_api_schema(), host=host, port=port)