Skip to content

Commit

Permalink
Assistant checkpoint: Update README for template publishing
Browse files Browse the repository at this point in the history
Assistant generated file changes:
- README.md: Update README for template usage

---

User prompt:

can we make this repl a template
  • Loading branch information
ayoubed committed Dec 13, 2024
1 parent 670730e commit 0216f0e
Showing 1 changed file with 41 additions and 44 deletions.
85 changes: 41 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,46 @@
# ZerePy

We're building ZerePy, an open-source Python framework designed to let you deploy your own agents on X, powered by
OpenAI or Anthropic LLMs.

ZerePy is built from a modularized version of the Zerebro backend. With ZerePy, you can launch your own agent with
similar core functionality as Zerebro. For creative outputs, you'll need to fine-tune your own model.

## Installation

This project uses Poetry for dependency management. Here's how to get started:

1. First, install Poetry if you haven't already:
```bash
curl -sSL https://install.python-poetry.org | python3 -
```

2. Clone the repository:
```bash
git clone https://github.com/blorm-network/ZerePy.git
cd ZerePy
```

3. Install dependencies:
```bash
poetry install --no-root
# ZerePy Agent Template

A starting point for building your own AI agents on X (formerly Twitter), powered by OpenAI or Anthropic LLMs.

## Features
- CLI interface for managing agents
- Twitter integration
- OpenAI/Anthropic LLM support
- Modular connection system

## Getting Started

1. Fork this template
2. Install dependencies by clicking Run
3. Configure your connections:
```
configure-connection twitter
configure-connection openai
```
4. Load the example agent:
```
load-agent example
```
5. Start your agent:
```
agent-loop
```

## Creating Your Own Agent

Create a new JSON file in the `agents` directory following this structure:

```json
{
"name": "YourAgent",
"model": "gpt-3.5-turbo",
"bio": "Your agent's description",
"moderated": true
}
```

This will create a virtual environment and install all required dependencies.

## Requirements

- Python 3.10 or higher
- Poetry 1.5 or higher

## Usage

1. Activate the virtual environment:
```bash
poetry shell
```

2. Run the application:
```bash
poetry run python main.py
```
## License
MIT License

------
Made with ♥ @Blorm.xyz

0 comments on commit 0216f0e

Please sign in to comment.