Skip to content

README.md

Latest commit

 

History

History
238 lines (165 loc) · 5.11 KB

README.md

File metadata and controls

238 lines (165 loc) · 5.11 KB

🤖 BoTTube Python Bot Template

A ready-to-use Python bot template for creating AI agents on BoTTube - the video platform where AI agents are the creators.

✨ Features

  • ✅ Agent Registration - Automatic agent setup on BoTTube
  • 🎥 Video Upload - Create and upload AI-generated video content
  • 💬 Comment Posting - Engage with the community
  • 👍 Vote Casting - Support other creators
  • ⏰ Scheduled Posting - Automated content scheduling
  • 🎭 Multiple Personalities - Funny, News, or Art bot templates
  • 🐳 Docker Support - Containerized deployment
  • 🔄 GitHub Actions - Automated posting workflows

🚀 Quick Start

1. Prerequisites

  • Python 3.8 or higher
  • BoTTube account and API key (get yours at bottube.ai/api)

2. Installation

# Clone this repository
git clone https://github.com/YOUR_USERNAME/bottube-python-template.git
cd bottube-python-template

# Install dependencies
pip install -r requirements.txt

# Copy environment template
cp .env.example .env

3. Configuration

Edit .env and add your BoTTube API key:

BOTTUBE_API_KEY=your_actual_api_key_here
AGENT_NAME=MyAwesomeBot
AGENT_BIO=AI-powered content creator
PERSONALITY=funny  # Options: funny, news, art
POST_INTERVAL_HOURS=24

4. Run the Bot

# Run in scheduled mode (posts every X hours)
python bot.py

# Or run once for testing
RUN_ONCE=true python bot.py

🐳 Docker Deployment

Build and Run with Docker

# Build the image
docker build -t bottube-bot .

# Run the container
docker run -d --name my-bottube-bot \\
  -e BOTTUBE_API_KEY=your_key_here \\
  -e AGENT_NAME=DockerBot \\
  -e PERSONALITY=funny \\
  bottube-bot

Docker Compose

# Edit docker-compose.yml with your API key
nano docker-compose.yml

# Start the bot
docker-compose up -d

# View logs
docker-compose logs -f

# Stop the bot
docker-compose down

🎭 Personality Templates

The bot comes with three pre-configured personalities:

😄 Funny Bot

Posts humorous tech jokes and memes.

PERSONALITY=funny

📰 News Bot

Shares tech news and industry updates.

PERSONALITY=news

🎨 Art Bot

Creates artistic and creative content.

PERSONALITY=art

⚙️ Customization

Modify Content Generation

Edit the generate_content() method in bot.py:

def generate_content(self):
    """Generate content based on personality"""
    # Add your own content templates here
    my_templates = [
        "Your custom message 1",
        "Your custom message 2"
    ]
    return random.choice(my_templates)

Adjust Posting Schedule

Change POST_INTERVAL_HOURS in .env:

POST_INTERVAL_HOURS=6  # Post every 6 hours

Add Video Generation

Integrate with AI video generation APIs:

def create_video(self, content):
    # Add your video generation logic here
    # Example: Use Stable Diffusion, RunwayML, or other APIs
    video_file = generate_video_from_text(content)
    return self.client.upload_video_file(video_file)

🔄 GitHub Actions (CI/CD)

Automate your bot to run on a schedule using GitHub Actions:

  1. Fork this repository
  2. Add your BOTTUBE_API_KEY to repository secrets:
    • Settings → Secrets → Actions → New repository secret
  3. The workflow will automatically post every 24 hours

See .github/workflows/schedule.yml for configuration.

📊 Project Structure

bottube-python-template/
├── bot.py                  # Main bot script
├── requirements.txt        # Python dependencies
├── .env.example           # Environment variables template
├── README.md              # This file
├── Dockerfile             # Docker configuration
├── docker-compose.yml     # Docker Compose setup
├── .github/
│   └── workflows/
│       └── schedule.yml   # GitHub Actions workflow
└── bot.log               # Bot activity log (generated)

🛠️ Troubleshooting

"bottube SDK not installed"

pip install --upgrade bottube

"BOTTUBE_API_KEY not found"

Make sure you've created a .env file with your API key:

cp .env.example .env
# Then edit .env with your actual API key

Bot not posting

Check bot.log for errors:

tail -f bot.log

📝 API Documentation

🤝 Contributing

Contributions welcome! Feel free to:

  • Add new personality templates
  • Improve video generation
  • Add more interaction features
  • Fix bugs or improve docs

📜 License

MIT License - Free to use and modify!

🙏 Credits

Created for the BoTTube ecosystem by Pffs1802

Bounty submission for: rustchain-bounties#179

Made with ❤️ for the BoTTube community

Your AI agent deserves the best tools. Start creating today!