fastnode pre-releasw

khulnasoft · Aug 4, 2024 · 51106da · 51106da
1 parent 8f9e786
commit 51106da
Show file tree

Hide file tree

Showing 27 changed files with 3,650 additions and 101 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -5,4 +5,4 @@
 # For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.
 
 # These are the default owners for the whole content of this repository. The default owners are automatically added as reviewers when you open a pull request, unless different owners are specified in the file.
-* @LukasMasuch @raethlein @JanKalkan
+* @khulnasoft-bot @nxpkg @gitworkflows
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@
   <a href="https://github.com/khulnasoft/fastnode/releases">Changelog</a>
 </p>
 
-Instantly turn your Python functions into production-ready microservices. Deploy and access your services via HTTP API or interactive UI. Seamlessly export your services into portable, shareable, and executable files or Docker images. Fastnode builds on open standards - OpenAPI,  JSON Schema, and Python type hints - and is powered by FastAPI, Streamlit, and Pydantic. It cuts out all the pain for productizing and sharing your Python code - or anything you can wrap into a single Python function.
+Instantly turn your Python functions into production-ready microservices. Deploy and access your services via HTTP API or interactive UI. Seamlessly export your services into portable, shareable, and executable files or Docker images. Fastnode builds on open standards - OpenAPI,  JSON Schema, and Python type hints - and is powered by ReadyAPI, Streamlit, and Pydantic. It cuts out all the pain for productizing and sharing your Python code - or anything you can wrap into a single Python function.
 
 <sup>Alpha Version: Only suggested for experimental usage.</sup>
 
@@ -43,7 +43,7 @@ Instantly turn your Python functions into production-ready microservices. Deploy
 ## Highlights
 
 - 🪄&nbsp; Turn functions into production-ready services within seconds.
-- 🔌&nbsp; Auto-generated HTTP API based on FastAPI.
+- 🔌&nbsp; Auto-generated HTTP API based on ReadyAPI.
 - 🌅&nbsp; Auto-generated Web UI based on Streamlit.
 - 📦&nbsp; Save and share as self-contained executable file or Docker image.
 - 🧩&nbsp; Reuse pre-defined components & combine with existing Fastnodes.
@@ -335,7 +335,7 @@ Visit http://localhost:8051 in your browser to access the UI of the demo. Use `l
 
 ## Support & Feedback
 
-This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein), [Lukas Masuch](https://twitter.com/LukasMasuch), and [Jan Kalkan](https://www.linkedin.com/in/jan-kalkan-b5390284/). Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from it.
+This project is maintained by [Benjamin Räthlein](https://twitter.com/nxpkg), [Lukas Masuch](https://twitter.com/khulnasoft-bot), and [Jan Kalkan](https://www.linkedin.com/in/jan-kalkan-b5390284/). Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from it.
 
 | Type                     | Channel                                              |
 | ------------------------ | ------------------------------------------------------ |
@@ -365,7 +365,7 @@ With Fastnode, you can instantly launch a local HTTP (REST) API server for any [
 fastnode launch-api my_fastnode:hello_world
 ```
 
-This will launch a [FastAPI](https://fastapi.tiangolo.com/) server based on the [OpenAPI standard](https://swagger.io/specification) and with an automatic interactive documentation.
+This will launch a [ReadyAPI](https://readyapi.tiangolo.com/) server based on the [OpenAPI standard](https://swagger.io/specification) and with an automatic interactive documentation.
 
 <img style="width: 100%" src="https://raw.githubusercontent.com/khulnasoft/fastnode/main/docs/images/fastnode-hello-world-api.png"/>
 

diff --git a/build.py b/build.py
@@ -29,7 +29,7 @@ def main(args: dict) -> None:
     if args.get(build_utils.FLAG_MAKE):
         # Install pipenv dev requirements
         build_python.install_build_env(exit_on_error=True)
-        # Create API documentation via lazydocs
+        # Create API documentation via docsai
         build_python.generate_api_docs(
             github_url=GITHUB_URL, main_package=MAIN_PACKAGE, exit_on_error=True
         )

diff --git a/docs/README.md b/docs/README.md
@@ -5,8 +5,8 @@
 ## Modules
 
 - [`fastnode.api`](./fastnode.api.md#module-fastnodeapi)
-- [`fastnode.api.fastapi_app`](./fastnode.api.fastapi_app.md#module-fastnodeapifastapi_app)
-- [`fastnode.api.fastapi_utils`](./fastnode.api.fastapi_utils.md#module-fastnodeapifastapi_utils): Collection of utilities for FastAPI apps.
+- [`fastnode.api.readyapi_app`](./fastnode.api.readyapi_app.md#module-fastnodeapireadyapi_app)
+- [`fastnode.api.readyapi_utils`](./fastnode.api.readyapi_utils.md#module-fastnodeapireadyapi_utils): Collection of utilities for ReadyAPI apps.
 - [`fastnode.components`](./fastnode.components.md#module-fastnodecomponents)
 - [`fastnode.components.outputs`](./fastnode.components.outputs.md#module-fastnodecomponentsoutputs)
 - [`fastnode.components.types`](./fastnode.components.types.md#module-fastnodecomponentstypes)
@@ -32,10 +32,10 @@
 
 ## Functions
 
-- [`fastapi_app.create_api`](./fastnode.api.fastapi_app.md#function-create_api)
-- [`fastapi_app.launch_api`](./fastnode.api.fastapi_app.md#function-launch_api)
-- [`fastapi_utils.as_form`](./fastnode.api.fastapi_utils.md#function-as_form): Adds an as_form class method to decorated models.
-- [`fastapi_utils.patch_fastapi`](./fastnode.api.fastapi_utils.md#function-patch_fastapi): Patch function to allow relative url resolution.
+- [`readyapi_app.create_api`](./fastnode.api.readyapi_app.md#function-create_api)
+- [`readyapi_app.launch_api`](./fastnode.api.readyapi_app.md#function-launch_api)
+- [`readyapi_utils.as_form`](./fastnode.api.readyapi_utils.md#function-as_form): Adds an as_form class method to decorated models.
+- [`readyapi_utils.patch_readyapi`](./fastnode.api.readyapi_utils.md#function-patch_readyapi): Patch function to allow relative url resolution.
 - [`core.get_callable`](./fastnode.core.md#function-get_callable): Import a callable from an string.
 - [`core.get_input_type`](./fastnode.core.md#function-get_input_type): Returns the input type of a given function (callable).
 - [`core.get_output_type`](./fastnode.core.md#function-get_output_type): Returns the output type of a given function (callable).
@@ -70,4 +70,4 @@
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.api.fastapi_app.md b/docs/fastnode.api.fastapi_app.md
diff --git a/docs/fastnode.api.fastapi_utils.md b/docs/fastnode.api.fastapi_utils.md
@@ -1,14 +1,14 @@
 <!-- markdownlint-disable -->
 
-<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/fastapi_utils.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
-# <kbd>module</kbd> `fastnode.api.fastapi_utils`
-Collection of utilities for FastAPI apps. 
+# <kbd>module</kbd> `fastnode.api.readyapi_utils`
+Collection of utilities for ReadyAPI apps. 
 
 
 ---
 
-<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/fastapi_utils.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
 ## <kbd>function</kbd> `as_form`
 
@@ -18,26 +18,26 @@ as_form(cls: Type[BaseModel]) → Any
 
 Adds an as_form class method to decorated models. 
 
-The as_form class method can be used with FastAPI endpoints 
+The as_form class method can be used with ReadyAPI endpoints 
 
 
 ---
 
-<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/fastapi_utils.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
 
-## <kbd>function</kbd> `patch_fastapi`
+## <kbd>function</kbd> `patch_readyapi`
 
 ```python
-patch_fastapi(app: FastAPI) → None
+patch_readyapi(app: ReadyAPI) → None
 ```
 
 Patch function to allow relative url resolution. 
 
-This patch is required to make fastapi fully functional with a relative url path. This code snippet can be copy-pasted to any Fastapi application. 
+This patch is required to make readyapi fully functional with a relative url path. This code snippet can be copy-pasted to any Readyapi application. 
 
 
 
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.api.md b/docs/fastnode.api.md
@@ -9,12 +9,12 @@
 
 **Global Variables**
 ---------------
-- **fastapi_utils**
-- **fastapi_app**
+- **readyapi_utils**
+- **readyapi_app**
 
 
 
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.api.readyapi_app.md b/docs/fastnode.api.readyapi_app.md
@@ -0,0 +1,45 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_app.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `fastnode.api.readyapi_app`
+
+
+
+
+
+---
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_app.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `launch_api`
+
+```python
+launch_api(fastnode_path: str, port: int = 8501, host: str = '0') → None
+```
+
+
+
+
+
+
+---
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_app.py#L21"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `create_api`
+
+```python
+create_api(fastnode: Fastnode) → ReadyAPI
+```
+
+
+
+
+
+
+
+
+---
+
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.api.readyapi_utils.md b/docs/fastnode.api.readyapi_utils.md
@@ -0,0 +1,43 @@
+<!-- markdownlint-disable -->
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+# <kbd>module</kbd> `fastnode.api.readyapi_utils`
+Collection of utilities for ReadyAPI apps. 
+
+
+---
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `as_form`
+
+```python
+as_form(cls: Type[BaseModel]) → Any
+```
+
+Adds an as_form class method to decorated models. 
+
+The as_form class method can be used with ReadyAPI endpoints 
+
+
+---
+
+<a href="https://github.com/khulnasoft/fastnode/blob/main/src/fastnode/api/readyapi_utils.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
+
+## <kbd>function</kbd> `patch_readyapi`
+
+```python
+patch_readyapi(app: ReadyAPI) → None
+```
+
+Patch function to allow relative url resolution. 
+
+This patch is required to make readyapi fully functional with a relative url path. This code snippet can be copy-pasted to any Readyapi application. 
+
+
+
+
+---
+
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.components.md b/docs/fastnode.components.md
@@ -13,4 +13,4 @@
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.components.outputs.md b/docs/fastnode.components.outputs.md
@@ -53,4 +53,4 @@ render_output_ui(streamlit) → None
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.components.types.md b/docs/fastnode.components.types.md
@@ -68,4 +68,4 @@ validate(value: Any) → FileContent
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.core.md b/docs/fastnode.core.md
@@ -158,4 +158,4 @@ __init__(func: Union[Callable, str]) → None
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.export.md b/docs/fastnode.export.md
@@ -24,4 +24,4 @@ An enumeration.
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.tasks.md b/docs/fastnode.tasks.md
@@ -13,4 +13,4 @@
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.ui.md b/docs/fastnode.ui.md
@@ -18,4 +18,4 @@
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.ui.schema_utils.md b/docs/fastnode.ui.schema_utils.md
@@ -237,4 +237,4 @@ is_object_list_property(property: Dict, references: Dict) → bool
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.ui.streamlit_ui.md b/docs/fastnode.ui.streamlit_ui.md
@@ -214,4 +214,4 @@ render_ui() → None
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.ui.streamlit_utils.md b/docs/fastnode.ui.streamlit_utils.md
@@ -114,4 +114,4 @@ clear() → None
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/docs/fastnode.utils.md b/docs/fastnode.utils.md
@@ -13,4 +13,4 @@
 
 ---
 
-_This file was automatically generated via [lazydocs](https://github.com/khulnasoft/lazydocs)._
+_This file was automatically generated via [docsai](https://github.com/khulnasoft/docsai)._
diff --git a/setup.py b/setup.py
@@ -47,7 +47,7 @@
     zip_safe=False,
     install_requires=[
         "typer",
-        "fastapi",
+        "readyapi",
         "uvicorn",
         "streamlit>=0.72",
         "plotly",
@@ -73,7 +73,7 @@
             "black",
             "pydocstyle",
             "isort",
-            "lazydocs",
+            "docsai",
         ],
     },
     include_package_data=True,

diff --git a/src/fastnode/_cli.py b/src/fastnode/_cli.py
@@ -30,13 +30,13 @@ def launch_api(
 ) -> None:
     """Start a HTTP API server for the fastnode.
 
-    This will launch a FastAPI server based on the OpenAPI standard and with an automatic interactive documentation.
+    This will launch a ReadyAPI server based on the OpenAPI standard and with an automatic interactive documentation.
     """
     # Add the current working directory to the sys path
     # This is required to resolve the fastnode path
     sys.path.append(os.getcwd())
 
-    from fastnode.api.fastapi_app import launch_api  # type: ignore
+    from fastnode.api.readyapi_app import launch_api  # type: ignore
 
     launch_api(fastnode, port, host)
 

diff --git a/src/fastnode/api/__init__.py b/src/fastnode/api/__init__.py
@@ -1 +1 @@
-from .fastapi_app import create_api
+from .readyapi_app import create_api