malfetcher 2.0.0
A simple library to help you fetch data from MyAnimeList.
Requires Python: >=3.8
Keywords: python, mal, myanimelist

# 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
* [2.0.0](https://github.com/prochy-exe/malfetcher/releases/tag/v2.0.0)
    * [allow client_id to be an ENV var](https://github.com/prochy-exe/malfetcher/commit/a6ee2dbfaf70557d75b9d1971322e774538c6324)
    * [fix media_type path](https://github.com/prochy-exe/malfetcher/commit/ba4d1d1f9f93f7603c91d0d1b520406b94d628b0)
    * [fix padding in config_utils](https://github.com/prochy-exe/malfetcher/commit/a980f0c8237f8715b5ca7e691e1e08bc925c503f)
* [1.9.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.9.0)
    * [amount and format support, general improvements](https://github.com/prochy-exe/malfetcher/commit/4dc7c76fb5657f25649b25587c4d8ae6c70d49e9)
    * [return empty dict instead of none](https://github.com/prochy-exe/malfetcher/commit/ae35eef7c721ee21ba471e89a18a91a385bcd54a)
* [1.8.0](https://github.com/prochy-exe/malfetcher/releases/tag/v1.8.0)
    * [update_entry: read token from config](https://github.com/prochy-exe/malfetcher/commit/c8c46782ab461010c63034cea592f6b1bda52203)
    * [fix sorting of the list, along with the amount of anime](https://github.com/prochy-exe/malfetcher/commit/1687636a2a9d0bf6f00cbd5ce1a3d80de3c99cf0)
    * [rebrand request function to mal](https://github.com/prochy-exe/malfetcher/commit/de8bbf4e8004f8a65d4beb611d253bddc39b0c0e)
    * [add a feature that allows specifying episodes from another season](https://github.com/prochy-exe/malfetcher/commit/89e37eace4e062ed6ed787c4a6531a18b0dc707f)
    * [fix a bug that marks anime as planning while having an episode watched](https://github.com/prochy-exe/malfetcher/commit/17e5cccf3a4cb1e611048af85f106c7daeb83ae7)
    * [introduce a function that returns list of all seasons](https://github.com/prochy-exe/malfetcher/commit/66bb8a31c56dc746d0c6818c3da97739868cad86)
    * [repeating support](https://github.com/prochy-exe/malfetcher/commit/5324c635ae390a67de52c939abb3c0b9da552da2)       
    * [setup flow qol imporvements](https://github.com/prochy-exe/malfetcher/commit/63a5a9cf119f0550c56154be70e31d4b270b095b)
    * [fix mal auth and add url tooltip](https://github.com/prochy-exe/malfetcher/commit/5a0f7b99cf96e725f5357026e3942501a167bccb)
* [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)