chaturbate-poller 0.6.6

Poller for the Chaturbate events API.

Chaturbate Poller

Chaturbate Poller is a Python application designed to periodically fetch and process events from the Chaturbate API. It utilizes asynchronous HTTP requests and parses the received events for further processing or storage.

Features

• Asynchronous event fetching from the Chaturbate API.
• Error handling and retry logic for network requests.
• Logging of fetched events and error conditions for audit and debugging.
• Environment variable-based configuration for API credentials.

Requirements

• Python 3.8+
• httpx
• pydantic
• asyncio
• python-dotenv

Setup

Prerequisites

1. Ensure Python 3.8 or higher is installed on your system.

2. Install the necessary dependencies:

   pip install chaturbate-poller
   

Environment Configuration

Create a .env file in the root directory with the following content:

CB_USERNAME="your_chaturbate_username"
CB_TOKEN="your_chaturbate_token"
INFLUXDB_URL="http://influxdb:8086"
INFLUXDB_TOKEN="your_influxdb_token"
INFLUXDB_ORG="chaturbate-poller"
INFLUXDB_BUCKET="your_bucket"
INFLUXDB_INIT_MODE="setup"
INFLUXDB_INIT_USERNAME="admin"
INFLUXDB_INIT_PASSWORD="changeme"
INFLUXDB_INIT_ORG="chaturbate-poller"
INFLUXDB_INIT_BUCKET="my-bucket"

Replace the placeholder values with your actual credentials and configuration details.

Usage Examples

Basic Example

Here's a basic example to get you started with fetching events from the Chaturbate API:

import asyncio
import logging
import os
from chaturbate_poller import ChaturbateClient
from dotenv import load_dotenv

load_dotenv()

username = os.getenv("CB_USERNAME", "")
token = os.getenv("CB_TOKEN", "")

async def main() -> None:
    async with ChaturbateClient(username, token, 20) as client:
        response = await client.fetch_events()
        for event in response.events:
            logging.info(event.dict())  # Log the event as a dictionary

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

The application will start and begin fetching and printing events from the Chaturbate API using the credentials provided in the .env file.

Command-Line Interface (CLI)

Chaturbate Poller provides a CLI for ease of use. Below are the available commands and options.

Usage

python -m chaturbate_poller [OPTIONS]

Options

• --version: Show the version of Chaturbate Poller and exit.
• --testbed: Use the testbed environment.
• --timeout: Timeout for the API requests (default: 10 seconds).
• --username: Chaturbate username (default: from environment variable).
• --token: Chaturbate token (default: from environment variable).
• --verbose: Enable verbose logging.

Example

python -m chaturbate_poller --username your_username --token your_token --verbose

This command will start the poller using the provided username and token, with verbose logging enabled.

Docker

Pull the Latest Image

docker pull ghcr.io/mountaingod2/chaturbate_poller:latest

Run the Container

docker run \
  -e CB_USERNAME="YOUR_CHATURBATE_USERNAME" \
  -e CB_TOKEN="YOUR_CHATURBATE_API_TOKEN" \
  -e INFLUXDB_URL="http://influxdb:8086" \
  -e INFLUXDB_TOKEN="YOUR_INFLUX_TOKEN" \
  -e INFLUXDB_ORG="chaturbate-poller" \
  -e INFLUXDB_BUCKET="my-bucket" \
  -v /$HOME/chaturbate_poller:/app \
  ghcr.io/mountaingod2/chaturbate_poller:latest --testbed

Development

Setting Up a Development Environment

1. Create a virtual environment and activate it:

   python -m venv .venv
   source .venv/bin/activate  # On Windows, use `.venv\Scripts\Activate`
   

2. Install the development dependencies:

   pip install -r requirements-dev.txt
   

3. To run tests:

   pytest
   

Contributing

Contributions to the Chaturbate Poller are welcome! Please follow the standard fork-and-pull request workflow on GitHub to submit your changes.

1. Fork the repository.
2. Create a new feature branch.
3. Commit your changes.
4. Push the branch to your fork.
5. Open a pull request.

Please ensure your code adheres to the project's coding standards and includes appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits

chaturbate_poller was created with cookiecutter and the py-pkgs-cookiecutter template.