alfetcher


Namealfetcher JSON
Version 1.7.0 PyPI version JSON
download
home_pageNone
SummaryA simple library to help you fetch data from AniList.
upload_time2024-12-30 20:36:46
maintainerDominik Procházka
docs_urlNone
authorDominik Procházka
requires_python>=3.8
licenseNone
keywords python anilist al
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # alfetcher

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

### Installing

* Clone this repo
```
git clone https://github.com/prochy-exe/alfetcher /path/to/desired/folder
```
* Install it using pip
```
pip install alfetcher
```
* 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 alfetcher
```
* 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 will automatically send the token to the library.
* 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.7.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.7.0)
    * [update_entry: read token from config](https://github.com/prochy-exe/alfetcher/commit/e55d725c9bf56208be7745b4f428406419b9eede)
    * [rewatch](https://github.com/prochy-exe/alfetcher/commit/9515dbd0283c3162375fad27b3f5c5978baabc8d)   
    * [repeating support for update_entry](https://github.com/prochy-exe/alfetcher/commit/e550ad1ab816f0f880e57864eaa45f28e4f9d631)
    * [add a feature that allows specifying episodes from another season](https://github.com/prochy-exe/alfetcher/commit/d4de856f2663f332787068ab014f24d485378e28)
    * [fix a bug that marks anime as planning while having an episode watched](https://github.com/prochy-exe/alfetcher/commit/e490fed4d862c7c0a76a1c66ca4fa6717c0b9340)
    * [introduce a function that returns list of all seasons](https://github.com/prochy-exe/alfetcher/commit/64db1fdecc097a364e00e39686eecd0d32914892)
    * [add time before opening the browser](https://github.com/prochy-exe/alfetcher/commit/eb498fb629c7717269a8865b02d4ab0179812ead)
    * [add url tooltip](https://github.com/prochy-exe/alfetcher/commit/e3e2c0836cddea259cd87c8bff2c196d3dfe5b73)
* [1.6.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.6.0)
    * [allow progress to be 0 again](https://github.com/prochy-exe/alfetcher/commit/e358434e157965f6ab4ea6f82fa54e5841e22715)
* [1.5.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.5.0)
    * [guard against excessive updates](https://github.com/prochy-exe/alfetcher/commit/260bd7e9529582531820af3b9f0066e9b0b6c883)
    * [make sure the id is a str](https://github.com/prochy-exe/alfetcher/commit/1756332241e7937ac5b1482c3bb9a5f9a5c1c5b7)
    * [simply function and variable names](https://github.com/prochy-exe/alfetcher/commit/8d6560c28c8c2c02c7ad966acd662b8a126bf134)
* [1.4.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.4.0)
    * [add env to minimize output](https://github.com/prochy-exe/alfetcher/commit/4d0c90af39c6f6bd39c9199005ea1447ad303fc5)
* [1.3.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.3.0)
    * [don't cache empty searches](https://github.com/prochy-exe/alfetcher/commit/76c822ad2b1df430f27edf6245dde2c124b3b18e)
* [1.2.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.2.0)
    * [fix authenticated requests](https://github.com/prochy-exe/alfetcher/commit/bc9b7448145d2d0f4aa3c636fdd0d124e2f6390a)
* [1.1.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.1.0)
    * [fix typo](https://github.com/prochy-exe/alfetcher/commit/dbf3d14e90c4cfeebcef51503a884efd1e1178b5)
    * [allow some functions to not require user token](https://github.com/prochy-exe/alfetcher/commit/f3e58106709d5b1626b65384977fe22a05c7d647)
    * [use local ip address instead of localhost](https://github.com/prochy-exe/alfetcher/commit/9d6500229980faf68b20fe4a559a8d2bc08fed1b)
    * [print list name when no anime found](https://github.com/prochy-exe/alfetcher/commit/efca221b8f78ac0848aaa7d8813b6b5c36e89c28)
    * [drop user list caching](https://github.com/prochy-exe/alfetcher/commit/954fe02ef643e228561a2c3e845e18b431947652)
    * [add function to update progress in users list](https://github.com/prochy-exe/alfetcher/commit/c040d8836efb44352dd2f1339305cb9c5296f97d)
    * [add function to convert from al to mal id](https://github.com/prochy-exe/alfetcher/commit/278805356c25dcabb4029b01e337c40f83b135ac)
    * [dates: Make sure they are not None](https://github.com/prochy-exe/alfetcher/commit/92db92773cea64ec7e8c8f12bcf4bc624c2400b2)
    * [Formatting changes](https://github.com/prochy-exe/alfetcher/commit/b4a96be729ab23cff87fe00c2e0deab7d6b742f7)
* [1.0.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.0.0)
    * [Initial Release](https://github.com/prochy-exe/alfetcher/commit/4b67b1d8719d183012446a065c5b6c941ec6518e)

## 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": "alfetcher",
    "maintainer": "Dominik Proch\u00e1zka",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "python, anilist, al",
    "author": "Dominik Proch\u00e1zka",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/28/61/130f8a9841d21d3c672f9551fe9b2a38f6cd82d9cfe90b72853a69863e9d/alfetcher-1.7.0.tar.gz",
    "platform": null,
    "description": "# alfetcher\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\n### Installing\n\n* Clone this repo\n```\ngit clone https://github.com/prochy-exe/alfetcher /path/to/desired/folder\n```\n* Install it using pip\n```\npip install alfetcher\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 alfetcher\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 will automatically send the token to the library.\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.7.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.7.0)\n    * [update_entry: read token from config](https://github.com/prochy-exe/alfetcher/commit/e55d725c9bf56208be7745b4f428406419b9eede)\n    * [rewatch](https://github.com/prochy-exe/alfetcher/commit/9515dbd0283c3162375fad27b3f5c5978baabc8d)   \n    * [repeating support for update_entry](https://github.com/prochy-exe/alfetcher/commit/e550ad1ab816f0f880e57864eaa45f28e4f9d631)\n    * [add a feature that allows specifying episodes from another season](https://github.com/prochy-exe/alfetcher/commit/d4de856f2663f332787068ab014f24d485378e28)\n    * [fix a bug that marks anime as planning while having an episode watched](https://github.com/prochy-exe/alfetcher/commit/e490fed4d862c7c0a76a1c66ca4fa6717c0b9340)\n    * [introduce a function that returns list of all seasons](https://github.com/prochy-exe/alfetcher/commit/64db1fdecc097a364e00e39686eecd0d32914892)\n    * [add time before opening the browser](https://github.com/prochy-exe/alfetcher/commit/eb498fb629c7717269a8865b02d4ab0179812ead)\n    * [add url tooltip](https://github.com/prochy-exe/alfetcher/commit/e3e2c0836cddea259cd87c8bff2c196d3dfe5b73)\n* [1.6.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.6.0)\n    * [allow progress to be 0 again](https://github.com/prochy-exe/alfetcher/commit/e358434e157965f6ab4ea6f82fa54e5841e22715)\n* [1.5.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.5.0)\n    * [guard against excessive updates](https://github.com/prochy-exe/alfetcher/commit/260bd7e9529582531820af3b9f0066e9b0b6c883)\n    * [make sure the id is a str](https://github.com/prochy-exe/alfetcher/commit/1756332241e7937ac5b1482c3bb9a5f9a5c1c5b7)\n    * [simply function and variable names](https://github.com/prochy-exe/alfetcher/commit/8d6560c28c8c2c02c7ad966acd662b8a126bf134)\n* [1.4.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.4.0)\n    * [add env to minimize output](https://github.com/prochy-exe/alfetcher/commit/4d0c90af39c6f6bd39c9199005ea1447ad303fc5)\n* [1.3.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.3.0)\n    * [don't cache empty searches](https://github.com/prochy-exe/alfetcher/commit/76c822ad2b1df430f27edf6245dde2c124b3b18e)\n* [1.2.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.2.0)\n    * [fix authenticated requests](https://github.com/prochy-exe/alfetcher/commit/bc9b7448145d2d0f4aa3c636fdd0d124e2f6390a)\n* [1.1.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.1.0)\n    * [fix typo](https://github.com/prochy-exe/alfetcher/commit/dbf3d14e90c4cfeebcef51503a884efd1e1178b5)\n    * [allow some functions to not require user token](https://github.com/prochy-exe/alfetcher/commit/f3e58106709d5b1626b65384977fe22a05c7d647)\n    * [use local ip address instead of localhost](https://github.com/prochy-exe/alfetcher/commit/9d6500229980faf68b20fe4a559a8d2bc08fed1b)\n    * [print list name when no anime found](https://github.com/prochy-exe/alfetcher/commit/efca221b8f78ac0848aaa7d8813b6b5c36e89c28)\n    * [drop user list caching](https://github.com/prochy-exe/alfetcher/commit/954fe02ef643e228561a2c3e845e18b431947652)\n    * [add function to update progress in users list](https://github.com/prochy-exe/alfetcher/commit/c040d8836efb44352dd2f1339305cb9c5296f97d)\n    * [add function to convert from al to mal id](https://github.com/prochy-exe/alfetcher/commit/278805356c25dcabb4029b01e337c40f83b135ac)\n    * [dates: Make sure they are not None](https://github.com/prochy-exe/alfetcher/commit/92db92773cea64ec7e8c8f12bcf4bc624c2400b2)\n    * [Formatting changes](https://github.com/prochy-exe/alfetcher/commit/b4a96be729ab23cff87fe00c2e0deab7d6b742f7)\n* [1.0.0](https://github.com/prochy-exe/alfetcher/releases/tag/v1.0.0)\n    * [Initial Release](https://github.com/prochy-exe/alfetcher/commit/4b67b1d8719d183012446a065c5b6c941ec6518e)\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.0",
    "project_urls": {
        "Documentation": "https://github.com/prochy-exe/alfetcher/wiki",
        "Homepage": "https://github.com/prochy-exe/alfetcher",
        "Source": "https://github.com/prochy-exe/alfetcher"
    },
    "split_keywords": [
        "python",
        " anilist",
        " al"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5dec14ae3889d41d842f5aa2e5020bf2583397b87eed846a70b715fed60170a6",
                "md5": "a285dbabe5e686c10645f305de25304d",
                "sha256": "5fda43555156358ab05ba569b5581da042fc2e8a364451055ab56ad3cf63e353"
            },
            "downloads": -1,
            "filename": "alfetcher-1.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a285dbabe5e686c10645f305de25304d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 24476,
            "upload_time": "2024-12-30T20:36:45",
            "upload_time_iso_8601": "2024-12-30T20:36:45.515827Z",
            "url": "https://files.pythonhosted.org/packages/5d/ec/14ae3889d41d842f5aa2e5020bf2583397b87eed846a70b715fed60170a6/alfetcher-1.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2861130f8a9841d21d3c672f9551fe9b2a38f6cd82d9cfe90b72853a69863e9d",
                "md5": "6ef8aea0f71b56ec5df26f4c611391e2",
                "sha256": "b92b0e2137b88f4fa5ad1ce4677647891271db7000c989e076f5b6af84e1a4f6"
            },
            "downloads": -1,
            "filename": "alfetcher-1.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6ef8aea0f71b56ec5df26f4c611391e2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 26306,
            "upload_time": "2024-12-30T20:36:46",
            "upload_time_iso_8601": "2024-12-30T20:36:46.998987Z",
            "url": "https://files.pythonhosted.org/packages/28/61/130f8a9841d21d3c672f9551fe9b2a38f6cd82d9cfe90b72853a69863e9d/alfetcher-1.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-30 20:36:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "prochy-exe",
    "github_project": "alfetcher",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "alfetcher"
}
        
Elapsed time: 0.54089s