initial commit

This commit is contained in:
2025-04-24 18:40:03 +02:00
commit 88cc93fd50
19 changed files with 529 additions and 0 deletions

27
.bumpversion.toml Normal file
View File

@@ -0,0 +1,27 @@
[tool.bumpversion]
current_version = "0.1.3"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
serialize = ["{major}.{minor}.{patch}"]
search = "{current_version}"
replace = "{new_version}"
regex = false
ignore_missing_version = false
ignore_missing_files = false
tag = true
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
allow_dirty = false
commit = true
message = "Bump version: {current_version} → {new_version}"
moveable_tags = []
commit_args = ""
setup_hooks = []
pre_commit_hooks = []
post_commit_hooks = []
[[tool.bumpversion.files]]
filename = "pyproject.toml"
[[tool.bumpversion.files]]
filename = "src/anilistapi/__init__.py"

234
.gitignore vendored Normal file
View File

@@ -0,0 +1,234 @@
# ---> Python
# 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
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__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 maintained 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/
# ---> Qt
# C++ objects and libs
*.slo
*.lo
*.o
*.a
*.la
*.lai
*.so
*.so.*
*.dll
*.dylib
# Qt-es
object_script.*.Release
object_script.*.Debug
*_plugin_import.cpp
/.qmake.cache
/.qmake.stash
*.pro.user
*.pro.user.*
*.qbs.user
*.qbs.user.*
*.moc
moc_*.cpp
moc_*.h
qrc_*.cpp
ui_*.h
*.qmlc
*.jsc
Makefile*
*build-*
*.qm
*.prl
# Qt unit tests
target_wrapper.*
# QtCreator
*.autosave
# QtCreator Qml
*.qmlproject.user
*.qmlproject.user.*
# QtCreator CMake
CMakeLists.txt.user*
# QtCreator 4.8< compilation database
compile_commands.json
# QtCreator local machine specific files for imported projects
*creator.user*
*_qmlcache.qrc
.history
depend
output/output/LOGtoJSON.exe
.pytest_cache
output
docs/
config.yaml
**/tempCodeRunnerFile.py
uv.lock
.history
.venv
venv
*.log

7
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,7 @@
{
"python.testing.pytestArgs": [
"tests"
],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
}

21
LICENSE Normal file
View File

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

0
README.md Normal file
View File

21
pyproject.toml Normal file
View File

@@ -0,0 +1,21 @@
[project]
name = "anilistapi"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
authors = [{ name = "WorldTeacher", email = "coding_contact@pm.me" }]
requires-python = ">=3.13"
dependencies = ["limit>=0.2.3", "requests>=2.32.3"]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[dependency-groups]
test = ["pytest>=8.3.4"]
[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "--cov=src --cov-report=term-missing"
[tool.coverage.run]
omit = ["main.py", "test.py", "tests/*", "__init__.py"]

View File

@@ -0,0 +1,3 @@
__version__ = "0.1.3"
__contact__ = "coding_contact@pm.me"
from .api import AnilistAPI

44
src/anilistapi/api.py Normal file
View File

@@ -0,0 +1,44 @@
import requests
from .schemas.manga import Manga
from .queries.manga import MANGA_QUERY, MANGA_ID_QUERY
from limit import limit
from anilistapi import __version__, __contact__
import os
REQUEST_LIMIT = 1
REQUEST_PERIOD = 2
class AnilistAPI:
def __init__(self):
# add system information to the user agent
self.userAgent = f"AnilistAPI/{__version__} {os.uname().sysname}/{os.uname().machine} Python/{os.uname().release} - {__contact__}"
pass
@limit(REQUEST_LIMIT, REQUEST_PERIOD)
def request(self, query: str, variables: dict) -> dict:
url = "https://graphql.anilist.co"
response = requests.post(url, json={"query": query, "variables": variables})
if response.status_code != 200:
return {}
# raise Exception(f"Error: {response}, response: {response.json()}, query: {query}, variables: {variables}")
return response.json()
def search_manga(self, search: str) -> list[Manga]:
variables = {"search": search}
response = self.request(MANGA_QUERY, variables)
# check if reponse has data Page and media
if not response.get("data", {}).get("Page", {}).get("media"):
return []
res = []
for manga in response["data"]["Page"]["media"]:
res.append(Manga(**manga))
return res
def get_manga(self, id: int) -> Manga:
assert isinstance(id, int), "id must be an integer"
variables = {"id": id}
response = self.request(MANGA_ID_QUERY, variables)
if not response.get("data", {}).get("Media"):
return None
return Manga(**response["data"]["Media"])

0
src/anilistapi/py.typed Normal file
View File

View File

View File

@@ -0,0 +1,54 @@
MANGA_QUERY = """
query media($search: String) {
Page {
pageInfo {
hasNextPage
}
media(type: MANGA, search: $search) {
id
title {
romaji
english
native
}
synonyms
}
}
}
"""
MANGA_ID_QUERY = """
query media($id: Int) { # Define which variables will be used in the query (id)
Media (type: MANGA, id:$id) { # Insert our variables into the query arguments (id)
id
title {
romaji
english
native
}
synonyms
format
type
status(version:2)
genres
tags{
name
isAdult
}
description
coverImage {
large
}
isAdult
chapters
volumes
externalLinks {
site
url
type
}
countryOfOrigin
}
}
"""

View File

View File

@@ -0,0 +1,8 @@
from dataclasses import dataclass
@dataclass
class ExternalLinks:
url: str = None
type: str = None
site: str = None

View File

@@ -0,0 +1,46 @@
from dataclasses import dataclass
from .title import Title
from .externalLinks import ExternalLinks
from .tag import Tag
from typing import Union, Any
@dataclass
class Manga:
id: int = None
title: Title = None
status: str = None
synonyms: list = None
type: str = None
format: str = None
genres: list[str] = None
tags: list | list[Tag] = None
description: str = None
coverImage: dict = None
isAdult: bool = False
chapters: int = None
volumes: int = None
externalLinks: list | list[ExternalLinks] = None
countryOfOrigin: str = None
def __post_init__(self):
self.title = Title(**self.title) if self.title else None
self.externalLinks = (
[ExternalLinks(**link) for link in self.externalLinks]
if self.externalLinks
else None
)
self.tags = [Tag(**tag) for tag in self.tags] if self.tags else None
self.description = self.description if self.description else None
@property
def url(self):
return self.externalLinks[0].url
@property
def isManga(self):
return self.format == "MANGA"
@property
def isLightNovel(self):
return self.format == "NOVEL"

View File

@@ -0,0 +1,20 @@
from dataclasses import dataclass
@dataclass
class Tag:
userID: int = None
rank: int = None
name: str = None
isMediaSpoiler: bool = False
isGeneralSpoiler: bool = False
isAdult: bool = False
id: int = None
description: str = None
category: str = None
def __repr__(self):
return self.name
def __str__(self):
return self.name

View File

@@ -0,0 +1,26 @@
from dataclasses import dataclass
@dataclass
class Title:
romaji: str = None
english: str = None
native: str = None
def __repr__(self):
return self.english if self.english else self.native
def __str__(self):
return self.english if self.english else self.native
@property
def alternateTitles(self):
return [
{"romaji": self.romaji},
{"english": self.english},
{"native": self.native},
]
@property
def titles(self):
return

0
tests/__init__.py Normal file
View File

8
tests/conftest.py Normal file
View File

@@ -0,0 +1,8 @@
import pytest
from anilistapi import AnilistAPI
@pytest.fixture
def api():
return AnilistAPI()

10
tests/test_manga.py Normal file
View File

@@ -0,0 +1,10 @@
import pytest
from anilistapi.schemas.manga import Manga
from anilistapi.api import AnilistAPI
def test_search_manga():
api = AnilistAPI()
manga = api.search_manga("Berserk")
assert manga[0].title.english == "Berserk"