| Name | chaturbate-poller JSON |
| Version |
5.1.7
JSON |
| download |
| home_page | None |
| Summary | Python library for interacting with the Chaturbate Events API |
| upload_time | 2025-08-11 23:36:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
api
chaturbate
poller
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Chaturbate Poller
[](https://chaturbate-poller.readthedocs.io/en/stable/)
[](https://app.codecov.io/gh/MountainGod2/chaturbate_poller/)
[](https://www.codefactor.io/repository/github/mountaingod2/chaturbate_poller)
[](https://github.com/MountainGod2/chaturbate_poller/actions/workflows/cd.yml/)
[](https://github.com/MountainGod2/chaturbate_poller?tab=MIT-1-ov-file)
[](https://www.python.org/downloads/)
[](https://pypi.org/project/chaturbate-poller/)
[](https://hub.docker.com/r/mountaingod2/chaturbate_poller)
[](https://hub.docker.com/r/mountaingod2/chaturbate_poller)
</div>
Python library and CLI tool for interacting with the Chaturbate Events API. Monitor and analyze chat activity, tips, room status changes, and other events in real-time with support for structured logging, automated error handling, and optional InfluxDB integration.
## Features
- **Real-time Event Tracking**
- Monitor chat messages, tips, room status changes, and other events
- Configurable polling intervals with automatic rate limiting
- Support for both production and testbed environments
- **Unified Configuration**
- Centralized configuration management with validated options
- Consistent handling across CLI and programmatic interfaces
- Environment-based configuration with `.env` file support
- **Error Handling**
- Automatic retries with exponential backoff for transient errors
- Error classification and reporting
- Connection recovery after network interruptions
- **Event Processing**
- Event message formatting with enum-based event types
- Rich, structured event messages for readability
- Extensible formatting system for custom event handling
- **Logging**
- Structured JSON logs for machine parsing in non-TTY environments
- Rich console output with formatting
- Configurable verbosity levels
- **Data Persistence & Analytics**
- Optional InfluxDB integration for time-series storage
- Pre-configured sample queries for common analytics
- Docker build and runtime setup
## Installation
Here are a few ways to install the package:
### Using uv (Recommended)
Install with [uv](https://github.com/astral-sh/uv):
```bash
uv pip install chaturbate-poller
```
### Using pip
Make sure you have Python 3.12+ installed:
```bash
# Create and activate virtual environment
python3 -m venv .venv
source .venv/bin/activate
# Install the package
pip install chaturbate-poller
```
### Using uvx (CLI tool isolation)
Run the CLI without installing it in your Python environment:
```bash
uvx chaturbate_poller start
```
### Environment Configuration (Optional)
Create a `.env` file with your credentials:
```ini
# Required for API access
CB_USERNAME="your_chaturbate_username"
CB_TOKEN="your_chaturbate_token"
# Optional: InfluxDB settings (if using --database flag)
INFLUXDB_URL="http://influxdb:8086"
INFLUXDB_TOKEN="your_influxdb_token"
INFLUXDB_ORG="chaturbate-poller"
INFLUXDB_BUCKET="my-bucket"
USE_DATABASE="false" # Set to "true" to enable InfluxDB integration
```
**API Token:** You'll need to generate your token at [https://chaturbate.com/statsapi/authtoken/](https://chaturbate.com/statsapi/authtoken/) with "Events API" permission enabled.
## Quick Start
```bash
# With uv
uv run chaturbate_poller start --username your_username --token your_token
# Using testbed mode (for development/testing)
uv run chaturbate_poller start --testbed --verbose
# With pip installation
python -m chaturbate_poller start --username your_username --token your_token
```
## Usage
### CLI Usage
The CLI uses a unified configuration system for validation:
```bash
chaturbate_poller start [OPTIONS]
```
#### Common Options
| Option | Description | Default |
| ---------------------------- | ------------------------------ | ---------------- |
| `--username TEXT` | Your Chaturbate username | From `.env` file |
| `--token TEXT` | Your API token | From `.env` file |
| `--timeout FLOAT` | API request timeout in seconds | 10.0 |
| `--database / --no-database` | Enable InfluxDB integration | Disabled |
| `--testbed / --no-testbed` | Use testbed environment | Disabled |
| `--verbose / --no-verbose` | Enable detailed logging | Disabled |
| `--help` | Show help message and exit | |
For a complete list of the available CLI options:
```bash
chaturbate_poller --help
```
## InfluxDB Integration
When enabled with the `--database` flag, events are stored in InfluxDB for analytics and visualization.
### Sample Queries
Here are some useful InfluxDB Flux queries to analyze your Chaturbate data:
```text
// Event count by type (last 24 hours)
from(bucket: "events")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "chaturbate_events")
|> filter(fn: (r) => r._field == "method")
|> group(columns: ["_value"])
|> count()
|> sort(columns: ["_value"], desc: true)
// Total tips received (last 7 days)
from(bucket: "events")
|> range(start: -7d)
|> filter(fn: (r) => r._measurement == "chaturbate_events")
|> filter(fn: (r) => r.method == "tip")
|> filter(fn: (r) => r._field == "object.tip.tokens")
|> sum()
// Top chatters by message count (last 24 hours)
from(bucket: "events")
|> range(start: -24h)
|> filter(fn: (r) => r._measurement == "chaturbate_events")
|> filter(fn: (r) => r.method == "chatMessage")
|> filter(fn: (r) => r._field == "object.user.username")
|> group(columns: ["_value"])
|> count()
|> sort(columns: ["_value"], desc: true)
|> limit(n: 10)
```
For more details, check out the [example](https://github.com/MountainGod2/chaturbate_poller/tree/main/influxdb_queries.flux) file.
## Programmatic Usage
You can integrate the library into your own Python applications:
### Basic Example
```python
import asyncio
from chaturbate_poller import ChaturbateClient
async def main():
async with ChaturbateClient("your_username", "your_token") as client:
url = None
while True:
response = await client.fetch_events(url)
for event in response.events:
# Process each event
print(f"Event type: {event.method}")
print(event.model_dump_json(indent=2))
# Use the next URL for pagination
url = response.next_url
if __name__ == "__main__":
asyncio.run(main())
```
### Event Formatting
The library includes event message formatting:
```python
import asyncio
from chaturbate_poller import ChaturbateClient, format_message
async def main():
async with ChaturbateClient("your_username", "your_token") as client:
url = None
while True:
response = await client.fetch_events(url)
for event in response.events:
# Format events using the system
formatted_message = format_message(event)
if formatted_message:
print(formatted_message)
else:
print(f"Unformatted event: {event.method}")
url = response.next_url
if __name__ == "__main__":
asyncio.run(main())
```
### Custom Event Handlers
```python
import asyncio
from chaturbate_poller import ChaturbateClient, format_message
from chaturbate_poller.models.event import Event
async def handle_tip(event: Event) -> None:
"""Process tip events."""
if event.object.user and event.object.tip:
formatted_message = format_message(event)
print(formatted_message)
# Custom logic for large tips
amount = event.object.tip.tokens
if amount >= 100:
await send_special_thanks(event.object.user.username)
async def handle_chat(event: Event) -> None:
"""Process chat messages."""
formatted_message = format_message(event)
if formatted_message:
print(formatted_message)
async def send_special_thanks(username: str) -> None:
"""Send special thanks for large tips."""
print(f"Special thanks to {username} for the generous tip!")
async def main():
async with ChaturbateClient("your_username", "your_token") as client:
url = None
while True:
response = await client.fetch_events(url)
for event in response.events:
if event.method == "tip":
await handle_tip(event)
elif event.method == "chatMessage":
await handle_chat(event)
else:
formatted_message = format_message(event)
if formatted_message:
print(formatted_message)
url = response.next_url
if __name__ == "__main__":
asyncio.run(main())
```
### With InfluxDB Integration
```python
import asyncio
from chaturbate_poller import ChaturbateClient, format_message
from chaturbate_poller.database.influxdb_handler import InfluxDBHandler
async def main():
influx_handler = InfluxDBHandler()
async with ChaturbateClient("your_username", "your_token") as client:
url = None
while True:
response = await client.fetch_events(url)
for event in response.events:
formatted_message = format_message(event)
if formatted_message:
print(formatted_message)
# Store in InfluxDB if configured
if influx_handler.url:
influx_handler.write_event(
measurement="chaturbate_events",
data=event.model_dump()
)
url = response.next_url
if __name__ == "__main__":
asyncio.run(main())
```
## Changelog
View the complete [changelog](https://github.com/MountainGod2/chaturbate_poller/tree/main/CHANGELOG.md) for version history and updates.
## License
This project is licensed under the MIT License - see the [license](https://github.com/MountainGod2/chaturbate_poller/tree/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "chaturbate-poller",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "api, chaturbate, poller, python",
"author": null,
"author_email": "MountainGod2 <88257202+MountainGod2@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/0c/bb/e7931de3255490c2108a6d6cee72a013c4dbf70cbd1c482670a46de2706e/chaturbate_poller-5.1.7.tar.gz",
"platform": null,
"description": "\n\n# Chaturbate Poller\n\n[](https://chaturbate-poller.readthedocs.io/en/stable/)\n[](https://app.codecov.io/gh/MountainGod2/chaturbate_poller/)\n[](https://www.codefactor.io/repository/github/mountaingod2/chaturbate_poller)\n[](https://github.com/MountainGod2/chaturbate_poller/actions/workflows/cd.yml/)\n[](https://github.com/MountainGod2/chaturbate_poller?tab=MIT-1-ov-file)\n\n[](https://www.python.org/downloads/)\n[](https://pypi.org/project/chaturbate-poller/)\n[](https://hub.docker.com/r/mountaingod2/chaturbate_poller)\n[](https://hub.docker.com/r/mountaingod2/chaturbate_poller)\n\n</div>\n\nPython library and CLI tool for interacting with the Chaturbate Events API. Monitor and analyze chat activity, tips, room status changes, and other events in real-time with support for structured logging, automated error handling, and optional InfluxDB integration.\n\n## Features\n\n- **Real-time Event Tracking**\n\n - Monitor chat messages, tips, room status changes, and other events\n - Configurable polling intervals with automatic rate limiting\n - Support for both production and testbed environments\n\n- **Unified Configuration**\n\n - Centralized configuration management with validated options\n - Consistent handling across CLI and programmatic interfaces\n - Environment-based configuration with `.env` file support\n\n- **Error Handling**\n\n - Automatic retries with exponential backoff for transient errors\n - Error classification and reporting\n - Connection recovery after network interruptions\n\n- **Event Processing**\n\n - Event message formatting with enum-based event types\n - Rich, structured event messages for readability\n - Extensible formatting system for custom event handling\n\n- **Logging**\n\n - Structured JSON logs for machine parsing in non-TTY environments\n - Rich console output with formatting\n - Configurable verbosity levels\n\n- **Data Persistence & Analytics**\n - Optional InfluxDB integration for time-series storage\n - Pre-configured sample queries for common analytics\n - Docker build and runtime setup\n\n## Installation\n\nHere are a few ways to install the package:\n\n### Using uv (Recommended)\n\nInstall with [uv](https://github.com/astral-sh/uv):\n\n```bash\nuv pip install chaturbate-poller\n```\n\n### Using pip\n\nMake sure you have Python 3.12+ installed:\n\n```bash\n# Create and activate virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate\n\n# Install the package\npip install chaturbate-poller\n```\n\n### Using uvx (CLI tool isolation)\n\nRun the CLI without installing it in your Python environment:\n\n```bash\nuvx chaturbate_poller start\n```\n\n### Environment Configuration (Optional)\n\nCreate a `.env` file with your credentials:\n\n```ini\n# Required for API access\nCB_USERNAME=\"your_chaturbate_username\"\nCB_TOKEN=\"your_chaturbate_token\"\n\n# Optional: InfluxDB settings (if using --database flag)\nINFLUXDB_URL=\"http://influxdb:8086\"\nINFLUXDB_TOKEN=\"your_influxdb_token\"\nINFLUXDB_ORG=\"chaturbate-poller\"\nINFLUXDB_BUCKET=\"my-bucket\"\nUSE_DATABASE=\"false\" # Set to \"true\" to enable InfluxDB integration\n```\n\n**API Token:** You'll need to generate your token at [https://chaturbate.com/statsapi/authtoken/](https://chaturbate.com/statsapi/authtoken/) with \"Events API\" permission enabled.\n\n## Quick Start\n\n```bash\n# With uv\nuv run chaturbate_poller start --username your_username --token your_token\n\n# Using testbed mode (for development/testing)\nuv run chaturbate_poller start --testbed --verbose\n\n# With pip installation\npython -m chaturbate_poller start --username your_username --token your_token\n```\n\n## Usage\n\n### CLI Usage\n\nThe CLI uses a unified configuration system for validation:\n\n```bash\nchaturbate_poller start [OPTIONS]\n```\n\n#### Common Options\n\n| Option | Description | Default |\n| ---------------------------- | ------------------------------ | ---------------- |\n| `--username TEXT` | Your Chaturbate username | From `.env` file |\n| `--token TEXT` | Your API token | From `.env` file |\n| `--timeout FLOAT` | API request timeout in seconds | 10.0 |\n| `--database / --no-database` | Enable InfluxDB integration | Disabled |\n| `--testbed / --no-testbed` | Use testbed environment | Disabled |\n| `--verbose / --no-verbose` | Enable detailed logging | Disabled |\n| `--help` | Show help message and exit | |\n\nFor a complete list of the available CLI options:\n\n```bash\nchaturbate_poller --help\n```\n\n## InfluxDB Integration\n\nWhen enabled with the `--database` flag, events are stored in InfluxDB for analytics and visualization.\n\n### Sample Queries\n\nHere are some useful InfluxDB Flux queries to analyze your Chaturbate data:\n\n```text\n// Event count by type (last 24 hours)\nfrom(bucket: \"events\")\n |> range(start: -24h)\n |> filter(fn: (r) => r._measurement == \"chaturbate_events\")\n |> filter(fn: (r) => r._field == \"method\")\n |> group(columns: [\"_value\"])\n |> count()\n |> sort(columns: [\"_value\"], desc: true)\n\n// Total tips received (last 7 days)\nfrom(bucket: \"events\")\n |> range(start: -7d)\n |> filter(fn: (r) => r._measurement == \"chaturbate_events\")\n |> filter(fn: (r) => r.method == \"tip\")\n |> filter(fn: (r) => r._field == \"object.tip.tokens\")\n |> sum()\n\n// Top chatters by message count (last 24 hours)\nfrom(bucket: \"events\")\n |> range(start: -24h)\n |> filter(fn: (r) => r._measurement == \"chaturbate_events\")\n |> filter(fn: (r) => r.method == \"chatMessage\")\n |> filter(fn: (r) => r._field == \"object.user.username\")\n |> group(columns: [\"_value\"])\n |> count()\n |> sort(columns: [\"_value\"], desc: true)\n |> limit(n: 10)\n```\n\nFor more details, check out the [example](https://github.com/MountainGod2/chaturbate_poller/tree/main/influxdb_queries.flux) file.\n\n## Programmatic Usage\n\nYou can integrate the library into your own Python applications:\n\n### Basic Example\n\n```python\nimport asyncio\nfrom chaturbate_poller import ChaturbateClient\n\nasync def main():\n async with ChaturbateClient(\"your_username\", \"your_token\") as client:\n url = None\n while True:\n response = await client.fetch_events(url)\n for event in response.events:\n # Process each event\n print(f\"Event type: {event.method}\")\n print(event.model_dump_json(indent=2))\n\n # Use the next URL for pagination\n url = response.next_url\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n### Event Formatting\n\nThe library includes event message formatting:\n\n```python\nimport asyncio\nfrom chaturbate_poller import ChaturbateClient, format_message\n\nasync def main():\n async with ChaturbateClient(\"your_username\", \"your_token\") as client:\n url = None\n while True:\n response = await client.fetch_events(url)\n for event in response.events:\n # Format events using the system\n formatted_message = format_message(event)\n if formatted_message:\n print(formatted_message)\n else:\n print(f\"Unformatted event: {event.method}\")\n\n url = response.next_url\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n### Custom Event Handlers\n\n```python\nimport asyncio\nfrom chaturbate_poller import ChaturbateClient, format_message\nfrom chaturbate_poller.models.event import Event\n\nasync def handle_tip(event: Event) -> None:\n \"\"\"Process tip events.\"\"\"\n if event.object.user and event.object.tip:\n formatted_message = format_message(event)\n print(formatted_message)\n\n # Custom logic for large tips\n amount = event.object.tip.tokens\n if amount >= 100:\n await send_special_thanks(event.object.user.username)\n\nasync def handle_chat(event: Event) -> None:\n \"\"\"Process chat messages.\"\"\"\n formatted_message = format_message(event)\n if formatted_message:\n print(formatted_message)\n\nasync def send_special_thanks(username: str) -> None:\n \"\"\"Send special thanks for large tips.\"\"\"\n print(f\"Special thanks to {username} for the generous tip!\")\n\nasync def main():\n async with ChaturbateClient(\"your_username\", \"your_token\") as client:\n url = None\n while True:\n response = await client.fetch_events(url)\n for event in response.events:\n if event.method == \"tip\":\n await handle_tip(event)\n elif event.method == \"chatMessage\":\n await handle_chat(event)\n else:\n formatted_message = format_message(event)\n if formatted_message:\n print(formatted_message)\n url = response.next_url\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n### With InfluxDB Integration\n\n```python\nimport asyncio\nfrom chaturbate_poller import ChaturbateClient, format_message\nfrom chaturbate_poller.database.influxdb_handler import InfluxDBHandler\n\nasync def main():\n influx_handler = InfluxDBHandler()\n\n async with ChaturbateClient(\"your_username\", \"your_token\") as client:\n url = None\n while True:\n response = await client.fetch_events(url)\n for event in response.events:\n formatted_message = format_message(event)\n if formatted_message:\n print(formatted_message)\n\n # Store in InfluxDB if configured\n if influx_handler.url:\n influx_handler.write_event(\n measurement=\"chaturbate_events\",\n data=event.model_dump()\n )\n url = response.next_url\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n## Changelog\n\nView the complete [changelog](https://github.com/MountainGod2/chaturbate_poller/tree/main/CHANGELOG.md) for version history and updates.\n\n## License\n\nThis project is licensed under the MIT License - see the [license](https://github.com/MountainGod2/chaturbate_poller/tree/main/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for interacting with the Chaturbate Events API",
"version": "5.1.7",
"project_urls": {
"changelog": "https://github.com/MountainGod2/chaturbate_poller/blob/main/CHANGELOG.md",
"documentation": "https://mountaingod2.github.io/chaturbate_poller/",
"homepage": "https://github.com/MountainGod2/chaturbate_poller",
"issues": "https://github.com/MountainGod2/chaturbate_poller/issues",
"repository": "https://github.com/MountainGod2/chaturbate_poller"
},
"split_keywords": [
"api",
" chaturbate",
" poller",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5482b5262edd213d04905b43db44994db5e2f6dc7c3e29e94adf598c3bbab374",
"md5": "a7a7465e4f74548c1f53cb2e2bfb3b13",
"sha256": "840884705006b4cc98087a702e9b2f556e1a9d2b528b86289110e2a67f99aed8"
},
"downloads": -1,
"filename": "chaturbate_poller-5.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7a7465e4f74548c1f53cb2e2bfb3b13",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 33050,
"upload_time": "2025-08-11T23:36:22",
"upload_time_iso_8601": "2025-08-11T23:36:22.566101Z",
"url": "https://files.pythonhosted.org/packages/54/82/b5262edd213d04905b43db44994db5e2f6dc7c3e29e94adf598c3bbab374/chaturbate_poller-5.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0cbbe7931de3255490c2108a6d6cee72a013c4dbf70cbd1c482670a46de2706e",
"md5": "88425848731e1067031c20b414197d85",
"sha256": "5288dbf56d78f343399141f25cca000af3cfb02be3b4e5e28a97f42fa9e06f91"
},
"downloads": -1,
"filename": "chaturbate_poller-5.1.7.tar.gz",
"has_sig": false,
"md5_digest": "88425848731e1067031c20b414197d85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 237237,
"upload_time": "2025-08-11T23:36:24",
"upload_time_iso_8601": "2025-08-11T23:36:24.591616Z",
"url": "https://files.pythonhosted.org/packages/0c/bb/e7931de3255490c2108a6d6cee72a013c4dbf70cbd1c482670a46de2706e/chaturbate_poller-5.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 23:36:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MountainGod2",
"github_project": "chaturbate_poller",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chaturbate-poller"
}
