Sentient-Social-Agent

KO | EN

gitlite — search

#python #react #typescript #go #android #machine-learning #rust #deep-learning #docker #java #kubernetes #vue #security #open-source

Sentient-Social-Agent

(★ 94)

Lightweight social agent, with minimal dependencies

Sentient-Social-Agent Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="banner.png"/>
</p>

<p align="center">
      <a href="https://sentient.xyz/" target="_blank" style="margin: 2px;">
    <img alt="Homepage" src="https://img.shields.io/badge/Website-Sentient.xyz-%23EAEAEA?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzNDEuMzMzIiBoZWlnaHQ9IjM0MS4zMzMiIHZlcnNpb249IjEuMCIgdmlld0JveD0iMCAwIDI1NiAyNTYiPjxwYXRoIGQ9Ik0xMzIuNSAyOC40Yy0xLjUgMi4yLTEuMiAzLjkgNC45IDI3LjIgMy41IDEzLjcgOC41IDMzIDExLjEgNDIuOSAyLjYgOS45IDUuMyAxOC42IDYgMTkuNCAzLjIgMy4zIDExLjctLjggMTMuMS02LjQuNS0xLjktMTcuMS03Mi0xOS43LTc4LjYtMS4yLTMtNy41LTYuOS0xMS4zLTYuOS0xLjYgMC0zLjEuOS00LjEgMi40ek0xMTAgMzBjLTEuMSAxLjEtMiAzLjEtMiA0LjVzLjkgMy40IDIgNC41IDMuMSAyIDQuNSAyIDMuNC0uOSA0LjUtMiAyLTMuMSAyLTQuNS0uOS0zLjQtMi00LjUtMy4xLTItNC41LTItMy40LjktNC41IDJ6TTgxLjUgNDYuMWMtMi4yIDEuMi00LjYgMi44LTUuMiAzLjctMS44IDIuMy0xLjYgNS42LjUgNy40IDEuMyAxLjIgMzIuMSAxMC4yIDQ1LjQgMTMuMyAzIC44IDYuOC0yLjIgNi44LTUuMyAwLTMuNi0yLjItOS4yLTMuOS0xMC4xQzEyMy41IDU0LjIgODcuMiA0NCA4NiA0NGMtLjMuMS0yLjMgMS00LjUgMi4xek0xNjUgNDZjLTEuMSAxLjEtMiAyLjUtMiAzLjIgMCAyLjggMTEuMyA0NC41IDEyLjYgNDYuNS45IDEuNSAyLjQgMi4zIDQuMiAyLjMgMy44IDAgOS4yLTUuNiA5LjItOS40IDAtMS41LTIuMS0xMC45LTQuNy0yMC44bC00LjctMTguMS00LjUtMi44Yy01LjMtMy40LTcuNC0zLjYtMTAuMS0uOXpNNDguNyA2NS4xYy03LjcgNC4xLTYuOSAxMC43IDEuNSAxMyAyLjQuNiAyMS40IDUuOCA0Mi4yIDExLjYgMjIuOCA2LjIgMzguOSAxMC4yIDQwLjMgOS44IDMuNS0uOCA0LjYtMy44IDMuMi04LjgtMS41LTUuNy0yLjMtNi41LTguMy04LjJDOTQuMiA3My4xIDU2LjYgNjMgNTQuOCA2M2MtMS4zLjEtNCAxLTYuMSAyLjF6TTE5OC4yIDY0LjdjLTMuMSAyLjgtMy41IDUuNi0xLjEgOC42IDQgNS4xIDEwLjkgMi41IDEwLjktNC4xIDAtNS4zLTUuOC03LjktOS44LTQuNXpNMTgxLjggMTEzLjFjLTI3IDI2LjQtMzEuOCAzMS41LTMxLjggMzMuOSAwIDEuNi43IDMuNSAxLjUgNC40IDEuNyAxLjcgNy4xIDMgMTAuMiAyLjQgMi4xLS4zIDU2LjktNTMuNCA1OS01Ny4xIDEuNy0zLjEgMS42LTkuOC0uMy0xMi41LTMuNi01LjEtNC45LTQuMi0zOC42IDI4Ljl6TTM2LjYgODguMWMtNSA0LTIuNCAxMC45IDQuMiAxMC45IDMuMyAwIDYuMi0yLjkgNi4yLTYuMyAwLTIuMS00LjMtNi43LTYuMy02LjctLjggMC0yLjYuOS00LjEgMi4xek02My40IDk0LjVjLTEuNi43LTguOSA3LjMtMTYuMSAxNC43TDM0IDEyMi43djUuNmMwIDYuMyAxLjYgOC43IDUuOSA4LjcgMi4xIDAgNi0zLjQgMTkuOS0xNy4zIDkuNS05LjUgMTcuMi0xOCAxNy4yLTE4LjkgMC00LjctOC40LTguNi0xMy42LTYuM3pNNjIuOSAxMzAuNiAzNCAxNTkuNXY1LjZjMCA2LjIgMS44IDguOSA2IDguOSAzLjIgMCA2Ni02Mi40IDY2LTY1LjYgMC0zLjMtMy41LTUuNi05LjEtNi4ybC01LS41LTI5IDI4Ljl6TTE5Ni4zIDEzNS4yYy05IDktMTYuNiAxNy4zLTE2LjkgMTguNS0xLjMgNS4xIDIuNiA4LjMgMTAgOC4zIDIuOCAwIDUuMi0yIDE3LjktMTQuOCAxNC41LTE0LjcgMTQuNy0xNC45IDE0LjctMTkuMyAwLTUuOC0yLjItOC45LTYuMi04LjktMi42IDAtNS40IDIuMy0xOS41IDE2LjJ6TTk2IDEzNi44Yy0yLjkuOS04IDYuNi04IDkgMCAxLjMgMi45IDEzLjQgNi40IDI3IDMuNiAxMy42IDcuOSAzMC4zIDkuNyAzNy4yIDEuNyA2LjkgMy42IDEzLjMgNC4xIDE0LjIuNSAxIDIuNiAyLjcgNC44IDMuOCA2LjggMy41IDExIDIuMyAxMS0zLjIgMC0zLTIwLjYtODMuMS0yMi4xLTg1LjktLjktMS45LTMuNi0yLjgtNS45LTIuMXpNMTIwLjUgMTU4LjRjLTEuOSAyLjktMS4yIDguNSAxLjQgMTEuNiAxLjEgMS40IDEyLjEgNC45IDM5LjYgMTIuNSAyMC45IDUuOCAzOC44IDEwLjUgMzkuOCAxMC41czMuNi0xIDUuNy0yLjJjOC4xLTQuNyA3LjEtMTAuNi0yLjMtMTMuMi0yOC4yLTguMS03OC41LTIxLjYtODAuMy0yMS42LTEuNCAwLTMgMS0zLjkgMi40ek0yMTAuNyAxNTguOGMtMS44IDEuOS0yLjIgNS45LS45IDcuOCAxLjUgMi4zIDUgMy40IDcuNiAyLjQgNi40LTIuNCA1LjMtMTEuMi0xLjUtMTEuOC0yLjQtLjItNCAuMy01LjIgMS42ek02OS42IDE2MmMtMiAyLjItMy42IDQuMy0zLjYgNC44LjEgMi42IDEwLjEgMzguNiAxMS4xIDM5LjkgMi4yIDIuNiA5IDUuNSAxMS41IDQuOSA1LTEuMyA0LjktMy0xLjUtMjcuNy0zLjMtMTIuNy02LjUtMjMuNy03LjItMjQuNS0yLjItMi43LTYuNC0xLjctMTAuMyAyLjZ6TTQ5LjYgMTgxLjVjLTIuNCAyLjUtMi45IDUuNC0xLjIgOEM1MiAxOTUgNjAgMTkzIDYwIDE4Ni42YzAtMS45LS44LTQtMS44LTQuOS0yLjMtMi4xLTYuNi0yLjItOC42LS4yek0xMjguNSAxODdjLTIuMyAyLjUtMS4zIDEwLjMgMS42IDEyLjggMi4yIDEuOSAzNC44IDExLjIgMzkuNCAxMS4yIDMuNiAwIDEwLjEtNC4xIDExLTcgLjYtMS45LTEuNy03LTMuMS03LS4yIDAtMTAuMy0yLjctMjIuMy02cy0yMi41LTYtMjMuMy02Yy0uOCAwLTIuMy45LTMuMyAyek0xMzYuNyAyMTYuOGMtMy40IDMuOC0xLjUgOS41IDMuNSAxMC43IDMuOSAxIDguMy0zLjQgNy4zLTcuMy0xLjItNS4xLTcuNS03LjEtMTAuOC0zLjR6Ii8%2BPC9zdmc%2B&link=https%3A%2F%2Fhuggingface.co%2FSentientagi"/>
  </a>
    
    <a href="https://x.com/SentientAGI">
        <img alt="Twitter Follow" src="https://img.shields.io/badge/Twitter-SentientAGI-white?logo=x"/>
    </a>
    
    <a href="https://discord.gg/sentientfoundation">
        <img alt="Discord" src="https://img.shields.io/badge/Discord-SentientAGI-7289da?logo=discord&logoColor=white&color=7289da"/>
    </a>
    
    <a href="https://huggingface.co/Sentientagi">
        <img src="https://img.shields.io/badge/Hugging_Face-SentientAGI-yellow?style=sociak&logo=huggingface"/>
    </a>
</p>

<p align="center">
    
    <a href="https://github.com/sentient-agi/Sentient-Social-Agent/releases">
        <img alt="GitHub release" src="https://img.shields.io/badge/Release-Beta-yellow">
    </a>
    
    <a href="https://github.com/sentient-agi/Sentient-Social-Agent/tree/main?tab=Apache-2.0-1-ov-file">
        <img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-green">
    </a>
</p>

<h1 align="center">Sentient Social Agent</h1>

> [!WARNING]
> **This agent is for demonstration purposes only and is not suitable for production use.**

This is an example of a lightweight social agent, with minimal dependencies. Aligned with Sentient's mission, the agent is designed to be easily extensible and it is open to community contributions. Create an issue to ask a question or open a PR to add a feature!

# Features 🦾
For now the only platforms that are supported by the agent are X (Twitter) and Discord. We're going to continuously work on this agent. If there is a tool or platform that you would like to see supported, please create an issue or, better yet, get coding and open a PR! Telegram support is the next feature in the pipeline. We also plan to add tools to support more sophisticated features, such as data sources and on-chain functionality.
- [x] Supports any OpenAI API compatible LLM endpoint
- [x] Supports X (Twitter)
- [x] Supports Discord
- [ ] Telegram is coming soon...
- [ ] Data is coming soon...
- [ ] Web3 is coming soon...

# Quickstart 🚀

> [!NOTE]
> **These instructions are for unix-based systems (i.e. MacOS, Linux). Before you proceed, make sure that you have installed `python` and `pip`. If you have not, follow [these](https://packaging.python.org/en/latest/tutorials/installing-packages/) instructions to do so.**

### [1/4]&nbsp;&nbsp;Set Up Agent Credentials

#### 1.1. Create secrets file
Create the `.env` file by copying the contents of `.env.example`. This is where you will store all of your agent's credentials.
```
cp .env.example .env
```

#### 1.2. Add model credentials
Add your Fireworks API key to the `.env` file (you can also use any other OpenAI compatible inference provider).

#### 1.3. Add X (Twitter) credentials
In order to interact with the X (Twitter) API, your agent needs developer credentials from the X (Twitter) developer portal [here](https://developer.x.com/en/portal/dashboard).

From the *Dashboard* page, click on the gear icon to access the *Settings* page for your default project.

Set the user authentication settings for your app as follows:
- App permissions: "Read and write"
- Type of App: "Web App, Automated App or Bot"
- Callback URI / Redirect URL: http://localhost:8000
- Website URL: http://example.com

Generate all of the required credentials on the *Keys and tokens* page. Add them to the `.env` file.

#### 1.4. Add Discord credentials
Before you can build a Discord bot you need to create it in the Discord Developer Portal. Follow the steps in the *Creating an App* part of [this](https://discord.com/developers/docs/quick-start/getting-started#step-1-creating-an-app) guide and add your token to the `.env` file.

### [2/4]&nbsp;&nbsp;Set Up Python Virtual Environment

#### 2.1. Create Python virtual environment
```
python3 -m venv .venv
```

#### 2.2. Activate Python virtual environment
```
source .venv/bin/activate
```

#### 2.3. Install dependencies
```
pip install -r requirements.txt
```

### [3/4]&nbsp;Test Agent Tools
#### 3.1. Test Connection to Model
```
python3 -m src.agent.agent_tools.model
```
Expected output:
```
Connecting to model...
To exit just type 'exit' and press enter.
Query model: 
```

#### 3.2. Test Connection to Twitter
```
python3 -m src.agent.agent_tools.twitter
```
Expected output:
```
Connecting to twitter...
Connected to twitter user <USERNAME> with id <USER_ID>.
```

#### 3.3. Test Connection to Discord
```
python3 -m src.agent.agent_tools.discord
```
Expected output:
```
Connecting to discord...
Connected to discord bot <USERNAME> with id <USER_ID>.
```

### [4/4]&nbsp;Run Agent Locally
```
python3 -m src.agent
```
Expected output (if you have added a key user in `twitter_config` and you have enabled Twitter and Discord in `agent_config`):
```
INFO: Agent starting up...
INFO: Twitter client starting up...
INFO: Connected to twitter user <USERNAME> with id <USER_ID>.
INFO: Discord client starting up...
WARNING: PyNaCl is not installed, voice will NOT be supported
INFO: Connected to discord bot <USERNAME> with id <USER_ID>.
```

# Configuration ⚙️
### Configurating Exisiting Tools
You can enable and disable tools in the `agent_config` module in the `agent` package. Each tool can be configured using its configuration module that is located in the tool's directory in the `agent_tools` directory. Each tool also has its own README file that describes its configuration options.

### Adding New Tools
The `agent` class will automatically discover and initialize tools that are in the `agent_tools` directory. However, you need to follow these conventions when adding a new tool:
1. Each tool must have a corresponding `<TOOL_NAME>_ENABLED` boolean flag in the `agent_config` module.
2. Each tool must have its own directory within `agent_tools`.
3. Each tool must have a main module that is named `<tool_name>.py`.
    - Within the main module, the main class name must be the capitalized version of the directory name.
    - The main class must have an `__init__` method that will be called when the tool is initialized.
        - The `__init__` method should take the secrets and the model as arguments.
        - Each secret should be stored in the `.env` file and named `<TOOL_NAME>_<SECRET_NAME>` where `<SECRET_NAME>` is the name of the corresponding argument in the `__init__` method.
    - The main class must have a `run` method that will be called when the tool is run.
4. Each tool must have a configuration module that is named `<tool_name>_config.py`.
    - The configuration module must have a `<Tool_name>Config` class.
5. Each tool must have a README file that describes the configuration options.
6. If you install a new package, you must update the `requirements.txt` file:
    ```
    pip freeze > requirements.txt
    ```

For example, consider the twitter tool:
1. There is a `TWITTER_ENABLED` boolean flag in the `agent_config` module.
2. There is a twitter directory in `agent_tools`.
3. There is a main module `twitter.py`.
    - There is a `Twitter` class in `twitter.py`.
    - The `Twitter` class has an `__init__` method that takes the secrets and the model as arguments. The secrets are stored in the `.env` file and are prefixed with `TWITTER_`.
        - `consumer_key` corresponds to the `TWITTER_CONSUMER_KEY` environment variable.
        - `consumer_secret` corresponds to the `TWITTER_CONSUMER_SECRET` environment variable.
        - `access_token` corresponds to the `TWITTER_ACCESS_TOKEN` environment variable.
        - `access_token_secret` corresponds to the `TWITTER_ACCESS_TOKEN_SECRET` environment variable.
        - `bearer_token` corresponds to the `TWITTER_BEARER_TOKEN` environment variable.
    - The `Twitter` class has a `run` method that is called to run the tool.
4. There is a configuration module `twitter_config.py`.
    - There is a `TwitterConfig` class in `twitter_config.py`.
5. There is a README file `twitter/README.md` that describes the configuration options.

Sentient-Social-Agent

Sentient-Social-Agent Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Sentient-Social-Agent

Sentient-Social-Agent Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README