chatady 1.0.1

A Python wrapper for the ChatADy API.

ChatADy Package for Python

The ChatADy package is a Python wrapper for the ChatADy API, facilitating easy interaction with ChatADy's services from Python applications. It provides methods to retrieve contents and initiate new chats.

Installation

To install ChatADy, run this command in your terminal:

pip install chatady

This is the preferred method to install ChatADy, as it will always install the most recent stable release.

If you don't have pip installed, this Python installation guide can guide you through the process.

Usage

To use the ChatADy package, you first need to import the ChatADy class from the package and then initialize it with your publisher ID and key.

Quick Start

Here's a quick example to get you started:

from chatady.chatady import ChatADy

# Initialize the ChatADy client
client = ChatADy(publisher_id='your_publisher_id', key='your_api_key')

# Send in messages
response = client.new_chat(chat_id='unique_id_identifying_conversation', entry='your_entry_message', human='boolean_human_or_bot')
print(response)

# Get ad contents
response = client.get_contents(chat_id='unique_id_identifying_conversation')
print(response)

Initializing the Client

To interact with the API, you need to create an instance of ChatADy:

client = ChatADy(publisher_id='your_publisher_id', key='your_api_key')

You can also pass additional options as a dictionary to configure the client further:

options = {'environment': 'production', 'noDelay': True, 'timeout': 1000}
client = ChatADy(publisher_id='your_publisher_id', key='your_api_key', options=options)

Retrieving Ad Contents

To retrieve contents, use the get_contents method with the chat ID. You can also specify options for filtering:

response = client.get_contents(chat_id='unique_id_identifying_conversation', options={'humansex': 'male', 'botsex': 'female'})
print(response)

Sending in a New Message

To start a new chat, use the new_chat method with the chat ID, entry message, and human identifier:

response = client.new_chat(chat_id='unique_id_identifying_conversation', entry='Hello, ChatADy!', human='boolean_human_or_bot')
print(response)

Support

For issues, questions, or contributions, please open an issue on the GitHub repository.

License

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