jivas


Namejivas JSON
Version 2.0.0a24 PyPI version JSON
download
home_pagehttps://github.com/TrueSelph/jivas
SummaryJIVAS is an Agentic Framework for rapidly prototyping and deploying graph-based, AI solutions.
upload_time2025-04-09 04:08:19
maintainerNone
docs_urlNone
authorTrueSelph Inc.
requires_python>=3.12.0
licenseNone
keywords jivas
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# JIVAS

![GitHub release (latest by date)](https://img.shields.io/github/v/release/TrueSelph/jivas)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TrueSelph/jivas/test-jivas.yaml)
![GitHub issues](https://img.shields.io/github/issues/TrueSelph/jivas)
![GitHub pull requests](https://img.shields.io/github/issues-pr/TrueSelph/jivas)
![GitHub](https://img.shields.io/github/license/TrueSelph/jivas)

`jivas` is an Agentic Framework for rapidly prototyping and deploying graph-based, AI solutions.

## Installation

To install `jivas`, use `pip`:

```sh
pip install jivas
```

## Usage

To use `jivas`, you can start the framework with the following command:

```sh
jac jvserve <path-to-your-jac-file>
```

For example:

```sh
jac jvserve main.jac
```

### Supported Arguments

- `--host`: The host to run the server on. Default is `
- `--port`: The port to run the server on. Default is `8000`.
- `--loglevel`: The logging level to use. Default is `INFO`.

Example with all arguments:

```sh
jac jvserve main.jac --host 0.0.0.0 --port 8000 --loglevel DEBUG
```

## 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/jivas/issues)**: Submit bugs found or log feature requests for the `jivas` project.
- **💡 [Submit Pull Requests](https://github.com/TrueSelph/jivas/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/jivas
   ```
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/jivas/graphs/contributors">
        <img src="https://contrib.rocks/image?repo=TrueSelph/jivas" />
   </a>
</p>
</details>

## 🎗 License

This project is protected under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.

## Additional Information

Since `jivas` is a framework for AI solutions, it supports various integrations and extensions. You can find more information about its capabilities and extensions in the official documentation.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TrueSelph/jivas",
    "name": "jivas",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12.0",
    "maintainer_email": null,
    "keywords": "jivas",
    "author": "TrueSelph Inc.",
    "author_email": "admin@trueselph.com",
    "download_url": "https://files.pythonhosted.org/packages/a3/41/5a5fb02090c0d371590c2a0288cebba145bcb3f0ce16bede7fcb07a5210b/jivas-2.0.0a24.tar.gz",
    "platform": null,
    "description": "\n# JIVAS\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/TrueSelph/jivas)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TrueSelph/jivas/test-jivas.yaml)\n![GitHub issues](https://img.shields.io/github/issues/TrueSelph/jivas)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/TrueSelph/jivas)\n![GitHub](https://img.shields.io/github/license/TrueSelph/jivas)\n\n`jivas` is an Agentic Framework for rapidly prototyping and deploying graph-based, AI solutions.\n\n## Installation\n\nTo install `jivas`, use `pip`:\n\n```sh\npip install jivas\n```\n\n## Usage\n\nTo use `jivas`, you can start the framework with the following command:\n\n```sh\njac jvserve <path-to-your-jac-file>\n```\n\nFor example:\n\n```sh\njac jvserve main.jac\n```\n\n### Supported Arguments\n\n- `--host`: The host to run the server on. Default is `\n- `--port`: The port to run the server on. Default is `8000`.\n- `--loglevel`: The logging level to use. Default is `INFO`.\n\nExample with all arguments:\n\n```sh\njac jvserve main.jac --host 0.0.0.0 --port 8000 --loglevel DEBUG\n```\n\n## API Endpoints\n\n- **Interact with Agent**: `/interact` (POST)\n- **Execute Webhook**: `/webhook/{key}` (GET, POST)\n- **Execute Action Walker**: `/action/walker` (POST)\n\nYou can see all endpoints at the URL `/docs`.\n\n## \ud83d\udd30 Contributing\n\n- **\ud83d\udc1b [Report Issues](https://github.com/TrueSelph/jivas/issues)**: Submit bugs found or log feature requests for the `jivas` project.\n- **\ud83d\udca1 [Submit Pull Requests](https://github.com/TrueSelph/jivas/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.\n\n<details closed>\n<summary>Contributing Guidelines</summary>\n\n1. **Fork the Repository**: Start by forking the project repository to your GitHub account.\n2. **Clone Locally**: Clone the forked repository to your local machine using a git client.\n   ```sh\n   git clone https://github.com/TrueSelph/jivas\n   ```\n3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.\n   ```sh\n   git checkout -b new-feature-x\n   ```\n4. **Make Your Changes**: Develop and test your changes locally.\n5. **Commit Your Changes**: Commit with a clear message describing your updates.\n   ```sh\n   git commit -m 'Implemented new feature x.'\n   ```\n6. **Push to GitHub**: Push the changes to your forked repository.\n   ```sh\n   git push origin new-feature-x\n   ```\n7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.\n8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!\n</details>\n\n<details open>\n<summary>Contributor Graph</summary>\n<br>\n<p align=\"left\">\n    <a href=\"https://github.com/TrueSelph/jivas/graphs/contributors\">\n        <img src=\"https://contrib.rocks/image?repo=TrueSelph/jivas\" />\n   </a>\n</p>\n</details>\n\n## \ud83c\udf97 License\n\nThis project is protected under the Apache License 2.0. See [LICENSE](./LICENSE) for more information.\n\n## Additional Information\n\nSince `jivas` is a framework for AI solutions, it supports various integrations and extensions. You can find more information about its capabilities and extensions in the official documentation.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "JIVAS is an Agentic Framework for rapidly prototyping and deploying graph-based, AI solutions.",
    "version": "2.0.0a24",
    "project_urls": {
        "Homepage": "https://github.com/TrueSelph/jivas"
    },
    "split_keywords": [
        "jivas"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "00b75f11e9a61e188eddda249024de8f50253d5bc42592393a0b842c3eeab5a5",
                "md5": "3029d09eb0d4afb04e1d087df19dc108",
                "sha256": "13c555fb80a0f6fcbefa169bb0332b277265a76cfe69ec01c82d25103c67c4b2"
            },
            "downloads": -1,
            "filename": "jivas-2.0.0a24-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3029d09eb0d4afb04e1d087df19dc108",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12.0",
            "size": 237945,
            "upload_time": "2025-04-09T04:08:17",
            "upload_time_iso_8601": "2025-04-09T04:08:17.272019Z",
            "url": "https://files.pythonhosted.org/packages/00/b7/5f11e9a61e188eddda249024de8f50253d5bc42592393a0b842c3eeab5a5/jivas-2.0.0a24-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a3415a5fb02090c0d371590c2a0288cebba145bcb3f0ce16bede7fcb07a5210b",
                "md5": "edd9ed2e3c24b791ea579dc6fca39c6b",
                "sha256": "bb109db64a71039a569a717a866605bbaad222be8ccc517540d70ac19fdc78cd"
            },
            "downloads": -1,
            "filename": "jivas-2.0.0a24.tar.gz",
            "has_sig": false,
            "md5_digest": "edd9ed2e3c24b791ea579dc6fca39c6b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12.0",
            "size": 170179,
            "upload_time": "2025-04-09T04:08:19",
            "upload_time_iso_8601": "2025-04-09T04:08:19.082630Z",
            "url": "https://files.pythonhosted.org/packages/a3/41/5a5fb02090c0d371590c2a0288cebba145bcb3f0ce16bede7fcb07a5210b/jivas-2.0.0a24.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-04-09 04:08:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TrueSelph",
    "github_project": "jivas",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jivas"
}
        
Elapsed time: 0.79642s