malfetcher


Namemalfetcher JSON
Version 1.7.0 PyPI version JSON
download
home_pageNone
SummaryA simple library to help you fetch data from MyAnimeList.
upload_time2024-09-18 06:47:37
maintainerDominik Procházka
docs_urlNone
authorDominik Procházka
requires_python>=3.8
licenseNone
keywords python mal myanimelist
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # malfetcher

A simple library to help you fetch data from MyAnimeList

## Description

This library is aimed at people who might be interested in automatizing their anime library.

## Getting Started

### Dependencies

* Python(tested on the latest ver.)
* A MyAnimeList account
* A MyAnimeList developer app

### Installing

* Clone this repo
```
git clone https://github.com/prochy-exe/malfetcher /path/to/desired/folder
```
* Install it using pip
```
pip install malfetcher
```
* 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 malfetcher
```
* When importing this library for the first time, you will be taken through the setup process

### Setting up the MyAnilist 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/malfetcher/releases/tag/v1.7.0)
    * [implement caching and 429 error handling](https://github.com/prochy-exe/malfetcher/commit/774edf2c3f2176218830718c3bfe004971a0048f)
* [1.6.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.6.0)
    * [fix up updating entries](https://github.com/prochy-exe/malfetcher/commit/10d97fb6f79c91aa3a3bca4e35b92dfbed8c4ae1)
* [1.5.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.5.0)
    * [guard against excessive updates](https://github.com/prochy-exe/malfetcher/commit/478c86bd2728225ee6e9e7f99518402229472c1c)
    * [make sure the id is a str](https://github.com/prochy-exe/malfetcher/commit/56776541ce14fdf76f0bcb79df42c9b01dd1dbd9)
    * [simply function and variable names](https://github.com/prochy-exe/malfetcher/commit/dc336cae60e17c16f31c15863c11e79b05b7f8d7)
* [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/malfetcher/commit/40104e68c2d093aa9a43ef61a5d506b86d7d7df8)
* [1.2.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.2.0)
    * [fix light init](https://github.com/prochy-exe/malfetcher/commit/8f30536fe4f9817eea870cb4d4ea7a248badb0b5)
* [1.1.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.1.0)
    * [fix typo](https://github.com/prochy-exe/malfetcher/commit/ec8fa79befc1a4190667639920f3b6bd736340f1)
    * [allow some functions to not require user token](https://github.com/prochy-exe/malfetcher/commit/2a3b8c4229984caf7e383072eb5e06af0208c3e3)
    * [use local ip address instead of localhost](https://github.com/prochy-exe/malfetcher/commit/ccb7bfff7d136e9be0204509f18f1646185b5e2c)
    * [print list name when no anime found](https://github.com/prochy-exe/malfetcher/commit/7888e5d7d7100f8e9952210ddbed6705b5dc393b)
    * [drop user list caching](https://github.com/prochy-exe/malfetcher/commit/dd5933434945759bbab8a2fd06ce0511b1ff435e)
    * [allow the mal_to_al_id function to be imported easily](https://github.com/prochy-exe/malfetcher/commit/fbf23bfd384ac53d68dbbe7960d12efa29d88b11)
    * [add function to update progress in users list](https://github.com/prochy-exe/malfetcher/commit/e8fa1dd20054c68f81be4133a9414daa4aad8b29)
    * [regenerate token when expired](https://github.com/prochy-exe/malfetcher/commit/af326c5693fec00c8c90286d63d81782fb90932f)
    * [add state to requests](https://github.com/prochy-exe/malfetcher/commit/76a3e27031ef88d5ba84d7816802647ae55a9e84)
    * [rotate useragents in hopes to avoid captcha](https://github.com/prochy-exe/malfetcher/commit/15ef5a3e866b64cb287264d70946602aa50dea82)
    * [fetch unreleased info all the time](https://github.com/prochy-exe/malfetcher/commit/15d8723dab29a67f0b55f903f8195a47bced6253)
    * [make sure we have a day in the dates](https://github.com/prochy-exe/malfetcher/commit/6ceea01d96ec190b85e0d3950f84a861aa464a73)
    * [Formatting changes](https://github.com/prochy-exe/malfetcher/commit/d06303c44837bc75f788fb29e510dad645c9e801)
* [1.0.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.0.0)
    * [Initial Release](https://github.com/prochy-exe/malfetcher/commit/2d356310fbe00143c50ffe14596532a7cd30e8db)

## Acknowledgments
* [MyAnimeList](https://myanimelist.net)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "malfetcher",
    "maintainer": "Dominik Proch\u00e1zka",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "python, mal, myanimelist",
    "author": "Dominik Proch\u00e1zka",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/76/00/24f3d0a1339e391dbae5c1b19ca983a0d881fb8def7b4f135a8510b9fbae/malfetcher-1.7.0.tar.gz",
    "platform": null,
    "description": "# malfetcher\n\nA simple library to help you fetch data from MyAnimeList\n\n## Description\n\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* A MyAnimeList account\n* A MyAnimeList developer app\n\n### Installing\n\n* Clone this repo\n```\ngit clone https://github.com/prochy-exe/malfetcher /path/to/desired/folder\n```\n* Install it using pip\n```\npip install malfetcher\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 malfetcher\n```\n* When importing this library for the first time, you will be taken through the setup process\n\n### Setting up the MyAnilist 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/malfetcher/releases/tag/v1.7.0)\n    * [implement caching and 429 error handling](https://github.com/prochy-exe/malfetcher/commit/774edf2c3f2176218830718c3bfe004971a0048f)\n* [1.6.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.6.0)\n    * [fix up updating entries](https://github.com/prochy-exe/malfetcher/commit/10d97fb6f79c91aa3a3bca4e35b92dfbed8c4ae1)\n* [1.5.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.5.0)\n    * [guard against excessive updates](https://github.com/prochy-exe/malfetcher/commit/478c86bd2728225ee6e9e7f99518402229472c1c)\n    * [make sure the id is a str](https://github.com/prochy-exe/malfetcher/commit/56776541ce14fdf76f0bcb79df42c9b01dd1dbd9)\n    * [simply function and variable names](https://github.com/prochy-exe/malfetcher/commit/dc336cae60e17c16f31c15863c11e79b05b7f8d7)\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/malfetcher/commit/40104e68c2d093aa9a43ef61a5d506b86d7d7df8)\n* [1.2.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.2.0)\n    * [fix light init](https://github.com/prochy-exe/malfetcher/commit/8f30536fe4f9817eea870cb4d4ea7a248badb0b5)\n* [1.1.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.1.0)\n    * [fix typo](https://github.com/prochy-exe/malfetcher/commit/ec8fa79befc1a4190667639920f3b6bd736340f1)\n    * [allow some functions to not require user token](https://github.com/prochy-exe/malfetcher/commit/2a3b8c4229984caf7e383072eb5e06af0208c3e3)\n    * [use local ip address instead of localhost](https://github.com/prochy-exe/malfetcher/commit/ccb7bfff7d136e9be0204509f18f1646185b5e2c)\n    * [print list name when no anime found](https://github.com/prochy-exe/malfetcher/commit/7888e5d7d7100f8e9952210ddbed6705b5dc393b)\n    * [drop user list caching](https://github.com/prochy-exe/malfetcher/commit/dd5933434945759bbab8a2fd06ce0511b1ff435e)\n    * [allow the mal_to_al_id function to be imported easily](https://github.com/prochy-exe/malfetcher/commit/fbf23bfd384ac53d68dbbe7960d12efa29d88b11)\n    * [add function to update progress in users list](https://github.com/prochy-exe/malfetcher/commit/e8fa1dd20054c68f81be4133a9414daa4aad8b29)\n    * [regenerate token when expired](https://github.com/prochy-exe/malfetcher/commit/af326c5693fec00c8c90286d63d81782fb90932f)\n    * [add state to requests](https://github.com/prochy-exe/malfetcher/commit/76a3e27031ef88d5ba84d7816802647ae55a9e84)\n    * [rotate useragents in hopes to avoid captcha](https://github.com/prochy-exe/malfetcher/commit/15ef5a3e866b64cb287264d70946602aa50dea82)\n    * [fetch unreleased info all the time](https://github.com/prochy-exe/malfetcher/commit/15d8723dab29a67f0b55f903f8195a47bced6253)\n    * [make sure we have a day in the dates](https://github.com/prochy-exe/malfetcher/commit/6ceea01d96ec190b85e0d3950f84a861aa464a73)\n    * [Formatting changes](https://github.com/prochy-exe/malfetcher/commit/d06303c44837bc75f788fb29e510dad645c9e801)\n* [1.0.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.0.0)\n    * [Initial Release](https://github.com/prochy-exe/malfetcher/commit/2d356310fbe00143c50ffe14596532a7cd30e8db)\n\n## Acknowledgments\n* [MyAnimeList](https://myanimelist.net)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple library to help you fetch data from MyAnimeList.",
    "version": "1.7.0",
    "project_urls": {
        "Documentation": "https://github.com/prochy-exe/malfetcher/wiki",
        "Homepage": "https://github.com/prochy-exe/malfetcher",
        "Source": "https://github.com/prochy-exe/malfetcher"
    },
    "split_keywords": [
        "python",
        " mal",
        " myanimelist"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f65830217419d9baec73023a8731f9a62f362a732cc0f153bb96389c2b377692",
                "md5": "9c0e4bc3aa5a2ab6027019d2ceb0a6df",
                "sha256": "8dc9243d6cd8c5814395ea65476333623ecc7e443eeaf33d399b1caf4abd937c"
            },
            "downloads": -1,
            "filename": "malfetcher-1.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c0e4bc3aa5a2ab6027019d2ceb0a6df",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 24359,
            "upload_time": "2024-09-18T06:47:36",
            "upload_time_iso_8601": "2024-09-18T06:47:36.646223Z",
            "url": "https://files.pythonhosted.org/packages/f6/58/30217419d9baec73023a8731f9a62f362a732cc0f153bb96389c2b377692/malfetcher-1.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "760024f3d0a1339e391dbae5c1b19ca983a0d881fb8def7b4f135a8510b9fbae",
                "md5": "1dc449381c6fe0c171a70a4cbe4ba033",
                "sha256": "8a7653c94a4bfa7d731f014dc3497e039200cda8b42cf6a28a7a1c9049e65362"
            },
            "downloads": -1,
            "filename": "malfetcher-1.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1dc449381c6fe0c171a70a4cbe4ba033",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 25761,
            "upload_time": "2024-09-18T06:47:37",
            "upload_time_iso_8601": "2024-09-18T06:47:37.535986Z",
            "url": "https://files.pythonhosted.org/packages/76/00/24f3d0a1339e391dbae5c1b19ca983a0d881fb8def7b4f135a8510b9fbae/malfetcher-1.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-18 06:47:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "prochy-exe",
    "github_project": "malfetcher",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "malfetcher"
}
        
Elapsed time: 0.34307s