| Name | chatady JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for the ChatADy API. |
| upload_time | 2024-09-04 10:54:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 ARCLOOP LIMITED Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
chatady
api
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
```bash
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](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) 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:
```python
from chatady.chatady import ChatADy
# Initialize the ChatADy client
client = ChatADy('your_publisher_id', 'your_api_key')
# Send in messages
response = client.new_chat('unique_id_identifying_conversation', 'your_entry_message', 'boolean_human_or_bot')
print(response)
# Get ad contents
response = client.get_contents('unique_id_identifying_conversation')
print(response)
```
### Initializing the Client
To interact with the API, you need to create an instance of `ChatADy`:
```python
client = ChatADy('your_publisher_id', 'your_api_key')
```
You can also pass additional options as a dictionary to configure the client further:
```python
options = {'environment': 'production', 'noDelay': True, 'timeout': 1000}
client = ChatADy('your_publisher_id', 'your_api_key', options)
```
### Retrieving Ad Contents
To retrieve contents, use the `get_contents` method with the chat ID. You can also specify options for better targeting:
```python
response = client.get_contents('unique_id_identifying_conversation', {'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:
```python
response = client.new_chat('unique_id_identifying_conversation', 'Hello, ChatADy!', '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.
Raw data
{
"_id": null,
"home_page": null,
"name": "chatady",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "chatady, api, wrapper",
"author": null,
"author_email": "Jernej Pregelj <contact@chatady.com>",
"download_url": "https://files.pythonhosted.org/packages/f0/4c/09cda4c3897f836fdc9b1a408dd7bd455cf0c22bc96341f27c4a0258c0e3/chatady-1.1.0.tar.gz",
"platform": null,
"description": "# ChatADy Package for Python\n\nThe `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.\n\n## Installation\n\nTo install ChatADy, run this command in your terminal:\n\n```bash\npip install chatady\n```\n\nThis is the preferred method to install ChatADy, as it will always install the most recent stable release.\n\nIf you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.\n\n## Usage\n\nTo 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.\n\n### Quick Start\n\nHere's a quick example to get you started:\n\n```python\nfrom chatady.chatady import ChatADy\n\n# Initialize the ChatADy client\nclient = ChatADy('your_publisher_id', 'your_api_key')\n\n# Send in messages\nresponse = client.new_chat('unique_id_identifying_conversation', 'your_entry_message', 'boolean_human_or_bot')\nprint(response)\n\n# Get ad contents\nresponse = client.get_contents('unique_id_identifying_conversation')\nprint(response)\n```\n\n### Initializing the Client\n\nTo interact with the API, you need to create an instance of `ChatADy`:\n\n```python\nclient = ChatADy('your_publisher_id', 'your_api_key')\n```\n\nYou can also pass additional options as a dictionary to configure the client further:\n\n```python\noptions = {'environment': 'production', 'noDelay': True, 'timeout': 1000}\nclient = ChatADy('your_publisher_id', 'your_api_key', options)\n```\n\n### Retrieving Ad Contents\n\nTo retrieve contents, use the `get_contents` method with the chat ID. You can also specify options for better targeting:\n\n```python\nresponse = client.get_contents('unique_id_identifying_conversation', {'humansex': 'male', 'botsex': 'female'})\nprint(response)\n```\n\n### Sending in a New Message\n\nTo start a new chat, use the `new_chat` method with the chat ID, entry message, and human identifier:\n\n```python\nresponse = client.new_chat('unique_id_identifying_conversation', 'Hello, ChatADy!', 'boolean_human_or_bot')\nprint(response)\n```\n\n## Support\n\nFor issues, questions, or contributions, please open an issue on the GitHub repository.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 ARCLOOP LIMITED Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python wrapper for the ChatADy API.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/ChatADy/chatady-python"
},
"split_keywords": [
"chatady",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20ac7dfa271bcc7d2612d9ccb49dd8e91f4c805b8d995d21ceb19b0b8a65727f",
"md5": "03e86ba13cb73ffbc9253865c6e3cf3b",
"sha256": "e34e345ac379bc5aa9b51f93cd44c3ec2960241432cd0b19e57353e1b8bf5a14"
},
"downloads": -1,
"filename": "chatady-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03e86ba13cb73ffbc9253865c6e3cf3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4843,
"upload_time": "2024-09-04T10:54:13",
"upload_time_iso_8601": "2024-09-04T10:54:13.777267Z",
"url": "https://files.pythonhosted.org/packages/20/ac/7dfa271bcc7d2612d9ccb49dd8e91f4c805b8d995d21ceb19b0b8a65727f/chatady-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f04c09cda4c3897f836fdc9b1a408dd7bd455cf0c22bc96341f27c4a0258c0e3",
"md5": "65a3252d48ae2c67e1fd11486b86a959",
"sha256": "8499968d1695fde778b354f9b9a79f5f1c608581e7feff3c30666268fc880c7b"
},
"downloads": -1,
"filename": "chatady-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "65a3252d48ae2c67e1fd11486b86a959",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3919,
"upload_time": "2024-09-04T10:54:15",
"upload_time_iso_8601": "2024-09-04T10:54:15.090294Z",
"url": "https://files.pythonhosted.org/packages/f0/4c/09cda4c3897f836fdc9b1a408dd7bd455cf0c22bc96341f27c4a0258c0e3/chatady-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 10:54:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ChatADy",
"github_project": "chatady-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chatady"
}
