Poller for the Chaturbate events API.
Project description
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
- dotenv
Setup
To set up the Chaturbate Poller, follow these steps:
- Ensure Python 3.8 or higher is installed on your system.
- Install the Python package:
pip install chaturbate-poller
- Set up your environment variables by creating a
.env
file in the root directory with the following content:
CB_USERNAME=your_chaturbate_username
CB_TOKEN=your_api_token
Replace your_chaturbate_username
and your_api_token
with your actual Chaturbate username and API token.
Usage
To run the Chaturbate Poller, use the following command from the root directory of the project:
python examples/example.py
The application will start, log into the console, and begin fetching events from the Chaturbate API using the credentials provided in the .env
file.
See examples/example.py
for more detailed usage instructions.
Development
For development purposes, especially to run tests or develop additional features, consider setting up a virtual environment and installing the development dependencies:
python -m venv .venv
source .venv/bin/activate # On Windows, use `.venv\Scripts\Activate`
pip install -r requirements-dev.txt
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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chaturbate_poller-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbe643911534f2ac4ea5c4d72a97382427a2572fbc7d5ecafe4f20024d1b0c4e |
|
MD5 | dff55db1587d4a9fd76161370344c5c9 |
|
BLAKE2b-256 | ed18a0ff59a6454606f69bdfa29c3cd806536b6ba1534fb18cd4ff165701f3ae |