| Name | py-akinator JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A Python library for interacting with the Akinator game API |
| upload_time | 2024-08-26 20:33:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License |
| keywords |
akinator
game
api
async
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# akinator-py
A Python library for interacting with the Akinator game API. This library provides both synchronous and asynchronous methods to interact with the Akinator game, allowing users to start a game, answer questions, and navigate back to previous questions.
## Installation
You can install the library using pip:
```bash
pip install akinatorpy
```
## Usage
### Synchronous Usage
```python
from akinator import Akinator, Answer, Language
aki = Akinator(language=Language.English)
start_result = aki.start_game()
if start_result.ok:
print(f"First question: {start_result.result.question}")
```
### Asynchronous Usage
```python
import asyncio
from akinator import AsyncAkinator, Answer, Language
async def main():
aki = AsyncAkinator(language=Language.English)
start_result = await aki.start_game()
if start_result.ok:
print(f"First question: {start_result.result.question}")
asyncio.run(main())
```
## Features
- Supports both synchronous and asynchronous interaction with the Akinator API.
- Caching mechanism to store game state and optimize API calls.
- Simple and intuitive API design for ease of use.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contributing
Contributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.md) file for guidelines.
## Support
If you have any questions or issues, please open an issue on the [GitHub repository](https://github.com/DevsCommons/akinator-py/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "py-akinator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "akinator, game, api, async",
"author": null,
"author_email": "Rio <contact@devrio.org>",
"download_url": "https://files.pythonhosted.org/packages/d9/c0/9e897e9d0ae425c0b8c3999f28fd0836415832059143b1640b3e63521fbd/py_akinator-0.0.1.tar.gz",
"platform": null,
"description": "# akinator-py\n\nA Python library for interacting with the Akinator game API. This library provides both synchronous and asynchronous methods to interact with the Akinator game, allowing users to start a game, answer questions, and navigate back to previous questions.\n\n## Installation\n\nYou can install the library using pip:\n\n```bash\npip install akinatorpy\n```\n\n## Usage\n\n### Synchronous Usage\n\n```python\nfrom akinator import Akinator, Answer, Language\n\naki = Akinator(language=Language.English)\nstart_result = aki.start_game()\n\nif start_result.ok:\n print(f\"First question: {start_result.result.question}\")\n```\n\n### Asynchronous Usage\n\n```python\nimport asyncio\nfrom akinator import AsyncAkinator, Answer, Language\n\nasync def main():\n aki = AsyncAkinator(language=Language.English)\n start_result = await aki.start_game()\n\n if start_result.ok:\n print(f\"First question: {start_result.result.question}\")\n\nasyncio.run(main())\n```\n\n## Features\n\n- Supports both synchronous and asynchronous interaction with the Akinator API.\n- Caching mechanism to store game state and optimize API calls.\n- Simple and intuitive API design for ease of use.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n## Contributing\n\nContributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.md) file for guidelines.\n\n## Support\n\nIf you have any questions or issues, please open an issue on the [GitHub repository](https://github.com/DevsCommons/akinator-py/issues).\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Python library for interacting with the Akinator game API",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/DevsCommons/akinator-py/issues",
"Homepage": "https://github.com/DevsCommons/akinator-py"
},
"split_keywords": [
"akinator",
" game",
" api",
" async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7170b2dafef359da0aa08725bb8c6df32f52201e40475b2b4629f116d159652",
"md5": "8ac570ad29ac6830d76db19884f1ca10",
"sha256": "d2451e1d534b17f3cb06b4aa30bc103ffb021f5ede27e7716e709dfc3e5a522b"
},
"downloads": -1,
"filename": "py_akinator-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ac570ad29ac6830d76db19884f1ca10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7832,
"upload_time": "2024-08-26T20:33:42",
"upload_time_iso_8601": "2024-08-26T20:33:42.679327Z",
"url": "https://files.pythonhosted.org/packages/a7/17/0b2dafef359da0aa08725bb8c6df32f52201e40475b2b4629f116d159652/py_akinator-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d9c09e897e9d0ae425c0b8c3999f28fd0836415832059143b1640b3e63521fbd",
"md5": "69fbe93d0a1153dc862160df3c65e48e",
"sha256": "834f9f8cd4c28627c0378a94f76ada02ad79078455f9dcd1e32eaaa2bc54e848"
},
"downloads": -1,
"filename": "py_akinator-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "69fbe93d0a1153dc862160df3c65e48e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7563,
"upload_time": "2024-08-26T20:33:43",
"upload_time_iso_8601": "2024-08-26T20:33:43.669109Z",
"url": "https://files.pythonhosted.org/packages/d9/c0/9e897e9d0ae425c0b8c3999f28fd0836415832059143b1640b3e63521fbd/py_akinator-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 20:33:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DevsCommons",
"github_project": "akinator-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-akinator"
}
