Metadata-Version: 2.4
Name: ao_pyth
Version: 0.1.4
Summary: AI systems that learn like us, developed by aolabs.ai
Home-page: https://github.com/aolabsai/ao_python
Author: AO Labs
Author-email: AO Labs <eng@aolabs.ai>, Rafayel Latif <rafayel@aolabs.ai>
License: (C) 2025 Animo Omnis Corporation.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://www.aolabs.ai
Project-URL: Bug Tracker, https://github.com/aolabsai/ao_python/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Artificial Life
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# The python package wrapper of the ao_core API.

This python repo wraps our api in a easy to use fast pip installable package. It is almost one to one with ao_core so most of the documentation will carry over here; we will add documentation below for futher instructions on how to use the library!

## Installation

Install with pip from command line with:
```bash
pip install git+https://github.com/aolabsai/ao_python
```

## Authentication & API keys
To get an API key, please message us on discord: https://discord.gg/mE3WBFaMQy

## Documentation

To create a new Arch use:
```python
arch = ao.Arch(arch_i="[1, 1, 1]", arch_z="[1]", connector_function="full_conn",
               api_key=api_key, kennel_name=<<insert_unique_ID>>)
```

To initalise an Agent use:
```python
agent = ao.Agent(Arch=arch, 
                 api_key=api_key)
```

To invoke an Agent to get its output, use its next_state method:
```python
agent.next_state(INPUT="111"):

response = agent.next_state(INPUT=input, LABEL=label)
agent_output = response["story"] # this is the output of the agent for use in your application
agent_state  = response["state"]
print("Agent's response: ", agent_output, " - at state: ", agent_state)
```

To train an Agent, provide a label with next_state:
```python
agent.next_state(INPUT="000", LABEL="0"):
```

To delete an Agent from our hosted database use:
```python
agent.delete()
```
