akipy 0.1.0__tar.gz

akipy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 advnpzn
+
+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.

akipy-0.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: akipy
+Version: 0.1.0
+Summary: A Python library wrapper for Akinator
+Author: advnpzn
+Author-email: adenosinetp10@protonmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Description-Content-Type: text/markdown
+
+# akipy [WIP]
+Python library wrapper for [akinator.com](https://akinator.com)
+
+Wrapper is still in development.
+Some things are not present or partially present.
+
+Such as,
+* Exception Handling
+* Docs
+* Better error Handling
+* Custom Exceptions
+
+These are the things I'll be working on trying to improve. If you want to help,
+the above is the main priority for now.
+
+# Why ?
+I already used to use a wrapper library for Akinator ([akinator.py](https://github.com/Ombucha/akinator.py)) before.
+But suddenly it seems to be not working. I debugged and made 
+sure the problem is because of API changes from Akinator themselves. 
+There were so many changes making me think I would have to change a lot of things. 
+So instead of doing that, I just made it from scratch. Obviously I took a lot 
+of inspiration from the old Python wrapper I was using thus the code structure 
+would look very similar. In fact, I'm trying to replicate the same interface that 
+was present in the old wrapper. Because I don't want to make changes to any piece 
+of software that may depend on this library (which isn't working now).
+
+I hope there isn't any interface breaking changes here. If there are any, please 
+contact me either through Telegram or raise an issue here on GitHub or if you want 
+to help, raise a Pull Request.
+
+# Installation
+
+`pip install akipy`
+
+# Usage
+
+There is both synchronous and asynchronous variants of `akipy` available.
+
+Synchronous: `from akipy import Akinator`
+
+Asynchronous: `from akipy.async_akipy import Akinator`
+
+I'll provide a sample usage for synchronous usage of `Akinator`.
+All the examples are also in the project's examples folder. So please check them out as well.
+
+```python
+import akipy
+
+aki = akipy.Akinator()
+aki.start_game()
+
+while not aki.win:
+    ans = input(aki.question + "\n\t")
+    if ans == "b":
+        try:
+            aki.back()
+        except akipy.CantGoBackAnyFurther:
+            pass
+    else:
+        aki.answer(ans)
+
+print(aki.name_proposition)
+print(aki.description_proposition)
+print(aki.pseudo)
+print(aki.photo)
+```
+
+
+
+
+
+
+

akipy-0.1.0/README.md

@@ -0,0 +1,72 @@
+# akipy [WIP]
+Python library wrapper for [akinator.com](https://akinator.com)
+
+Wrapper is still in development.
+Some things are not present or partially present.
+
+Such as,
+* Exception Handling
+* Docs
+* Better error Handling
+* Custom Exceptions
+
+These are the things I'll be working on trying to improve. If you want to help,
+the above is the main priority for now.
+
+# Why ?
+I already used to use a wrapper library for Akinator ([akinator.py](https://github.com/Ombucha/akinator.py)) before.
+But suddenly it seems to be not working. I debugged and made 
+sure the problem is because of API changes from Akinator themselves. 
+There were so many changes making me think I would have to change a lot of things. 
+So instead of doing that, I just made it from scratch. Obviously I took a lot 
+of inspiration from the old Python wrapper I was using thus the code structure 
+would look very similar. In fact, I'm trying to replicate the same interface that 
+was present in the old wrapper. Because I don't want to make changes to any piece 
+of software that may depend on this library (which isn't working now).
+
+I hope there isn't any interface breaking changes here. If there are any, please 
+contact me either through Telegram or raise an issue here on GitHub or if you want 
+to help, raise a Pull Request.
+
+# Installation
+
+`pip install akipy`
+
+# Usage
+
+There is both synchronous and asynchronous variants of `akipy` available.
+
+Synchronous: `from akipy import Akinator`
+
+Asynchronous: `from akipy.async_akipy import Akinator`
+
+I'll provide a sample usage for synchronous usage of `Akinator`.
+All the examples are also in the project's examples folder. So please check them out as well.
+
+```python
+import akipy
+
+aki = akipy.Akinator()
+aki.start_game()
+
+while not aki.win:
+    ans = input(aki.question + "\n\t")
+    if ans == "b":
+        try:
+            aki.back()
+        except akipy.CantGoBackAnyFurther:
+            pass
+    else:
+        aki.answer(ans)
+
+print(aki.name_proposition)
+print(aki.description_proposition)
+print(aki.pseudo)
+print(aki.photo)
+```
+
+
+
+
+
+

akipy-0.1.0/akipy/__init__.py

@@ -0,0 +1,9 @@
+"""
+akipy - A Python wrapper library for Akinator
+
+:copyright: (c) 2024, advnpzn
+:license: MIT, see LICENSE for more details.
+"""
+
+from .akinator import Akinator
+from .exceptions import *

akipy-0.1.0/akipy/akinator.py

@@ -0,0 +1,185 @@
+"""
+MIT License
+
+Copyright (c) 2024 advnpzn
+
+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.
+
+"""
+import json
+import re
+
+try:
+    import httpx
+except ImportError:
+    raise ImportError('httpx is not installed')
+
+from .dicts import HEADERS, THEME_ID, THEMES, LANG_MAP
+from .exceptions import InvalidLanguageError, CantGoBackAnyFurther
+from .utils import get_answer_id, request_handler
+
+
+class Akinator:
+    """
+    The ``Akinator`` Class represents the Akinator Game.
+    You need to create an Instance of this Class to get started.
+    """
+
+    def __init__(self):
+        self.photo = None
+        self.pseudo = None
+        self.uri = None
+        self.theme = None
+        self.session = None
+        self.signature = None
+        self.child_mode: bool = False
+        self.lang = None
+        self.available_themes = None
+        self.theme = None
+
+        self.question = None
+        self.progression = None
+        self.step = None
+        self.akitude = None
+        self.step_last_proposition = ""
+
+        self.win = False
+        self.name_proposition = None
+        self.description_proposition = None
+        self.completion = None
+
+    def start_game(self, language: str | None = "en", child_mode: bool = False):
+        """
+        This method is responsible for actually starting the game scene.
+        You can pass the following parameters to set your language preference and as well as the Child Mode.
+        If language is not set, English is used by default. Child Mode is set to ``False`` by default.
+        :param language: "en"
+        :param child_mode: False
+        :return: None
+        """
+
+        self.__get_region(lang=language)
+        self.__initialise()
+
+    def answer(self, option):
+        url = f"{self.uri}/answer"
+        data = {
+            "step": self.step,
+            "progression": self.progression,
+            "sid": self.theme,
+            "cm": str(self.child_mode).lower(),
+            "answer": get_answer_id(option),
+            "step_last_proposition": self.step_last_proposition,
+            "session": self.session,
+            "signature": self.signature,
+        }
+        print(data)
+        try:
+            req = request_handler(url=url, method='POST', data=data)
+            resp = json.loads(req.text)
+
+            if re.findall(r"id_proposition", str(resp)):
+                self.__update(action="win", resp=resp)
+            else:
+                self.__update(action="answer", resp=resp)
+            self.completion = resp['completion']
+        except Exception as e:
+            raise e
+
+    def back(self):
+        if self.step == 1:
+            raise CantGoBackAnyFurther
+        else:
+            url = f"{self.uri}/cancel_answer"
+            data = {
+                "step": self.step,
+                "progression": self.progression,
+                "sid": self.theme,
+                "cm": str(self.child_mode).lower(),
+                "session": self.session,
+                "signature": self.signature,
+            }
+
+            try:
+                req = request_handler(url=url, method='POST', data=data)
+                resp = json.loads(req.text)
+                self.__update(action="back", resp=resp)
+            except Exception as e:
+                raise e
+
+    def __update(self, action: str, resp):
+        if action == "answer":
+            self.akitude = resp['akitude']
+            self.step = resp['step']
+            self.progression = resp['progression']
+            self.question = resp['question']
+        elif action == "back":
+            self.akitude = resp['akitude']
+            self.step = resp['step']
+            self.progression = resp['progression']
+            self.question = resp['question']
+        elif action == "win":
+            self.win = True
+            self.name_proposition = resp['name_proposition']
+            self.description_proposition = resp['description_proposition']
+            self.pseudo = resp['pseudo']
+            self.photo = resp['photo']
+
+    def __get_region(self, lang):
+        try:
+            if len(lang) > 2:
+                lang = LANG_MAP[lang]
+            else:
+                assert (lang in LANG_MAP.values())
+        except Exception:
+            raise InvalidLanguageError(lang)
+        url = f"https://{lang}.akinator.com"
+        try:
+            req = request_handler(url=url, method='GET')
+            if req.status_code != 200:
+                raise httpx.HTTPStatusError
+            else:
+                self.uri = url
+                self.lang = lang
+
+                self.available_themes = THEMES[lang]
+                self.theme = THEME_ID[self.available_themes[0]]
+        except Exception as e:
+            raise e
+
+    def __initialise(self):
+        url = f"{self.uri}/game"
+        data = {
+            "sid": self.theme,
+            "cm": str(self.child_mode).lower()
+        }
+        try:
+            req = request_handler(url=url, method='POST', data=data).text
+            match = re.findall(r"[a-zA-Z0-9+/]+==", req)[-2:]
+
+            self.session = match[0]
+            self.signature = match[1]
+
+            match = re.search(r'<div class="bubble-body"><p class="question-text" id="question-label">(.*?)</p></div>',
+                              req)
+            self.question = match.group(1)
+            self.progression = "0.00000"
+            self.step = 0
+        except Exception:
+            raise httpx.HTTPStatusError

akipy-0.1.0/akipy/async_akipy/__init__.py

@@ -0,0 +1,8 @@
+"""
+akipy - A Python wrapper library for Akinator
+
+:copyright: (c) 2024, advnpzn
+:license: MIT, see LICENSE for more details.
+"""
+
+from .async_akinator import Akinator

akipy-0.1.0/akipy/async_akipy/async_akinator.py

@@ -0,0 +1,187 @@
+"""
+MIT License
+
+Copyright (c) 2024 advnpzn
+
+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.
+
+"""
+import json
+import re
+import asyncio
+
+try:
+    import httpx
+except ImportError:
+    raise ImportError('httpx is not installed')
+
+from ..dicts import HEADERS, THEME_ID, THEMES, LANG_MAP
+from ..exceptions import InvalidLanguageError, CantGoBackAnyFurther
+from ..utils import get_answer_id, async_request_handler
+
+
+class Akinator:
+    """
+    The ``Akinator`` Class represents the Akinator Game.
+    You need to create an Instance of this Class to get started.
+    """
+
+    def __init__(self):
+        self.photo = None
+        self.pseudo = None
+        self.uri = None
+        self.theme = None
+        self.session = None
+        self.signature = None
+        self.child_mode: bool = False
+        self.lang = None
+        self.available_themes = None
+        self.theme = None
+
+        self.question = None
+        self.progression = None
+        self.step = None
+        self.akitude = None
+        self.step_last_proposition = ""
+
+        self.win = False
+        self.name_proposition = None
+        self.description_proposition = None
+        self.completion = None
+
+    async def __update(self, action: str, resp):
+        if action == "answer":
+            self.akitude = resp['akitude']
+            self.step = resp['step']
+            self.progression = resp['progression']
+            self.question = resp['question']
+        elif action == "back":
+            self.akitude = resp['akitude']
+            self.step = resp['step']
+            self.progression = resp['progression']
+            self.question = resp['question']
+        elif action == "win":
+            self.win = True
+            self.name_proposition = resp['name_proposition']
+            self.description_proposition = resp['description_proposition']
+            self.pseudo = resp['pseudo']
+            self.photo = resp['photo']
+
+    async def __get_region(self, lang):
+        try:
+            if len(lang) > 2:
+                lang = LANG_MAP[lang]
+            else:
+                assert (lang in LANG_MAP.values())
+        except Exception:
+            raise InvalidLanguageError(lang)
+        url = f"https://{lang}.akinator.com"
+        try:
+            req = await async_request_handler(url=url, method='GET')
+            if req.status_code != 200:
+                raise httpx.HTTPStatusError
+            else:
+                self.uri = url
+                self.lang = lang
+
+                self.available_themes = THEMES[lang]
+                self.theme = THEME_ID[self.available_themes[0]]
+        except Exception as e:
+            raise e
+
+    async def __initialise(self):
+        url = f"{self.uri}/game"
+        data = {
+            "sid": self.theme,
+            "cm": str(self.child_mode).lower()
+        }
+        try:
+            req = await async_request_handler(url=url, method='POST', data=data)
+            match = re.findall(r"[a-zA-Z0-9+/]+==", req.text)[-2:]
+
+            self.session = match[0]
+            self.signature = match[1]
+
+            match = re.search(r'<div class="bubble-body"><p class="question-text" id="question-label">(.*?)</p></div>',
+                              req.text)
+            self.question = match.group(1)
+            self.progression = "0.00000"
+            self.step = 0
+        except Exception:
+            raise httpx.HTTPStatusError
+
+    async def start_game(self, language: str | None = "en", child_mode: bool = False):
+        """
+        This method is responsible for actually starting the game scene.
+        You can pass the following parameters to set your language preference and as well as the Child Mode.
+        If language is not set, English is used by default. Child Mode is set to ``False`` by default.
+        :param language: "en"
+        :param child_mode: False
+        :return: None
+        """
+
+        await self.__get_region(lang=language)
+
+        await self.__initialise()
+
+    async def answer(self, option):
+        url = f"{self.uri}/answer"
+        data = {
+            "step": self.step,
+            "progression": self.progression,
+            "sid": self.theme,
+            "cm": str(self.child_mode).lower(),
+            "answer": get_answer_id(option),
+            "step_last_proposition": self.step_last_proposition,
+            "session": self.session,
+            "signature": self.signature,
+        }
+
+        try:
+            req = await async_request_handler(url=url, method='POST', data=data)
+            resp = json.loads(req.text)
+
+            if re.findall(r"id_proposition", str(resp)):
+                await self.__update(action="win", resp=resp)
+            else:
+                await self.__update(action="answer", resp=resp)
+            self.completion = resp['completion']
+        except Exception as e:
+            raise e
+
+    async def back(self):
+        if self.step == 1:
+            raise CantGoBackAnyFurther
+        else:
+            url = f"{self.uri}/cancel_answer"
+            data = {
+                "step": self.step,
+                "progression": self.progression,
+                "sid": self.theme,
+                "cm": str(self.child_mode).lower(),
+                "session": self.session,
+                "signature": self.signature,
+            }
+
+            try:
+                req = await async_request_handler(url=url, method='POST', data=data)
+                resp = json.loads(req.text)
+                await self.__update(action="back", resp=resp)
+            except Exception as e:
+                raise e

akipy-0.1.0/akipy/dicts.py

@@ -0,0 +1,67 @@
+HEADERS = {
+    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+    "Accept-Encoding": "gzip, deflate",
+    "Accept-Language": "en-US,en;q=0.9",
+    "User-Agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) snap Chromium/81.0.4044.92 "
+                  "Chrome/81.0.4044.92 Safari/537.36",
+    "x-requested-with": "XMLHttpRequest",
+}
+
+LANG_MAP = {
+    "english": "en",
+    "arabic": "ar",
+    "chinese": "cn",
+    "german": "de",
+    "spanish": "es",
+    "french": "fr",
+    "hebrew": "il",
+    "italian": "it",
+    "japanese": "jp",
+    "korean": "kr",
+    "dutch": "nl",
+    "polish": "pl",
+    "portuguese": "pt",
+    "russian": "ru",
+    "turkish": "tr",
+    "indonesian": "id"
+}
+
+THEME_ID = {
+    "c": 1,
+    "a": 14,
+    "o": 2
+}
+
+"""
+c - characters
+a - animals
+o - objects
+"""
+
+THEMES = {
+    "en": ["c", "a", "o"],
+    "ar": ["c"],
+    "cn": ["c"],
+    "de": ["c", "a"],
+    "es": ["c", "a"],
+    "fr": ["c", "a", "o"],
+    "il": ["c"],
+    "it": ["c", "a"],
+    "jp": ["c", "a"],
+    "kr": ["c"],
+    "nl": ["c"],
+    "pl": ["c"],
+    "pt": ["c"],
+    "ru": ["c"],
+    "tr": ["c"],
+    "id": ["c"],
+}
+
+ANSWERS = {
+    0: ["yes", "y", '0'],
+    1: ["no", "n", '1'],
+    2: ["i", "idk", "i dont know", "i don't know", '2'],
+    3: ["p", "probably", '3'],
+    4: ["pn", "probably not", '4'],
+}
+

akipy-0.1.0/akipy/exceptions.py

@@ -0,0 +1,8 @@
+class InvalidLanguageError(ValueError):
+    """Raise when the user input language is invalid or not supported by Akinator"""
+    pass
+
+
+class CantGoBackAnyFurther(Exception):
+    """Raises when the user is in the first question and tries to go back further"""
+    pass

akipy-0.1.0/akipy/utils.py

@@ -0,0 +1,27 @@
+import httpx
+
+from .dicts import ANSWERS, HEADERS
+
+
+def request_handler(url: str, method: str, data: dict | None = None) -> httpx.Response:
+    if method == 'GET':
+        return httpx.get(url, headers=HEADERS, timeout=30.0)
+    elif method == 'POST':
+        return httpx.post(url, headers=HEADERS, data=data, timeout=30.0)
+
+
+async def async_request_handler(url: str, method: str, data: dict | None = None) -> httpx.Response:
+    if method == 'GET':
+        async with httpx.AsyncClient() as client:
+            return await client.get(url, headers=HEADERS, timeout=30.0)
+    elif method == 'POST':
+        async with httpx.AsyncClient() as client:
+            return await client.post(url, headers=HEADERS, data=data, timeout=30.0)
+
+
+def get_answer_id(ans: str | int):
+    for key, values in ANSWERS.items():
+        if ans in values:
+            return key
+        else:
+            continue

akipy-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "akipy"
+version = "0.1.0"
+description = "A Python library wrapper for Akinator"
+authors = ["advnpzn <adenosinetp10@protonmail.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+httpx = "^0.27.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"