Jikan4 0.3.0__tar.gz

jikan4-0.3.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

jikan4-0.3.0/.gitignore

@@ -0,0 +1,154 @@
+*.ipynb
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

jikan4-0.3.0/LICENSE

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

jikan4-0.3.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.5
+Name: Jikan4
+Version: 0.3.0
+Summary: A Python wrapper for an anime API, with Tenrai as the default backend
+Project-URL: Documentation, https://github.com/mdabessa/jikan4#readme
+Project-URL: Issues, https://github.com/mdabessa/jikan4/issues
+Project-URL: Source, https://github.com/mdabessa/jikan4
+Author-email: Matheus Bessa <mdabessa@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: pydantic
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# jikan4
+ A Python wrapper for an anime API, with Tenrai as the default backend.
+
+
+## Tenrai Endpoint Support
+
+The client currently uses these Tenrai v1 endpoints:
+
+| Client method | Endpoint | Status |
+| --- | --- | --- |
+| `get_anime` | `GET /anime/{id}` | Supported |
+| `get_anime_full` | `GET /anime/{id}/full` | Supported |
+| `get_anime_characters` | `GET /anime/{id}/characters` | Supported |
+| `get_anime_staff` | `GET /anime/{id}/staff` | Supported |
+| `get_anime_episodes` | `GET /anime/{id}/episodes` | Supported |
+| `get_anime_episode` | `GET /anime/{id}/episodes/{episode}` | Supported |
+| `get_anime_news` | `GET /anime/{id}/news` | Supported |
+| `search_anime` | `GET /anime` | Supported |
+| `get_anime_forum` | `GET /anime/{id}/forum` | Supported |
+
+
+## Installation
+```bash
+pip install jikan4
+```
+
+## Usage
+
+### Basic Usage
+```python
+from jikan4.jikan import Jikan
+
+jikan = Jikan()
+
+anime = jikan.get_anime(1)
+search = jikan.search_anime("tv", "naruto")
+```
+
+### Async Usage
+```python
+import asyncio
+from jikan4.aiojikan import AioJikan
+
+
+async def main():
+    jikan = AioJikan()
+
+    anime = await jikan.get_anime(1)
+    search = await jikan.search_anime('tv', 'naruto')
+
+    jikan.close()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```

jikan4-0.3.0/README.md

@@ -0,0 +1,56 @@
+# jikan4
+ A Python wrapper for an anime API, with Tenrai as the default backend.
+
+
+## Tenrai Endpoint Support
+
+The client currently uses these Tenrai v1 endpoints:
+
+| Client method | Endpoint | Status |
+| --- | --- | --- |
+| `get_anime` | `GET /anime/{id}` | Supported |
+| `get_anime_full` | `GET /anime/{id}/full` | Supported |
+| `get_anime_characters` | `GET /anime/{id}/characters` | Supported |
+| `get_anime_staff` | `GET /anime/{id}/staff` | Supported |
+| `get_anime_episodes` | `GET /anime/{id}/episodes` | Supported |
+| `get_anime_episode` | `GET /anime/{id}/episodes/{episode}` | Supported |
+| `get_anime_news` | `GET /anime/{id}/news` | Supported |
+| `search_anime` | `GET /anime` | Supported |
+| `get_anime_forum` | `GET /anime/{id}/forum` | Supported |
+
+
+## Installation
+```bash
+pip install jikan4
+```
+
+## Usage
+
+### Basic Usage
+```python
+from jikan4.jikan import Jikan
+
+jikan = Jikan()
+
+anime = jikan.get_anime(1)
+search = jikan.search_anime("tv", "naruto")
+```
+
+### Async Usage
+```python
+import asyncio
+from jikan4.aiojikan import AioJikan
+
+
+async def main():
+    jikan = AioJikan()
+
+    anime = await jikan.get_anime(1)
+    search = await jikan.search_anime('tv', 'naruto')
+
+    jikan.close()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```

jikan4-0.3.0/jikan4/__init__.py

@@ -0,0 +1,6 @@
+from .aiojikan import AioJikan
+from .jikan import Jikan
+from jikan4.__version__ import __version__
+
+
+__all__ = ["Jikan", "AioJikan", "__version__"]

jikan4-0.3.0/jikan4/__version__.py

@@ -0,0 +1,3 @@
+VERSION = (0, 3, 0)
+
+__version__ = "0.3.0"

jikan4-0.3.0/jikan4/aiojikan.py

@@ -0,0 +1,262 @@
+from __future__ import annotations
+
+import aiohttp
+
+from .models import (
+    Anime,
+    AnimeSearch,
+    AnimeCharacters,
+    AnimeStaff,
+    AnimeEpisodes,
+    Episode,
+    AnimeNews,
+    AnimeForum,
+)
+from .utils.async_limiter import AsyncLimiter
+
+
+class AioJikan:
+    """Async anime API wrapper with Tenrai as the default backend."""
+
+    def __init__(
+        self, base_url: str = "https://api.tenrai.org/v1", rate_limit: int = 60
+    ) -> None:
+        """Construct a AioJikan object
+
+        Args:
+            base_url (str, optional): Base URL for the anime API. Defaults to "https://api.tenrai.org/v1".
+            rate_limit (int, optional): Rate limit in requests per minute. Defaults to 60.
+
+        Returns:
+            AioJikan: AioJikan object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> aiojikan = AioJikan("https://api.tenrai.org/v1")
+        """
+
+        base_url = base_url.rstrip("/")
+        self.base_url = base_url
+        self.session: aiohttp.ClientSession | None = None
+
+        if rate_limit:
+            self.rate_limiter = AsyncLimiter(calls_limit=rate_limit / 60, period=1)
+            self._get = self.rate_limiter.__call__(self._get)
+
+    async def close(self) -> None:
+        """Close the aiohttp session"""
+
+        if self.session is not None and not self.session.closed:
+            await self.session.close()
+
+    async def __aenter__(self) -> AioJikan:
+        return self
+
+    async def __aexit__(self, exc_type, exc, tb) -> None:
+        await self.close()
+
+    async def _get(self, endpoint: str, params: dict = None) -> dict:
+        """Make a GET request to the configured anime API
+
+        Args:
+            endpoint (str): Endpoint to request
+            params (dict, optional): Parameters to send with request. Defaults to None.
+
+        Returns:
+            dict: JSON response from the configured anime API
+        """
+
+        url = f"{self.base_url}/{endpoint}"
+        if self.session is None or self.session.closed:
+            self.session = aiohttp.ClientSession()
+
+        async with self.session.get(url, params=params) as response:
+            response.raise_for_status()
+            return await response.json()
+
+    async def get_anime(self, anime_id: int) -> Anime:
+        """Get anime information
+
+        Args:
+            anime_id (int): Anime ID
+
+        Returns:
+            Anime: Anime object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> anime = await aiojikan.get_anime(1)
+        """
+
+        endpoint = f"anime/{anime_id}"
+        response = await self._get(endpoint)
+
+        return Anime(**response["data"])
+
+    async def get_anime_full(self, anime_id: int) -> Anime:
+        """Get anime information with full details
+
+        Args:
+            anime_id (int): Anime ID
+
+        Returns:
+            Anime: Anime object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> anime = await aiojikan.get_anime_full(1)
+        """
+
+        endpoint = f"anime/{anime_id}/full"
+        response = await self._get(endpoint)
+
+        return Anime(**response["data"])
+
+    async def get_anime_characters(self, anime_id: int) -> AnimeCharacters:
+        """Get anime characters
+
+        Args:
+            anime_id (int): Anime ID
+
+        Returns:
+            AnimeCharacters: AnimeCharacters object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> characters = await aiojikan.get_anime_characters(1)
+        """
+
+        endpoint = f"anime/{anime_id}/characters"
+        response = await self._get(endpoint)
+
+        return AnimeCharacters(**response)
+
+    async def get_anime_staff(self, anime_id: int) -> AnimeStaff:
+        """Get anime staff
+
+        Args:
+            anime_id (int): Anime ID
+
+        Returns:
+            AnimeStaff: AnimeStaff object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> staff = await aiojikan.get_anime_staff(1)
+        """
+
+        endpoint = f"anime/{anime_id}/staff"
+        response = await self._get(endpoint)
+
+        return AnimeStaff(**response)
+
+    async def get_anime_episodes(self, anime_id: int) -> AnimeEpisodes:
+        """Get anime episodes
+
+        Args:
+            anime_id (int): Anime ID
+
+        Returns:
+            AnimeEpisodes: AnimeEpisodes object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> episodes = await aiojikan.get_anime_episodes(1)
+        """
+
+        endpoint = f"anime/{anime_id}/episodes"
+        response = await self._get(endpoint)
+
+        return AnimeEpisodes(**response)
+
+    async def get_anime_episode(self, anime_id: int, episode: int) -> Episode:
+        """Get anime episode
+
+        Args:
+            anime_id (int): Anime ID
+            episode (int): Episode number
+
+        Returns:
+            AnimeEpisodes: AnimeEpisodes object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> episode = await aiojikan.get_anime_episode(1, 1)
+        """
+
+        endpoint = f"anime/{anime_id}/episodes/{episode}"
+        response = await self._get(endpoint)
+
+        return Episode(**response["data"])
+
+    async def get_anime_news(self, anime_id: int, page: int = None) -> AnimeNews:
+        """Get anime news
+
+        Args:
+            anime_id (int): Anime ID
+            page (int, optional): Page number. Defaults to None.
+
+        Returns:
+            AnimeNews: AnimeNews object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> news = await aiojikan.get_anime_news(1)
+        """
+
+        params = {}
+        if page:
+            params["page"] = page
+
+        endpoint = f"anime/{anime_id}/news"
+        response = await self._get(endpoint, params=params)
+
+        return AnimeNews(**response)
+
+    async def search_anime(
+        self, search_type: str, query: str, page: int = 1
+    ) -> AnimeSearch:
+        """Search for anime
+
+        Args:
+            search_type (str): Type of search to perform (tv, movie, ova, special, ona, music)
+            query (str): Query to search for
+            page (int, optional): Page number. Defaults to 1.
+
+        Returns:
+            AnimeSearch: AnimeSearch object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> result = await aiojikan.search_anime("tv", "naruto")
+        """
+
+        endpoint = f"anime"
+        params = {"q": query, "page": page, "type": search_type}
+        response = await self._get(endpoint, params)
+
+        return AnimeSearch(**response)
+
+    async def get_anime_forum(self, anime_id: int, filter: str = None) -> AnimeForum:
+        """Get anime forum
+
+        Args:
+            anime_id (int): Anime ID
+            filter (str, optional): Filter to apply. ("all", "episode", "other"). Defaults to None.
+
+        Returns:
+            AnimeForum: AnimeForum object
+
+        Examples:
+            >>> aiojikan = AioJikan()
+            >>> forum = await aiojikan.get_anime_forum(1)
+        """
+
+        params = {}
+        if filter:
+            params["filter"] = filter
+
+        endpoint = f"anime/{anime_id}/forum"
+        response = await self._get(endpoint, params=params)
+
+        return AnimeForum(**response)