jvserve 2.0.0__tar.gz

jvserve-2.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

jvserve-2.0.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.2
+Name: jvserve
+Version: 2.0.0
+Summary: FastAPI webserver for loading and interaction with JIVAS agents.
+Home-page: https://github.com/TrueSelph/jvserve
+Author: TrueSelph Inc.
+Author-email: admin@trueselph.com
+Keywords: jivas
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jac-cloud>=0.1.19
+Requires-Dist: pyaml>=25.1.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: aiohttp>=3.10.10
+Requires-Dist: schedule>=1.2.2
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# JIVAS Web Server (jvserve)
+
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/TrueSelph/jvserve)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TrueSelph/jvserve/test-jvserve.yaml)
+![GitHub issues](https://img.shields.io/github/issues/TrueSelph/jvserve)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/TrueSelph/jvserve)
+![GitHub](https://img.shields.io/github/license/TrueSelph/jvserve)
+
+`jvserve` is a FastAPI-based web server designed for loading and interacting with JIVAS agents. It is built on top of [`jac-cloud`](https://github.com/Jaseci-Labs/jaseci/tree/main/jac-cloud) and provides a robust platform for managing jivas agent jobs, handling webhooks, and executing actions within the JIVAS ecosystem.
+
+## Installation
+
+To install `jvserve`, use `pip`:
+
+```sh
+pip install jvserve
+```
+
+## Usage
+
+To use `jvserve`, you can start the server with the following command:
+
+```sh
+jac jvserve <path_to_your_jac_file>
+```
+
+For example:
+
+```sh
+jac jvserve main.jac
+```
+
+You can also start a file server to serve static files:
+
+```sh
+jac jvfileserve <directory>
+```
+
+For example:
+
+```sh
+jac jvfileserve ./static
+```
+
+### Supported Arguments
+
+- **filename**: Path to your JAC file.
+- **host**: Host address to bind the server (default: `0.0.0.0`).
+- **port**: Port number to bind the server (default: `8000`).
+- **loglevel**: Logging level (default: `INFO`).
+- **workers**: Number of worker processes (optional).
+
+Example with all arguments:
+
+```sh
+jac jvserve main.jac --host 127.0.0.1 --port 8080 --loglevel DEBUG --workers 4
+```
+
+## API Endpoints
+
+- **Interact with Agent**: `/interact` (POST)
+- **Execute Webhook**: `/webhook/{key}` (GET, POST)
+- **Execute Action Walker**: `/action/walker` (POST)
+
+You can see all endpoints at the URL `/docs`.
+
+## 🔰 Contributing
+
+- **🐛 [Report Issues](https://github.com/TrueSelph/jvserve/issues)**: Submit bugs found or log feature requests for the `jvserve` project.
+- **💡 [Submit Pull Requests](https://github.com/TrueSelph/jvserve/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
+
+<details closed>
+<summary>Contributing Guidelines</summary>
+
+1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
+2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
+   ```sh
+   git clone https://github.com/TrueSelph/jvserve
+   ```
+3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
+   ```sh
+   git checkout -b new-feature-x
+   ```
+4. **Make Your Changes**: Develop and test your changes locally.
+5. **Commit Your Changes**: Commit with a clear message describing your updates.
+   ```sh
+   git commit -m 'Implemented new feature x.'
+   ```
+6. **Push to GitHub**: Push the changes to your forked repository.
+   ```sh
+   git push origin new-feature-x
+   ```
+7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
+8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
+</details>
+
+<details open>
+<summary>Contributor Graph</summary>
+<br>
+<p align="left">
+    <a href="https://github.com/TrueSelph/jvserve/graphs/contributors">
+        <img src="https://contrib.rocks/image?repo=TrueSelph/jvserve" />
+   </a>
+</p>
+</details>
+
+## 🎗 License
+
+This project is protected under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.
+
+## Additional Information
+
+Since `jvserve` is a wrapper around `jac-cloud`, it supports all the primitives available in `jac-cloud`. You can find more information about `jac-cloud` primitives [here](https://www.jac-lang.org/for_coders/jac-cloud/jac_cloud/).

jvserve-2.0.0/README.md

@@ -0,0 +1,113 @@
+# JIVAS Web Server (jvserve)
+
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/TrueSelph/jvserve)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TrueSelph/jvserve/test-jvserve.yaml)
+![GitHub issues](https://img.shields.io/github/issues/TrueSelph/jvserve)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/TrueSelph/jvserve)
+![GitHub](https://img.shields.io/github/license/TrueSelph/jvserve)
+
+`jvserve` is a FastAPI-based web server designed for loading and interacting with JIVAS agents. It is built on top of [`jac-cloud`](https://github.com/Jaseci-Labs/jaseci/tree/main/jac-cloud) and provides a robust platform for managing jivas agent jobs, handling webhooks, and executing actions within the JIVAS ecosystem.
+
+## Installation
+
+To install `jvserve`, use `pip`:
+
+```sh
+pip install jvserve
+```
+
+## Usage
+
+To use `jvserve`, you can start the server with the following command:
+
+```sh
+jac jvserve <path_to_your_jac_file>
+```
+
+For example:
+
+```sh
+jac jvserve main.jac
+```
+
+You can also start a file server to serve static files:
+
+```sh
+jac jvfileserve <directory>
+```
+
+For example:
+
+```sh
+jac jvfileserve ./static
+```
+
+### Supported Arguments
+
+- **filename**: Path to your JAC file.
+- **host**: Host address to bind the server (default: `0.0.0.0`).
+- **port**: Port number to bind the server (default: `8000`).
+- **loglevel**: Logging level (default: `INFO`).
+- **workers**: Number of worker processes (optional).
+
+Example with all arguments:
+
+```sh
+jac jvserve main.jac --host 127.0.0.1 --port 8080 --loglevel DEBUG --workers 4
+```
+
+## API Endpoints
+
+- **Interact with Agent**: `/interact` (POST)
+- **Execute Webhook**: `/webhook/{key}` (GET, POST)
+- **Execute Action Walker**: `/action/walker` (POST)
+
+You can see all endpoints at the URL `/docs`.
+
+## 🔰 Contributing
+
+- **🐛 [Report Issues](https://github.com/TrueSelph/jvserve/issues)**: Submit bugs found or log feature requests for the `jvserve` project.
+- **💡 [Submit Pull Requests](https://github.com/TrueSelph/jvserve/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
+
+<details closed>
+<summary>Contributing Guidelines</summary>
+
+1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
+2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
+   ```sh
+   git clone https://github.com/TrueSelph/jvserve
+   ```
+3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
+   ```sh
+   git checkout -b new-feature-x
+   ```
+4. **Make Your Changes**: Develop and test your changes locally.
+5. **Commit Your Changes**: Commit with a clear message describing your updates.
+   ```sh
+   git commit -m 'Implemented new feature x.'
+   ```
+6. **Push to GitHub**: Push the changes to your forked repository.
+   ```sh
+   git push origin new-feature-x
+   ```
+7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
+8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
+</details>
+
+<details open>
+<summary>Contributor Graph</summary>
+<br>
+<p align="left">
+    <a href="https://github.com/TrueSelph/jvserve/graphs/contributors">
+        <img src="https://contrib.rocks/image?repo=TrueSelph/jvserve" />
+   </a>
+</p>
+</details>
+
+## 🎗 License
+
+This project is protected under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.
+
+## Additional Information
+
+Since `jvserve` is a wrapper around `jac-cloud`, it supports all the primitives available in `jac-cloud`. You can find more information about `jac-cloud` primitives [here](https://www.jac-lang.org/for_coders/jac-cloud/jac_cloud/).

jvserve-2.0.0/jvserve/__init__.py

@@ -0,0 +1,8 @@
+"""
+jvserve package initialization.
+
+This package provides the webserver for loading and interacting with JIVAS agents.
+"""
+
+__version__ = "2.0.0"
+__supported__jivas__versions__ = ["2.0.0"]

jvserve-2.0.0/jvserve/cli.py

@@ -0,0 +1,138 @@
+"""Module for registering CLI plugins for jaseci."""
+
+import logging
+import os
+import time
+from contextlib import asynccontextmanager
+from typing import AsyncIterator, Optional
+
+from jac_cloud.jaseci.security import authenticator
+from jaclang.cli.cmdreg import cmd_registry
+from jaclang.plugin.default import hookimpl
+from jaclang.runtimelib.context import ExecutionContext
+from jaclang.runtimelib.machine import JacMachine
+from uvicorn import run as _run
+
+from jvserve.lib.agent_interface import AgentInterface
+from jvserve.lib.agent_pulse import AgentPulse
+from jvserve.lib.jvlogger import JVLogger
+
+
+class JacCmd:
+    """Jac CLI."""
+
+    @staticmethod
+    @hookimpl
+    def create_cmd() -> None:
+        """Create Jac CLI cmds."""
+
+        @cmd_registry.register
+        def jvserve(
+            filename: str,
+            host: str = "0.0.0.0",
+            port: int = 8000,
+            loglevel: str = "INFO",
+            workers: Optional[int] = None,
+        ) -> None:
+            """Launch the jac application."""
+            from jaclang import jac_import
+
+            # set up logging
+            JVLogger.setup_logging(level=loglevel)
+            logger = logging.getLogger(__name__)
+
+            # load FastAPI
+            from jac_cloud import FastAPI
+
+            FastAPI.enable()
+
+            # load the JAC application
+            jctx = ExecutionContext.create()
+
+            base, mod = os.path.split(filename)
+            base = base if base else "./"
+            mod = mod[:-4]
+
+            if filename.endswith(".jac"):
+                start_time = time.time()
+                jac_import(
+                    target=mod,
+                    base_path=base,
+                    cachable=True,
+                    override_name="__main__",
+                )
+                logger.info(f"Loading took {time.time() - start_time} seconds")
+
+            AgentInterface.HOST = host
+            AgentInterface.PORT = port
+
+            # set up lifespan events
+            async def on_startup() -> None:
+                # Perform initialization actions here
+                logger.info("JIVAS is starting up...")
+
+            async def on_shutdown() -> None:
+                # Perform initialization actions here
+                logger.info("JIVAS is shutting down...")
+                AgentPulse.stop()
+                # await AgentRTC.on_shutdown()
+                jctx.close()
+                JacMachine.detach()
+
+            app_lifespan = FastAPI.get().router.lifespan_context
+
+            @asynccontextmanager
+            async def lifespan_wrapper(app: FastAPI) -> AsyncIterator[Optional[str]]:
+                await on_startup()
+                async with app_lifespan(app) as maybe_state:
+                    yield maybe_state
+                await on_shutdown()
+
+            FastAPI.get().router.lifespan_context = lifespan_wrapper
+
+            # Setup custom routes
+            FastAPI.get().add_api_route(
+                "/interact", endpoint=AgentInterface.interact, methods=["POST"]
+            )
+            FastAPI.get().add_api_route(
+                "/webhook/{key}",
+                endpoint=AgentInterface.webhook_exec,
+                methods=["GET", "POST"],
+            )
+            FastAPI.get().add_api_route(
+                "/action/walker",
+                endpoint=AgentInterface.action_walker_exec,
+                methods=["POST"],
+                dependencies=authenticator,
+            )
+
+            # run the app
+            _run(FastAPI.get(), host=host, port=port, lifespan="on", workers=workers)
+
+        @cmd_registry.register
+        def jvfileserve(
+            directory: str, host: str = "0.0.0.0", port: int = 9000
+        ) -> None:
+            """Launch the file server."""
+            # load FastAPI
+            from fastapi import FastAPI
+            from fastapi.staticfiles import StaticFiles
+
+            if directory:
+                os.environ["JIVAS_FILES_ROOT_PATH"] = directory
+
+            if not os.path.exists(directory):
+                os.makedirs(directory)
+
+            # Setup custom routes
+            app = FastAPI()
+            app.mount(
+                "/files",
+                StaticFiles(
+                    directory=os.environ.get("JIVAS_FILES_ROOT_PATH", ".files")
+                ),
+                name="files",
+            )
+
+            # run the app
+            _run(app, host=host, port=port)

jvserve-2.0.0/jvserve/lib/__init__.py

@@ -0,0 +1 @@
+"""jvserve library package."""