# ipaacar - Incremental Processing Architecture for Artificial Conversational Agents, implemented in Rust
Implementation of IPAACA in Rust. For a theoretical background, see [ipaaca wiki entry](https://scs.techfak.uni-bielefeld.de/wiki/public/ipaaca/start). IPAACA is developed by the Social Cognitive Systems Group at Bielefeld University. Many thanks to David Schwab for his contribution to the initial rust implementation.
IPAACA is a framework for incremental processing via "incremental units" (IUs) processed by buffers (in and out). It uses a MQTT broker for message passing. Therefore, a MQTT broker must be installed and running to use ipaaca(r) ([mosquitto](https://mosquitto.org/download/), [nanomq](https://nanomq.io/downloads?os=Linux)). Simple messaging is possible via "messages". IUs can be updated, linked, committed, and retracted, allowing incremental processing, e.g. for conversational agents.
## Installation
### Python
#### Installing from PyPI
You can grab a precompiled versions from [PyPI](https://pypi.org/project/ipaacar-python/) and install it via pip:
```
pip install ipaacar-python
```
Currtently, the precompiled versions support [manylinux_x_y](https://github.com/pypa/manylinux) (e.g., Ubuntu >= 21.04, etc.) and Python 3.8 to 3.11.
#### Building from source
If the precompiled versions do not suit your needs, build ipaacar-python from source.
* Install Rust and Cargo using [rustup](https://rustup.rs/):
```curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh```
* Install [Python](https://www.python.org/) (3.11 recommended), create and use a [virtual environment](https://docs.python.org/3/library/venv.html)
* Install [Maturin](https://www.maturin.rs/): ```pip install maturin```
* Build the wheel package inside the `ipaacar-python` folder: ```maturin build --release```
* Install the wheel: ```pip install ../target/wheels/FILENAME.whl```
### Rust
#### Usage over ssh (recommended)
You can use the library by linking it over git ssh. You will always use the newest version like this.
```toml
[dependencies]
ipaacar-core = { git = "ssh://git@gitlab.ub.uni-bielefeld.de:scs/ipaacar.git"}
```
If the project is still hosted on the uni gitlab, setup ssh authentication and create `.cargo/config.toml` with this content:
```toml
[net]
git-fetch-with-cli = true
```
#### Downloading source files
Download the ipaaca-core folder and place it into your project directory. You can use the library by linking it in your `Cargo.toml` like this:
```toml
[dependencies]
ipaacar-core = { path = "/ipaacar-core" }
```
Depending on your folder structure you might need to adjust the path.
## Documentation
Documentation is available for:
#### [Python](https://scs.pages.ub.uni-bielefeld.de/ipaacar/ipaacar-python)
Documentation of the Python API. Build with pdoc.
#### [Rust](https://scs.pages.ub.uni-bielefeld.de/ipaacar/ipaacar-core/doc/ipaacar_core/)
Documentation of the Rust library. Build with standard rust docs.
Raw data
{
"_id": null,
"home_page": null,
"name": "ipaacar-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ipaaca, ipaacar, rust, messaging, incremental, mqtt",
"author": "AG-SCS",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ac/e5/f75cbd20c4438d3101c8589ff92f1bb241ef64091b20627e92742cc8283b/ipaacar_python-0.1.5.tar.gz",
"platform": null,
"description": "# ipaacar - Incremental Processing Architecture for Artificial Conversational Agents, implemented in Rust\n\n\n\n\n\n\nImplementation of IPAACA in Rust. For a theoretical background, see [ipaaca wiki entry](https://scs.techfak.uni-bielefeld.de/wiki/public/ipaaca/start). IPAACA is developed by the Social Cognitive Systems Group at Bielefeld University. Many thanks to David Schwab for his contribution to the initial rust implementation.\n\nIPAACA is a framework for incremental processing via \"incremental units\" (IUs) processed by buffers (in and out). It uses a MQTT broker for message passing. Therefore, a MQTT broker must be installed and running to use ipaaca(r) ([mosquitto](https://mosquitto.org/download/), [nanomq](https://nanomq.io/downloads?os=Linux)). Simple messaging is possible via \"messages\". IUs can be updated, linked, committed, and retracted, allowing incremental processing, e.g. for conversational agents.\n\n\n## Installation\n### Python\n#### Installing from PyPI\n\nYou can grab a precompiled versions from [PyPI](https://pypi.org/project/ipaacar-python/) and install it via pip:\n```\npip install ipaacar-python\n```\nCurrtently, the precompiled versions support [manylinux_x_y](https://github.com/pypa/manylinux) (e.g., Ubuntu >= 21.04, etc.) and Python 3.8 to 3.11.\n\n#### Building from source\n\nIf the precompiled versions do not suit your needs, build ipaacar-python from source.\n\n * Install Rust and Cargo using [rustup](https://rustup.rs/):\n```curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh```\n\n * Install [Python](https://www.python.org/) (3.11 recommended), create and use a [virtual environment](https://docs.python.org/3/library/venv.html)\n * Install [Maturin](https://www.maturin.rs/): ```pip install maturin```\n * Build the wheel package inside the `ipaacar-python` folder: ```maturin build --release```\n * Install the wheel: ```pip install ../target/wheels/FILENAME.whl```\n\n### Rust\n\n#### Usage over ssh (recommended)\n\nYou can use the library by linking it over git ssh. You will always use the newest version like this.\n\n```toml\n[dependencies]\nipaacar-core = { git = \"ssh://git@gitlab.ub.uni-bielefeld.de:scs/ipaacar.git\"}\n```\n\nIf the project is still hosted on the uni gitlab, setup ssh authentication and create `.cargo/config.toml` with this content:\n\n```toml\n[net]\ngit-fetch-with-cli = true\n```\n\n#### Downloading source files\n\nDownload the ipaaca-core folder and place it into your project directory. You can use the library by linking it in your `Cargo.toml` like this:\n\n```toml\n[dependencies]\nipaacar-core = { path = \"/ipaacar-core\" }\n```\n\nDepending on your folder structure you might need to adjust the path.\n\n## Documentation\n\nDocumentation is available for:\n\n#### [Python](https://scs.pages.ub.uni-bielefeld.de/ipaacar/ipaacar-python)\n\nDocumentation of the Python API. Build with pdoc.\n\n#### [Rust](https://scs.pages.ub.uni-bielefeld.de/ipaacar/ipaacar-core/doc/ipaacar_core/)\n\nDocumentation of the Rust library. Build with standard rust docs.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Incremental Processing Architecture for Artificial Conversational Agents, implemented in Rust",
"version": "0.1.5",
"project_urls": {
"documentation": "https://scs.pages.ub.uni-bielefeld.de/ipaacar/ipaacar-python/ipaacar.html",
"homepage": "https://scs.techfak.uni-bielefeld.de",
"repository": "https://gitlab.ub.uni-bielefeld.de/scs/ipaacar"
},
"split_keywords": [
"ipaaca",
" ipaacar",
" rust",
" messaging",
" incremental",
" mqtt"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4864d2c21a7f32ea22094fb1f1113e2c74cddd0780591a997ff40b24fd78deb7",
"md5": "31887e157bebb92b83171e80da0a2e93",
"sha256": "3cdf24533a166f82037d98e790c646a930b5c8a593ffc5f09e783cb7d9355c1f"
},
"downloads": -1,
"filename": "ipaacar_python-0.1.5-cp310-cp310-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "31887e157bebb92b83171e80da0a2e93",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 1264135,
"upload_time": "2024-06-01T15:48:23",
"upload_time_iso_8601": "2024-06-01T15:48:23.360888Z",
"url": "https://files.pythonhosted.org/packages/48/64/d2c21a7f32ea22094fb1f1113e2c74cddd0780591a997ff40b24fd78deb7/ipaacar_python-0.1.5-cp310-cp310-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "aea91938ef5f0bce475bde827343db325d300c8aa6e4b4372df5dc4a76121217",
"md5": "f3b7e8dfe02168163ab7cbe9ceb6fae6",
"sha256": "df45d89e7dcb75c4926bddfd2c47cb167d5f1079832d36d5847c0d623e55ad4d"
},
"downloads": -1,
"filename": "ipaacar_python-0.1.5-cp311-cp311-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "f3b7e8dfe02168163ab7cbe9ceb6fae6",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 1264137,
"upload_time": "2024-06-01T15:48:23",
"upload_time_iso_8601": "2024-06-01T15:48:23.510554Z",
"url": "https://files.pythonhosted.org/packages/ae/a9/1938ef5f0bce475bde827343db325d300c8aa6e4b4372df5dc4a76121217/ipaacar_python-0.1.5-cp311-cp311-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "21bb8cbce518c9b00e1a429713dceadacfbe21e2501c563cb82d322b87f72cdb",
"md5": "714d4d8cf707575fe5ae1fb07968b9c0",
"sha256": "5a722e52c378f7817297dea40015f72b673db60f73dcf6d607fc99e6be788408"
},
"downloads": -1,
"filename": "ipaacar_python-0.1.5-cp38-cp38-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "714d4d8cf707575fe5ae1fb07968b9c0",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.8",
"size": 1265361,
"upload_time": "2024-06-01T15:48:04",
"upload_time_iso_8601": "2024-06-01T15:48:04.572811Z",
"url": "https://files.pythonhosted.org/packages/21/bb/8cbce518c9b00e1a429713dceadacfbe21e2501c563cb82d322b87f72cdb/ipaacar_python-0.1.5-cp38-cp38-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c430532ef8e06dd678480fcce1785e1fb3f052eafc9a5e935bd0e1278df92ba2",
"md5": "a540f0d41c7af791463ff2ee3d13e169",
"sha256": "62ff818e5b20089c407851277f33d08ec7e983bf1f8ddd0e3408bdec1ad447df"
},
"downloads": -1,
"filename": "ipaacar_python-0.1.5-cp39-cp39-manylinux_2_34_x86_64.whl",
"has_sig": false,
"md5_digest": "a540f0d41c7af791463ff2ee3d13e169",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 1264546,
"upload_time": "2024-06-01T15:48:11",
"upload_time_iso_8601": "2024-06-01T15:48:11.367855Z",
"url": "https://files.pythonhosted.org/packages/c4/30/532ef8e06dd678480fcce1785e1fb3f052eafc9a5e935bd0e1278df92ba2/ipaacar_python-0.1.5-cp39-cp39-manylinux_2_34_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ace5f75cbd20c4438d3101c8589ff92f1bb241ef64091b20627e92742cc8283b",
"md5": "eb71fe3335d9f3d8dab5e26f1c16dd09",
"sha256": "23bccf8b807077526a6a257e09043b521ca454eaab394b0fa77045437534e229"
},
"downloads": -1,
"filename": "ipaacar_python-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "eb71fe3335d9f3d8dab5e26f1c16dd09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 74982,
"upload_time": "2024-06-01T15:48:06",
"upload_time_iso_8601": "2024-06-01T15:48:06.604707Z",
"url": "https://files.pythonhosted.org/packages/ac/e5/f75cbd20c4438d3101c8589ff92f1bb241ef64091b20627e92742cc8283b/ipaacar_python-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-01 15:48:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ipaacar-python"
}
JSON