# nyaasi-scraper
nyaasi-scraper is an asynchronous Python library for scraping [nyaa.si](https://nyaa.si) and [sukebei.nyaa.si](https://sukebei.nyaa.si).
# Installation
Installing through pip.
```bash
pip install nyaasi-scraper
```
# Usage
## Initializing Client with Site
By default, the site is nyaa.si (work-safe site).
```py
from nyaascraper import NyaaClient, SITE
# Work-safe site.
client = NyaaClient(SITE.FUN)
# Non-work-safe site.
client = NyaaClient(SITE.FAP)
```
## Changing Site
You can change the site of the client dynamically.
```py
from nyaascraper import SITE
client.site = SITE.FUN
```
## Searching Torrents
### Search with Query
```py
from nyaascraper.models import SearchResult
result: SearchResult = await client.search(query="your query...")
print(result)
# Iterate over torrents.
for torrent in result.torrents:
print(torrent)
```
### Search by Username
```py
result = await client.search(username="Erai-raws")
print(result)
```
### Search with Filter
```py
from nyaascraper import Filter
# No Filter. (Default)
result = await client.search(filter_=Filter.NO_FILTER)
print(result)
# Trusted only.
result = await client.search(filter_=Filter.TRUSTED_ONLY)
print(result)
# No Remakes.
result = await client.search(filter_=Filter.NO_REMAKES)
print(result)
```
### Search with Category
```py
from nyaascraper.enums import FunCategory, FapCategory
# Work-safe category.
result = await client.search(category=FunCategory.ANIME)
print(result)
# Work-safe subcategory search.
result = await client.search(category=FunCategory.ANIME__ENGLISH_TRANSLATED)
print(result)
# Non-work-safe category.
result = await client.search(category=FapCategory.ART)
print(result)
# Non-work-safe subcategory search.
result = await client.search(category=FunCategory.ART__MANGA)
print(result)
```
### Search with Sorting
```py
from nyaascraper.enums import SortBy, SortOrder
# Sort by comments.
result = await client.search(sort_by=SortBy.COMMENTS)
print(result)
# Sort by size.
result = await client.search(sort_by=SortBy.SIZE)
print(result)
# Sort by date.
result = await client.search(sort_by=SortBy.DATE)
print(result)
# Sort by seeders.
result = await client.search(sort_by=SortBy.SEEDERS)
print(result)
# Sort by leechers.
result = await client.search(sort_by=SortBy.LEECHERS)
print(result)
# Sort by downloads.
result = await client.search(sort_by=SortBy.DOWNLOADS)
print(result)
# Sort order: Ascending.
result = await client.search(sort_order=SortOrder.ASCENDING)
print(result)
# Sort order: Descending.
result = await client.search(sort_order=SortOrder.DESCENDING)
print(result)
```
### Search by Page
```py
result = await client.search(page=2)
print(result)
```
## Getting Torrent Information
```py
from nyaascraper.models import TorrentInfo
result = await client.search()
# Select View-ID of first torrent from the search result.
view_id: int = result.torrents[0].view_id
torrent_info: TorrentInfo = await client.get_torrent_info(view_id)
print(torrent_info)
```
## RSS Feed
### Initializing Client with Site
By default, the site is nyaa.si (work-safe site).
```py
from nyaascraper import NyaaRSSClient, SITE
# Work-safe site.
client = NyaaRSSClient(SITE.FUN)
# Non-work-safe site.
client = NyaaRSSClient(SITE.FAP)
```
### Changing Site
You can change the site of the client dynamically.
```py
from nyaascraper import SITE
client.site = SITE.FUN
```
### Get RSS feed
```py
from nyaascraper.enums import Filter, FunCategory
from nyaascraper.models import NyaaRSSFeed
# All parameters passed are optional.
feed: NyaaRSSFeed = await client.get_feed(
query="your query...",
username="Erai-raws",
filter_=Filter.TRUSTED_ONLY,
category=FunCategory.ANIME__ENGLISH_TRANSLATED
)
print("Title:", feed.title)
print("Description:", feed.description)
# Iterate over torrents.
for torrent in feed.torrents:
print(torrent)
```
# License
Licensed under MIT License. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/zrekryu/nyaasi-scraper",
"name": "nyaasi-scraper",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "nyaa, sukebei, torrent, asynchronous, web scraping",
"author": "ZrekryuDev",
"author_email": "zrekryudev@gmail.com",
"download_url": null,
"platform": null,
"description": "# nyaasi-scraper\n\nnyaasi-scraper is an asynchronous Python library for scraping [nyaa.si](https://nyaa.si) and [sukebei.nyaa.si](https://sukebei.nyaa.si).\n\n# Installation\n\nInstalling through pip.\n\n```bash\npip install nyaasi-scraper\n```\n\n# Usage\n\n## Initializing Client with Site\n\nBy default, the site is nyaa.si (work-safe site).\n\n```py\nfrom nyaascraper import NyaaClient, SITE\n\n# Work-safe site.\nclient = NyaaClient(SITE.FUN)\n\n# Non-work-safe site.\nclient = NyaaClient(SITE.FAP)\n```\n\n## Changing Site\n\nYou can change the site of the client dynamically.\n\n```py\nfrom nyaascraper import SITE\n\nclient.site = SITE.FUN\n```\n\n## Searching Torrents\n\n### Search with Query\n\n```py\nfrom nyaascraper.models import SearchResult\n\nresult: SearchResult = await client.search(query=\"your query...\")\nprint(result)\n\n# Iterate over torrents.\nfor torrent in result.torrents:\n print(torrent)\n```\n\n### Search by Username\n\n```py\nresult = await client.search(username=\"Erai-raws\")\nprint(result)\n```\n\n### Search with Filter\n\n```py\nfrom nyaascraper import Filter\n\n# No Filter. (Default)\nresult = await client.search(filter_=Filter.NO_FILTER)\nprint(result)\n\n# Trusted only.\nresult = await client.search(filter_=Filter.TRUSTED_ONLY)\nprint(result)\n\n# No Remakes.\nresult = await client.search(filter_=Filter.NO_REMAKES)\nprint(result)\n```\n\n### Search with Category\n\n```py\nfrom nyaascraper.enums import FunCategory, FapCategory\n\n# Work-safe category.\nresult = await client.search(category=FunCategory.ANIME)\nprint(result)\n\n# Work-safe subcategory search.\nresult = await client.search(category=FunCategory.ANIME__ENGLISH_TRANSLATED)\nprint(result)\n\n# Non-work-safe category.\nresult = await client.search(category=FapCategory.ART)\nprint(result)\n\n# Non-work-safe subcategory search.\nresult = await client.search(category=FunCategory.ART__MANGA)\nprint(result)\n```\n\n### Search with Sorting\n\n```py\nfrom nyaascraper.enums import SortBy, SortOrder\n\n# Sort by comments.\nresult = await client.search(sort_by=SortBy.COMMENTS)\nprint(result)\n\n# Sort by size.\nresult = await client.search(sort_by=SortBy.SIZE)\nprint(result)\n\n# Sort by date.\nresult = await client.search(sort_by=SortBy.DATE)\nprint(result)\n\n# Sort by seeders.\nresult = await client.search(sort_by=SortBy.SEEDERS)\nprint(result)\n\n# Sort by leechers.\nresult = await client.search(sort_by=SortBy.LEECHERS)\nprint(result)\n\n# Sort by downloads.\nresult = await client.search(sort_by=SortBy.DOWNLOADS)\nprint(result)\n\n# Sort order: Ascending.\nresult = await client.search(sort_order=SortOrder.ASCENDING)\nprint(result)\n\n# Sort order: Descending.\nresult = await client.search(sort_order=SortOrder.DESCENDING)\nprint(result)\n```\n\n### Search by Page\n\n```py\nresult = await client.search(page=2)\nprint(result)\n```\n\n## Getting Torrent Information\n\n```py\nfrom nyaascraper.models import TorrentInfo\n\nresult = await client.search()\n\n# Select View-ID of first torrent from the search result.\nview_id: int = result.torrents[0].view_id\n\ntorrent_info: TorrentInfo = await client.get_torrent_info(view_id)\nprint(torrent_info)\n```\n\n## RSS Feed\n\n### Initializing Client with Site\n\nBy default, the site is nyaa.si (work-safe site).\n\n```py\nfrom nyaascraper import NyaaRSSClient, SITE\n\n# Work-safe site.\nclient = NyaaRSSClient(SITE.FUN)\n\n# Non-work-safe site.\nclient = NyaaRSSClient(SITE.FAP)\n```\n\n### Changing Site\n\nYou can change the site of the client dynamically.\n\n```py\nfrom nyaascraper import SITE\n\nclient.site = SITE.FUN\n```\n\n### Get RSS feed\n\n```py\nfrom nyaascraper.enums import Filter, FunCategory\nfrom nyaascraper.models import NyaaRSSFeed\n\n# All parameters passed are optional.\nfeed: NyaaRSSFeed = await client.get_feed(\n query=\"your query...\",\n username=\"Erai-raws\",\n filter_=Filter.TRUSTED_ONLY,\n category=FunCategory.ANIME__ENGLISH_TRANSLATED\n )\n\nprint(\"Title:\", feed.title)\nprint(\"Description:\", feed.description)\n\n# Iterate over torrents.\nfor torrent in feed.torrents:\n print(torrent)\n```\n\n# License\n\nLicensed under MIT License. See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "nyaasi-scraper is an asynchronous Python library for scraping nyaa.si and sukebei.nyaa.si.",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/zrekryu/nyaasi-scraper"
},
"split_keywords": [
"nyaa",
" sukebei",
" torrent",
" asynchronous",
" web scraping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02cf9d5004d42ae6137bf9641d4dc25b53c160cff4bc9003d83421036133ed97",
"md5": "32bdf00a14f0d84cb57e4ab4f7532fc6",
"sha256": "7ad69331f62b99dd710d7a2639d082bf882289646090d8a0e12d30bcde1e8dee"
},
"downloads": -1,
"filename": "nyaasi_scraper-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32bdf00a14f0d84cb57e4ab4f7532fc6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12854,
"upload_time": "2024-06-29T17:04:30",
"upload_time_iso_8601": "2024-06-29T17:04:30.131813Z",
"url": "https://files.pythonhosted.org/packages/02/cf/9d5004d42ae6137bf9641d4dc25b53c160cff4bc9003d83421036133ed97/nyaasi_scraper-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-29 17:04:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zrekryu",
"github_project": "nyaasi-scraper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "nyaasi-scraper"
}
JSON
