An asynchronous wrapper around the MangaDex v5 API
Project description
A lightweight and asynchronous wrapper around the MangaDex v5 API.
Features
NOTE This library is still in development, I will list off the API methods and their progress here:
Feature | Implemented? | Notes |
---|---|---|
Chapter Upload | [ ] | Soon:tm: |
Manga | [x] | Done. |
Cover | [x] | Done. |
Author | [x] | Done. |
Search | [x] | Done. |
Auth | [x] | Authentication is done per request, token handled. |
Scanlation Group | [x] | Done. |
Feed | [x] | Done |
CustomList | [x] | Done. |
AtHome | [x] | Done. |
Legacy | [x] | Done. |
Infrastructure | [x] | Done. |
Upload | [ ] | Soon:tm: |
Account | [x] | Done. |
User | [x] | Done. |
Chapter | [x] | Done. |
Report | [x] | Done. |
Ratelimits? | [ ] | Not part of the API spec but might be handy. |
In Progress: Upload
Endpoint | Implemented? | Notes |
---|
Note about authentication
Sadly (thankfully?) I am not an author on MangaDex, meaning I cannot test the creation endpoints for things like scanlators, artists, authors, manga or chapters. I have followed the API guidelines to the letter for these, but they may not work.
Any help in testing them is greatly appreciated.
Examples
Please take a look at the examples directory for working examples.
NOTE: More examples will follow as the library is developed.
API caveats to note
- There are no API endpoints for Artist. Currently, if you query a manga without the
"artist"
query includes then you will not receive artist data. - The tags are locally cached since you must pass UUIDs to the api (and I do not think you're going to memorise those), there's a convenience method for updating the local cache as
Client.update_tags
- I have added an example on how to do the above.
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.