Metadata-Version: 2.1
Name: hyvbase
Version: 0.1.0
Summary: An intelligent agent framework for StarkNet and social media automation
Home-page: https://github.com/ParalexLabs/hyvbase
Author: Mir Sakib
Author-email: ParalexLabs <your.email@example.com>
License: MIT License
        
        Copyright (c) 2024 HyvBase
        
        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. 
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: langchain>=0.1.0
Requires-Dist: langchain-openai>=0.0.2
Requires-Dist: openai>=1.1.0
Requires-Dist: starknet-py>=0.18.0
Requires-Dist: requests>=2.31.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: vectrs>=0.1.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: python-telegram-bot>=20.0
Requires-Dist: tweepy>=4.12.0
Requires-Dist: aiohttp>=3.9.0
Requires-Dist: discord.py>=2.3.2
Requires-Dist: python-linkedin>=4.1
Requires-Dist: google-api-python-client>=2.0.0
Requires-Dist: playwright>=1.40.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: wolframalpha>=5.0.0
Requires-Dist: solders>=0.18.0
Requires-Dist: solana>=0.30.2
Requires-Dist: base58>=2.1.1
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: isort>=5.0.0; extra == "dev"

# HyvBase 🚀

HyvBase is an intelligent agent framework for StarkNet and social media automation. Built with Python, it provides a simple way to create automated trading and social media management solutions.

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

## Features ✨

- **StarkNet Integration**: Swap tokens and execute transfers via AVNU DEX
- **Social Media Management**: Twitter and Telegram automation
- **Vector Memory**: Store and query conversation and transaction history
- **Intelligent Agents**: GPT-powered agents for natural interaction

## Quick Installation 🛠️

```bash
pip install hyvbase
```

Required: Python >=3.8

## Basic Example 📝

```python
from hyvbase.main import HyvBase
import asyncio

async def main():
    hyv = HyvBase()
    
    # Create a DEX agent
    agent = await hyv.create_agent(
        agent_type="dex",
        name="CryptoTrader",
        tools=["starknet", "dex"],
        personality_config={
            "name": "Alex",
            "role": "Crypto Trader",
            "traits": ["precise", "helpful"],
            "expertise": ["Token Swaps", "Transfers"]
        }
    )

    # Get price quote
    quote = await agent.process_command("What's the price of 0.1 ETH in USDC?")
    print(quote)

    # Execute swap
    swap = await agent.process_command("swap 0.1 ETH to USDC")
    print(swap)

if __name__ == "__main__":
    asyncio.run(main())
```

## Configuration 🔧

Create a `.env` file:

```env
# StarkNet
STARKNET_PRIVATE_KEY=your_private_key
STARKNET_ACCOUNT=your_account_address

# Social Media
TWITTER_CLIENT_ID=your_client_id
TWITTER_CLIENT_SECRET=your_client_secret
TWITTER_ACCESS_TOKEN=your_access_token
TWITTER_ACCESS_SECRET=your_access_secret

TELEGRAM_BOT_TOKEN=your_bot_token

# OpenAI (for agent intelligence)
OPENAI_API_KEY=your_openai_key
```

## Supported Operations 🔥

### StarkNet
- Token swaps via AVNU DEX
- Token transfers
- Price quotes
- Transaction monitoring

Supported tokens: ETH, USDC, USDT, STARK

### Social Media
- Twitter: Post tweets, read timeline, engage with mentions
- Telegram: Send messages, manage groups, handle commands

### Memory Features
- Store and query chat history
- Track transaction history
- Semantic search capabilities

## Documentation 📚

For detailed documentation and examples, check out our [Documentation](DOCUMENTATION.md).

## Contributing 🤝

We welcome contributions! Please check our [Contributing Guidelines](CONTRIBUTING.md).

## License 📄

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

