Anime extractor api implementation
Project description
# anicli-api
[](https://github.com/vypivshiy/anicli-api/actions/workflows/ci.yml)
[](https://anicli-api.readthedocs.io/en/latest/?badge=latest)
Программный интерфейс парсера аниме с различных источников.
Присутствует поддержка sync и async методов с помощью `httpx` библиотеки, для получения информации и прямых ссылок
на видео.
# install
`pip install anicli-api`
# Overview
Модуль экстрактора имеют следующую структуру пошагового получения объекта:
```shell
# Extractor works schema:
[Extractor]
| search(<query>)/ongoing() -> List[SearchResult | Ongoing]
V
[SearchResult | Ongoing]
| get_anime() -> AnimeInfo
V
[AnimeInfo]
| get_episodes() -> List[Episode]
V
[Episode]
| get_videos() -> List[Video]
V
[Video]
| get_source() -> MetaVideo or Str
V
MetaVideo(type, quality, url, extra_headers) or url
```
# Quickstart example
Смотрите примеры [examples](examples) и [документации](https://anicli-api.readthedocs.io/en/latest/index.html)!
# Примечания
Проект разработан преимущественно на личное, некоммерческое использование на стороне клиента.
Автор проекта не несет ответственности за поломки, убытки в высоко нагруженных проектах и решение
предоставляется "Как есть" в соответствии с [MIT](LIENSE) лицензией.
Если вы всё же решили этот проект использовать в **production** условиях,
то выстаивайте архитектуру своих проектов **на предварительный сбор информации**
(например, полученные данные сохранять в базу данных и оттуда позже получать),
так как большинство парсеров работает в обход официальных методов и применяются такие библиотеки как re, bs4.
Следовательно, могут быть проблемы от производительности, до получения ошибок по типу 403 (срабатывание ddos защиты) или
502 (доступа к сайту запрещён).
**Этот проект не включает инструменты кеширования и сохранения всех полученных данных, только эндпоинты
с готовой реализацией архитектуры парсеров**
# DEV
[DEV](DEV.MD)
# Contributing
[CONTRIBUTING](CONTRIBUTING.MD)
# TODO
* ~~CI CD автотестов~~
~~* Поправить sphinx документацию~~
* Получение видео по ссылке (like yt-dlp)
* расширенный поиск (по жанрам, годам, etc)
* улучшение документации
* Продумать стандартизацию атрибутов в экстракторах (если такое реально?)
* ~~asyncio tests~~
* ~~coverage~~
* ~~добавить примеры~~
* ~~Написать документацию для high level применения пока на уровне example примеров~~
* ~~Написать документацию для low level разработки экстракторов~~
* ~~Дописать asyncio методы для animego~~
* ~~Портировать anilibria, animevost, animania экстракторы из старого проекта~~
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
anicli_api-0.3.7.tar.gz
(30.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file anicli_api-0.3.7.tar.gz.
File metadata
- Download URL: anicli_api-0.3.7.tar.gz
- Upload date:
- Size: 30.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.2 CPython/3.10.9 Linux/6.1.7-zen1-1-zen
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e3494a71932e32a926bb86f715bf5e8ca3ae1aecee7dee04877305d5840e85f
|
|
| MD5 |
84da5e63f5aff7bf15f3508c8d832fad
|
|
| BLAKE2b-256 |
75bf30b4bf21ac7bd5e243ec1ddf5b818f4039748c5562a99f68412a66034c99
|
File details
Details for the file anicli_api-0.3.7-py3-none-any.whl.
File metadata
- Download URL: anicli_api-0.3.7-py3-none-any.whl
- Upload date:
- Size: 39.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.2 CPython/3.10.9 Linux/6.1.7-zen1-1-zen
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd9db0d453103b72bf64e5205202f57242abc2056d1ffa77e884bdc27991b88a
|
|
| MD5 |
fb19e118b43620745f61137853e68358
|
|
| BLAKE2b-256 |
dbba24055e94d2345d901c34481dd3015a15cb94fdb1a3dc5a4ae0adc9d86a84
|