| Name | anilist-helper JSON |
| Version |
1.7
JSON |
| download |
| home_page | None |
| Summary | A simple library to help you fetch data from AniList. |
| upload_time | 2024-04-14 09:15:15 |
| maintainer | Dominik Procházka |
| docs_url | None |
| author | Dominik Procházka |
| requires_python | >=3.8 |
| license | None |
| keywords |
python
anilist
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# anilist-helper
A simple library to help you fetch data from AniList
## Description
Welcome to my first python project!
This library is aimed at people who might be interested in automatizing their anime library.
## Getting Started
### Dependencies
* Python(tested on the latest ver.)
* An AniList account
* An AniList developer app
* Javascript enabled during the set-up process (for sending the access token back to Python)
### Installing
* Clone this repo
```
git clone https://github.com/ProchyGaming/anilist-helper /path/to/desired/folder
```
* Install it using pip
```
pip install anilist-helper
```
* Install it using pip locally
```
cd /path/to/desired/folder
pip install .
```
* If you want to make modifications to the library install it in the edit mode:
```
cd /path/to/desired/folder
pip install -e .
```
### Using the library
* To import the library into your code use:
```
import anilisthelper
```
* When importing this library for the first time, you will be taken through the setup process
### Setting up the AniList developer app
* When the setup process starts, you will be automatically taken to required pages. This process is really simple.
* When asked for the Client ID, you will be taken to the account developer page.
* If not logged in, log in first.
* Then create a new client
* Choose whatever name you fancy, and for the redirect URL use http://localhost:8888/auth
* After you save the client, copy the ID and paste it into the terminal
* After entering the ID you will be taken to an auth page, where you need to allow the app to access your account.
* Afterwards you will be taken to a redirect page that is momentarily hosted using gevent. (If you have any worries, please see the token_getter.html source code.)
* After that the library is successfully set-up and ready for use.
## Help
If you encounter any issues, feel free to open a new issue. If you have any new ideas or fixes, please open a pull request, they are more than welcome!
## Version History
* [1.07](https://github.com/Pr0chy/anilist-helper/releases/tag/v1.07)
* [check_status_in_cache(): init empty dict if None](https://github.com/Pr0chy/anilist-helper/commit/399852d6f175082acb658634f0402f99cdb1bf0c)
* [1.06](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.06)
* [get_id(): Make sure we actually return None](https://github.com/ProchyGaming/anilist-helper/commit/0aa230077ab7a3733508f5473a1f7e4d35096989)
* [anilist_helper: Create dir for config](https://github.com/ProchyGaming/anilist-helper/commit/db3940710e7a6866d97293d7067f26aab60f09f5)
* [check_status_in_cache(): generate upcoming ep if not known](https://github.com/ProchyGaming/anilist-helper/commit/3b3ef0a269866eb11938cb5fe23191aea57804bd)
* [anilist_helper: drop unnecessary imports](https://github.com/ProchyGaming/anilist-helper/commit/f651a08cf50e1c82ef9d3ce94c1499f0e89fb65c)
* [1.05](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.05)
* [get_all_anime_for_user(): Allow list as status](https://github.com/ProchyGaming/anilist-helper/commit/ae0906ae17940de5511b044abe4de957ef28a2b9)
* [anilist_helper(): Add support for external api key](https://github.com/ProchyGaming/anilist-helper/commit/95ed72aa2f43a385ae8a40ed27b7c42fbe3b1c5d)
* [anilist_helper: add MAL_ID into collected data](https://github.com/ProchyGaming/anilist-helper/commit/3c05821fa6ccfb3411ab3c4287ce47255da87fde)
* [anilist_helper: Rewrite](https://github.com/ProchyGaming/anilist-helper/commit/d19059c2ef805d5d3cff318afd0bcc119608a8b6)
* [anilist_helper: Add is_sus flag](https://github.com/ProchyGaming/anilist-helper/commit/5b6b2bfe14f09dbf3bb06d1a8f2dea80fa1e5f16)
* [1.042](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.042)
* [gh-actions: Add action to cache build dependencies](https://github.com/ProchyGaming/anilist-helper/commit/7e02445ec6f5acf0ef7e5fad8634e77c9301164a)
* [anilist_helper: Remove debug lines for cache](https://github.com/ProchyGaming/anilist-helper/commit/acc5b453d8324ef181c549df3bc550d5c46b0b26)
* [1.041](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.041)
* [anilist_helper: Fix more oversights](https://github.com/ProchyGaming/anilist-helper/commit/b0ea061c16c5c147faf651593dd412b5bb92d2bb)
* [1.04](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.04)
* [anilist_helper: Break down the setup process](https://github.com/ProchyGaming/anilist-helper/commit/8c3fe5900f4396186b3a7315bf38e73e236e784e)
* [Remove LICENCE file when using pip show](https://github.com/ProchyGaming/anilist-helper/commit/9b42002dab525a1893c1f31b415c504c8e34c04b)
* Didn't forget to update the README finally lul xd
* [1.03](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.03)
* [anilist_helper: Fix Type and Key errors](https://github.com/ProchyGaming/anilist-helper/commit/c8cd7323beea27f653c9e888a1acb47b70ced8b0)
* [1.02](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.02)
* [anilist_helper: Fix-up typos](https://github.com/ProchyGaming/anilist-helper/commit/af08dc7c2757156dc51c3e37374c623baf76c281)
* [anilisthelper: Drop monkey patching](https://github.com/ProchyGaming/anilist-helper/commit/80fce02c35a6343f8ab19c896e41be0c11931974)
* [anilisthelper: Cache at the info generational level](https://github.com/ProchyGaming/anilist-helper/commit/7076e876461238ca9c4ef7ecf12c0c2fa3da8ce4)
* [generate_anime_entry(): Set placeholder day to 28th](https://github.com/ProchyGaming/anilist-helper/commit/b1b499e79fffe11b3f0007458e337f5ccbefa787)
* [check_status_in_cache(): Force check data for releasing anime too](https://github.com/ProchyGaming/anilist-helper/commit/990900964995ff1fa30eb753dcdccbe0df5d7377)
* [anilist_helper: Add support for env variable](https://github.com/ProchyGaming/anilist-helper/commit/ac64f38b8563f199776d931e621af290637f476f)
* [anilist-helper: Add config_anilist() function](https://github.com/ProchyGaming/anilist-helper/commit/5d65e7ddee604379f70ab2e3291f3fe88607f8fc)
* [1.01](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.01)
* [Import only datetime, not the whole library](https://github.com/ProchyGaming/anilist-helper/commit/7c7d5674644a50e891cf9f69bb71546b7fbcbf5b)
* [Add a config_path variable](https://github.com/ProchyGaming/anilist-helper/commit/1d88e70891c785714bf355e3f526c59a7e9e21d1)
* [get_anime_info(): Return proper dict](https://github.com/ProchyGaming/anilist-helper/commit/4b93547684030ffea06b53e234ab41cde352d446)
* [get_anime_info(): Introduce a force update flag](https://github.com/ProchyGaming/anilist-helper/commit/348359239372b8a6d7e87034ec57c52b2b75d575)
* [Introduce a check_status_in_cache() function](https://github.com/ProchyGaming/anilist-helper/commit/e6a1eb54298dc4a5838d45d8ed2d3bcb4effdf65)
* [1.0](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.0)
* [Initial Release](https://github.com/ProchyGaming/anilist-helper/commit/5c838f646c66de83365f6a0e897d317e89d67e4f)
## Acknowledgments
Huge thanks to AniList team for their great page and database:
* [AniList](https://anilist.co/home)
* [AniList GraphQL](https://anilist.co/graphiql)
Raw data
{
"_id": null,
"home_page": null,
"name": "anilist-helper",
"maintainer": "Dominik Proch\u00e1zka",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, anilist",
"author": "Dominik Proch\u00e1zka",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/67/7dd1cb16f8b644fe67dc60d51cef511ce70d4b0139f6d47fc1c4fa0d3cc3/anilist_helper-1.7.tar.gz",
"platform": null,
"description": "# anilist-helper\n\nA simple library to help you fetch data from AniList\n\n## Description\n\nWelcome to my first python project!\nThis library is aimed at people who might be interested in automatizing their anime library.\n\n## Getting Started\n\n### Dependencies\n\n* Python(tested on the latest ver.)\n* An AniList account\n* An AniList developer app\n* Javascript enabled during the set-up process (for sending the access token back to Python)\n\n### Installing\n\n* Clone this repo\n```\ngit clone https://github.com/ProchyGaming/anilist-helper /path/to/desired/folder\n```\n* Install it using pip\n```\npip install anilist-helper\n```\n* Install it using pip locally\n```\ncd /path/to/desired/folder\npip install .\n```\n* If you want to make modifications to the library install it in the edit mode:\n```\ncd /path/to/desired/folder\npip install -e .\n```\n\n### Using the library\n\n* To import the library into your code use:\n```\nimport anilisthelper\n```\n* When importing this library for the first time, you will be taken through the setup process\n\n### Setting up the AniList developer app\n\n* When the setup process starts, you will be automatically taken to required pages. This process is really simple.\n* When asked for the Client ID, you will be taken to the account developer page.\n* If not logged in, log in first.\n* Then create a new client\n* Choose whatever name you fancy, and for the redirect URL use http://localhost:8888/auth\n* After you save the client, copy the ID and paste it into the terminal\n* After entering the ID you will be taken to an auth page, where you need to allow the app to access your account.\n* Afterwards you will be taken to a redirect page that is momentarily hosted using gevent. (If you have any worries, please see the token_getter.html source code.)\n* After that the library is successfully set-up and ready for use.\n\n## Help\n\nIf you encounter any issues, feel free to open a new issue. If you have any new ideas or fixes, please open a pull request, they are more than welcome!\n\n## Version History\n* [1.07](https://github.com/Pr0chy/anilist-helper/releases/tag/v1.07)\n * [check_status_in_cache(): init empty dict if None](https://github.com/Pr0chy/anilist-helper/commit/399852d6f175082acb658634f0402f99cdb1bf0c)\n* [1.06](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.06)\n * [get_id(): Make sure we actually return None](https://github.com/ProchyGaming/anilist-helper/commit/0aa230077ab7a3733508f5473a1f7e4d35096989)\n * [anilist_helper: Create dir for config](https://github.com/ProchyGaming/anilist-helper/commit/db3940710e7a6866d97293d7067f26aab60f09f5)\n * [check_status_in_cache(): generate upcoming ep if not known](https://github.com/ProchyGaming/anilist-helper/commit/3b3ef0a269866eb11938cb5fe23191aea57804bd)\n * [anilist_helper: drop unnecessary imports](https://github.com/ProchyGaming/anilist-helper/commit/f651a08cf50e1c82ef9d3ce94c1499f0e89fb65c)\n* [1.05](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.05)\n * [get_all_anime_for_user(): Allow list as status](https://github.com/ProchyGaming/anilist-helper/commit/ae0906ae17940de5511b044abe4de957ef28a2b9)\n * [anilist_helper(): Add support for external api key](https://github.com/ProchyGaming/anilist-helper/commit/95ed72aa2f43a385ae8a40ed27b7c42fbe3b1c5d)\n * [anilist_helper: add MAL_ID into collected data](https://github.com/ProchyGaming/anilist-helper/commit/3c05821fa6ccfb3411ab3c4287ce47255da87fde)\n * [anilist_helper: Rewrite](https://github.com/ProchyGaming/anilist-helper/commit/d19059c2ef805d5d3cff318afd0bcc119608a8b6)\n * [anilist_helper: Add is_sus flag](https://github.com/ProchyGaming/anilist-helper/commit/5b6b2bfe14f09dbf3bb06d1a8f2dea80fa1e5f16)\n* [1.042](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.042)\n * [gh-actions: Add action to cache build dependencies](https://github.com/ProchyGaming/anilist-helper/commit/7e02445ec6f5acf0ef7e5fad8634e77c9301164a)\n * [anilist_helper: Remove debug lines for cache](https://github.com/ProchyGaming/anilist-helper/commit/acc5b453d8324ef181c549df3bc550d5c46b0b26)\n* [1.041](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.041)\n * [anilist_helper: Fix more oversights](https://github.com/ProchyGaming/anilist-helper/commit/b0ea061c16c5c147faf651593dd412b5bb92d2bb)\n* [1.04](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.04)\n * [anilist_helper: Break down the setup process](https://github.com/ProchyGaming/anilist-helper/commit/8c3fe5900f4396186b3a7315bf38e73e236e784e)\n * [Remove LICENCE file when using pip show](https://github.com/ProchyGaming/anilist-helper/commit/9b42002dab525a1893c1f31b415c504c8e34c04b)\n * Didn't forget to update the README finally lul xd\n* [1.03](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.03)\n * [anilist_helper: Fix Type and Key errors](https://github.com/ProchyGaming/anilist-helper/commit/c8cd7323beea27f653c9e888a1acb47b70ced8b0)\n* [1.02](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.02)\n * [anilist_helper: Fix-up typos](https://github.com/ProchyGaming/anilist-helper/commit/af08dc7c2757156dc51c3e37374c623baf76c281)\n * [anilisthelper: Drop monkey patching](https://github.com/ProchyGaming/anilist-helper/commit/80fce02c35a6343f8ab19c896e41be0c11931974)\n * [anilisthelper: Cache at the info generational level](https://github.com/ProchyGaming/anilist-helper/commit/7076e876461238ca9c4ef7ecf12c0c2fa3da8ce4)\n * [generate_anime_entry(): Set placeholder day to 28th](https://github.com/ProchyGaming/anilist-helper/commit/b1b499e79fffe11b3f0007458e337f5ccbefa787)\n * [check_status_in_cache(): Force check data for releasing anime too](https://github.com/ProchyGaming/anilist-helper/commit/990900964995ff1fa30eb753dcdccbe0df5d7377)\n * [anilist_helper: Add support for env variable](https://github.com/ProchyGaming/anilist-helper/commit/ac64f38b8563f199776d931e621af290637f476f)\n * [anilist-helper: Add config_anilist() function](https://github.com/ProchyGaming/anilist-helper/commit/5d65e7ddee604379f70ab2e3291f3fe88607f8fc)\n* [1.01](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.01)\n * [Import only datetime, not the whole library](https://github.com/ProchyGaming/anilist-helper/commit/7c7d5674644a50e891cf9f69bb71546b7fbcbf5b)\n * [Add a config_path variable](https://github.com/ProchyGaming/anilist-helper/commit/1d88e70891c785714bf355e3f526c59a7e9e21d1)\n * [get_anime_info(): Return proper dict](https://github.com/ProchyGaming/anilist-helper/commit/4b93547684030ffea06b53e234ab41cde352d446)\n * [get_anime_info(): Introduce a force update flag](https://github.com/ProchyGaming/anilist-helper/commit/348359239372b8a6d7e87034ec57c52b2b75d575)\n * [Introduce a check_status_in_cache() function](https://github.com/ProchyGaming/anilist-helper/commit/e6a1eb54298dc4a5838d45d8ed2d3bcb4effdf65)\n* [1.0](https://github.com/ProchyGaming/anilist-helper/releases/tag/v1.0)\n * [Initial Release](https://github.com/ProchyGaming/anilist-helper/commit/5c838f646c66de83365f6a0e897d317e89d67e4f)\n\n## Acknowledgments\n\nHuge thanks to AniList team for their great page and database:\n* [AniList](https://anilist.co/home)\n* [AniList GraphQL](https://anilist.co/graphiql)\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple library to help you fetch data from AniList.",
"version": "1.7",
"project_urls": {
"Documentation": "https://github.com/ProchyGaming/anilist-helper/wiki",
"Homepage": "https://github.com/ProchyGaming/anilist-helper",
"Source": "https://github.com/ProchyGaming/anilist-helper"
},
"split_keywords": [
"python",
" anilist"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "590ffcff99305652cd1158b2b3e9b33f149c0a08b866cd9830872620f292da45",
"md5": "b1355495686daa73d4dec95e0cdf13c7",
"sha256": "1d454be2c2f21ce52ecd248f785a0c3e90fceb3481a5b5d7c89260b8da8e9798"
},
"downloads": -1,
"filename": "anilist_helper-1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1355495686daa73d4dec95e0cdf13c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23082,
"upload_time": "2024-04-14T09:15:13",
"upload_time_iso_8601": "2024-04-14T09:15:13.911013Z",
"url": "https://files.pythonhosted.org/packages/59/0f/fcff99305652cd1158b2b3e9b33f149c0a08b866cd9830872620f292da45/anilist_helper-1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10677dd1cb16f8b644fe67dc60d51cef511ce70d4b0139f6d47fc1c4fa0d3cc3",
"md5": "bb4aae311a93748cf7d1188199f099a6",
"sha256": "cf9e4ba7cce1dfd0c7e6a290770acb34048dcca445d4e66358afd40562aa4dac"
},
"downloads": -1,
"filename": "anilist_helper-1.7.tar.gz",
"has_sig": false,
"md5_digest": "bb4aae311a93748cf7d1188199f099a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22623,
"upload_time": "2024-04-14T09:15:15",
"upload_time_iso_8601": "2024-04-14T09:15:15.521627Z",
"url": "https://files.pythonhosted.org/packages/10/67/7dd1cb16f8b644fe67dc60d51cef511ce70d4b0139f6d47fc1c4fa0d3cc3/anilist_helper-1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 09:15:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ProchyGaming",
"github_project": "anilist-helper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "anilist-helper"
}
