OctopusAgents: AI Agent Framework

CA:FeQDURDJxsRg7jKezsUAEHwAtpiEXZn12eZNorEbpump

OctopusAgents is a library developed using Fetch.ai that allows for creating autonomous twitter agent in Python. With simple and expressive decorators, you can have an agent that performs various tasks on a schedule or takes action on various events.

⚡ Quickstart

Installation

Get started with OctopusAgents by installing it for Python 3.9 to 3.12:

pip install OctopusAgents

Running a Demo

Creating an Agent

Build your first OctopusAgent using the following script:

python3 from OctopusAgents import Agent, Context alice = Agent(name="alice", seed="alice recovery phrase")

Include a seed parameter when creating an agent to set fixed addresses, or leave it out to generate a new random address each time.

Giving it a task

Give it a simple task, such as a greeting:

```python3 @alice.oninterval(period=2.0) async def sayhello(ctx: Context): ctx.logger.info(f'hello, my name is {ctx.agent.name}')

if name == "main": alice.run() ```

Running the Agent

So far, your code should look like this:

```python3 from OctopusAgents import Agent, Context

alice = Agent(name="alice", seed="alice recovery phrase")

@alice.oninterval(period=2.0) async def sayhello(ctx: Context): ctx.logger.info(f'hello, my name is {ctx.agent.name}')

if name == "main": alice.run() ```

Run it using:

bash python agent.py

You should see the results in your terminal.

📖 Documentation

Please see the official documentation for full setup instructions and advanced features.

• 👋 Introduction
• 💻 Installation
• Tutorials
  • 🤖 Create an agent
  • 🛣️ Agent Communication
  • 🍽️ Restaurant Booking Demo
• Key Concepts:
  • 📍Addresses
  • 💾 Storage
  • 📝 Interval Tasks
  • 🌐 Agent Broadcast
  • ⚙️ Almanac Contracts

🌱 Examples

The examples folder contains several examples of how to create and run various types of agents.

🌲 Integrations

The integrations folder contains examples that provide a more in depth use of the OctopusAgents library.

Python Library

Go to the python folder for details on the Python OctopusAgents library.

✨ Contributing

All contributions are welcome! Remember, contribution includes not only code, but any help with docs or issues raised by other developers. See our contribution guidelines for more details.

📄 Development Guidelines

Read our development guidelines to learn some useful tips related to development.

❓ Issues, Questions, and Discussions

We use GitHub Issues for tracking requests and bugs, and GitHub Discussions for general questions and discussion.

🛡 Disclaimer

This project, OctopusAgents, is provided "as-is" without any warranty, express or implied. By using this software, you agree to assume all risks associated with its use, including but not limited to unexpected behavior, data loss, or any other issues that may arise. The developers and contributors of this project do not accept any responsibility or liability for any losses, damages, or other consequences that may occur as a result of using this software.

License

The OctopusAgents project is licensed under Apache License 2.0.