<div align="center">
# AnimeScraper
**AnimeScraper** is an Open Source Python library designed for scraping and parsing anime-related data from MyAnimeList. With support for asynchronous requests, it allows you to fetch detailed information about anime, characters, and more efficiently.
</div>
## 🚀 Features
- Fetch detailed anime and character details
- Asynchronous Fast data retrieval
- Caching
- Easy-to-use API
- Fully typed and documented
- Supports Synchronous as well
- Comes with a Cli too
- FastAPI Server with Caching config
## 🛠️ Installation
You can install AnimeScraper using pip:
```bash
pip install animescraper
```
## Cli Tool
You can use AnimeScraper in your command line too. Type `animescraper` for Usage. Available commands `search-anime`, `get-anime`, `search-character` etc. look at the Documentation for more information.
**Example:**
<div align="center">
</div>
## 📖 Quick Start
### Synchronous
This library supports both Synchronous and Asynchronous.
**Searching and Fetching Anime**
```python
from AnimeScraper import SyncKunYu
scraper = SyncKunYu()
anime = scraper.search_anime("Chuunibyo demo koi ga shita")
print(anime.title)
print(anime.stats.rank)
```
**Searching and fetching Character**
```python
from AnimeScraper import SyncKunYu
scraper = SyncKunYu()
character = scraper.search_character("Takanashi Rikka")
print(character.about)
print(character.description)
```
### Asynchronous
**Searching Anime**
```python
import asyncio
from AnimeScraper import KunYu
async def main():
scraper = KunYu()
anime = await scraper.search_anime("violet evergarden") # Violet Evergarden
print(anime.title)
print(anime.synopsis)
print(anime.characters[0].name)
asyncio.run(main())
```
**Searching Character**
```python
import asyncio
from AnimeScraper import KunYu
async def main():
scraper = KunYu()
# Search and Fetch Character detials by name
character = await scraper.search_character("Killua Zoldyck")
print(character.name)
print(character.url)
asyncio.run(main())
```
**Fetching Anime details**
```python
import asyncio
from AnimeScraper import KunYu
async def main():
# Use async Context manager to fetch multiple anime with same session
async with KunYu() as scraper:
anime = await scraper.get_anime("32281") # Fullmetal Alchemist: Brotherhood
print(anime.stats.score)
print(anime.characters[0].name)
asyncio.run(main())
```
## 📖 Documentation
Detailed documentation is available. [Check out the Documentation](https://animescraper.readthedocs.io/en/latest/)
## 🌟 Key Components
- `KunYu`: Main interface for scraping anime and character data
- `Anime`: Detailed anime information model
- `Character`: Comprehensive character details model
- Asynchronous scraping with `aiohttp`
## 🔧 Requirements
- Python 3.10+
- aiohttp
- httpx
- pydantic
- uvicorn
## 📦 Project Structure
```
AnimeScraper/
│
├── AnimeScraper/
│ ├── Scraper.py # Main scraping interface
│ ├── _model.py # Data models
│ ├── malscraper.py # HTTP connection handler
│ └── _parse_anime_data.py # HTML parsing utilities
│
├── docs/ # Sphinx documentation
├── tests/ # Unit tests
└── pyproject.toml # Project configuration
```
## 📄 License
Distributed under the GPL-V3.0 License. See [LICENSE](./LICENSE.md) for more information.
## 📞 Contact
[Facebook](https://facebook.com/KiyotakaO.O)
[Telegram](t.me/togayuuta)
Raw data
{
"_id": null,
"home_page": "https://github.com/togashigreat/AnimeScraper",
"name": "AnimeScraper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "anime, scraper, myanimelist, anime cli, manga, anime library, api, python anime",
"author": "Muhammad MuQiT",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/b3/bf71095e9c7015aac803d2410b5915932148be909530d790ff30b0358175/animescraper-1.1.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# AnimeScraper\n\n\n\n\n\n\n\n**AnimeScraper** is an Open Source Python library designed for scraping and parsing anime-related data from MyAnimeList. With support for asynchronous requests, it allows you to fetch detailed information about anime, characters, and more efficiently.\n\n</div>\n\n\n## \ud83d\ude80 Features\n\n- Fetch detailed anime and character details\n- Asynchronous Fast data retrieval\n- Caching \n- Easy-to-use API\n- Fully typed and documented\n- Supports Synchronous as well\n- Comes with a Cli too\n- FastAPI Server with Caching config \n\n\n## \ud83d\udee0\ufe0f Installation\n\nYou can install AnimeScraper using pip:\n\n```bash\npip install animescraper\n```\n\n## Cli Tool\nYou can use AnimeScraper in your command line too. Type `animescraper` for Usage. Available commands `search-anime`, `get-anime`, `search-character` etc. look at the Documentation for more information.\n\n**Example:**\n\n<div align=\"center\">\n\n\n\n\n</div>\n\n\n\n## \ud83d\udcd6 Quick Start\n\n### Synchronous\n\nThis library supports both Synchronous and Asynchronous.\n\n**Searching and Fetching Anime**\n\n```python\nfrom AnimeScraper import SyncKunYu\n\nscraper = SyncKunYu()\nanime = scraper.search_anime(\"Chuunibyo demo koi ga shita\")\n\nprint(anime.title)\nprint(anime.stats.rank)\n\n```\n**Searching and fetching Character**\n\n```python\nfrom AnimeScraper import SyncKunYu\n\nscraper = SyncKunYu()\ncharacter = scraper.search_character(\"Takanashi Rikka\")\n\nprint(character.about)\nprint(character.description)\n```\n\n\n### Asynchronous\n\n\n**Searching Anime** \n\n```python\nimport asyncio\nfrom AnimeScraper import KunYu\n\nasync def main():\n scraper = KunYu()\n anime = await scraper.search_anime(\"violet evergarden\") # Violet Evergarden\n print(anime.title)\n print(anime.synopsis)\n print(anime.characters[0].name)\n\nasyncio.run(main())\n```\n\n\n**Searching Character** \n\n```python\nimport asyncio\nfrom AnimeScraper import KunYu\n\nasync def main():\n scraper = KunYu()\n # Search and Fetch Character detials by name\n character = await scraper.search_character(\"Killua Zoldyck\")\n print(character.name)\n print(character.url)\n\nasyncio.run(main())\n```\n\n\n**Fetching Anime details**\n\n```python\nimport asyncio\nfrom AnimeScraper import KunYu\n\nasync def main():\n # Use async Context manager to fetch multiple anime with same session\n async with KunYu() as scraper:\n anime = await scraper.get_anime(\"32281\") # Fullmetal Alchemist: Brotherhood\n print(anime.stats.score)\n print(anime.characters[0].name)\n\nasyncio.run(main())\n\n```\n\n## \ud83d\udcd6 Documentation\n\nDetailed documentation is available. [Check out the Documentation](https://animescraper.readthedocs.io/en/latest/)\n\n## \ud83c\udf1f Key Components\n\n- `KunYu`: Main interface for scraping anime and character data\n- `Anime`: Detailed anime information model\n- `Character`: Comprehensive character details model\n- Asynchronous scraping with `aiohttp`\n\n\n## \ud83d\udd27 Requirements\n\n- Python 3.10+\n- aiohttp\n- httpx\n- pydantic\n- uvicorn \n\n## \ud83d\udce6 Project Structure\n\n```\nAnimeScraper/\n\u2502\n\u251c\u2500\u2500 AnimeScraper/\n\u2502 \u251c\u2500\u2500 Scraper.py # Main scraping interface\n\u2502 \u251c\u2500\u2500 _model.py # Data models\n\u2502 \u251c\u2500\u2500 malscraper.py # HTTP connection handler\n\u2502 \u2514\u2500\u2500 _parse_anime_data.py # HTML parsing utilities\n\u2502\n\u251c\u2500\u2500 docs/ # Sphinx documentation\n\u251c\u2500\u2500 tests/ # Unit tests\n\u2514\u2500\u2500 pyproject.toml # Project configuration\n```\n## \ud83d\udcc4 License\n\nDistributed under the GPL-V3.0 License. See [LICENSE](./LICENSE.md) for more information.\n\n## \ud83d\udcde Contact\n\n[Facebook](https://facebook.com/KiyotakaO.O)\n[Telegram](t.me/togayuuta)\n\n",
"bugtrack_url": null,
"license": "GPL-V3.0",
"summary": "A Simple library to get Anime and Character information. It scrapes all information from Myanimelist website.",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/togashigreat/AnimeScraper",
"Repository": "https://github.com/togashigreat/AnimeScraper"
},
"split_keywords": [
"anime",
" scraper",
" myanimelist",
" anime cli",
" manga",
" anime library",
" api",
" python anime"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d29f568413ff99e51051f4b20bd3bc672a5d8328bbc0a8b0bb113d1e0dcc732d",
"md5": "ac3e3fa37d4431ceb14fffc6cfc56d27",
"sha256": "e7a4499588641467f2323ebdb1b36ac906c74b82ba304acae20aee3d3750962e"
},
"downloads": -1,
"filename": "animescraper-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac3e3fa37d4431ceb14fffc6cfc56d27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 34760,
"upload_time": "2024-12-18T06:37:09",
"upload_time_iso_8601": "2024-12-18T06:37:09.698168Z",
"url": "https://files.pythonhosted.org/packages/d2/9f/568413ff99e51051f4b20bd3bc672a5d8328bbc0a8b0bb113d1e0dcc732d/animescraper-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72b3bf71095e9c7015aac803d2410b5915932148be909530d790ff30b0358175",
"md5": "6ac08660fd60af723212a57be230cdc8",
"sha256": "0764167300a1082a25ea09cbe462ecce95ab67086a8a0bdf0fded36e68bd3284"
},
"downloads": -1,
"filename": "animescraper-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "6ac08660fd60af723212a57be230cdc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 28847,
"upload_time": "2024-12-18T06:37:12",
"upload_time_iso_8601": "2024-12-18T06:37:12.419906Z",
"url": "https://files.pythonhosted.org/packages/72/b3/bf71095e9c7015aac803d2410b5915932148be909530d790ff30b0358175/animescraper-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 06:37:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "togashigreat",
"github_project": "AnimeScraper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "fastapi",
"specs": []
},
{
"name": "aiolimiter",
"specs": []
},
{
"name": "aiosqlite",
"specs": []
},
{
"name": "aiohttp",
"specs": []
},
{
"name": "httpx",
"specs": []
},
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "rapidfuzz",
"specs": []
},
{
"name": "uvicorn",
"specs": []
}
],
"lcname": "animescraper"
}
JSON
