Python wrapper for the mangadex API
Project description
mangadex.py
A python wrapper for the MangaDex API V5. It uses the requests library and all the aditional arguments can be viewed in the Official Mangadex Documentation
Instaling the API wrapper module
PyPI
pip install --Upgrade mangadex
Installing via setuptools
python setup.py install --user
Wrapper Usage
>>> import mangadex as md
>>> auth = md.auth.Auth()
>>> manga = md.series.Manga(auth=auth)
>>> chapter = md.series.Chapter(auth=auth)
>>> customlist = md.series.CustomList(auth=auth)
>>> tag = md.series.Tag(auth=auth)
>>> cover = md.series.Cover(auth=auth)
>>> scangroup = md.people.ScanlationGroup(auth=auth)
>>> user = md.people.User(auth=auth)
>>> follows = md.people.Follows(auth=auth)
Manga
Getting the latest manga chapters
This is called mangalist in the documentation
>>> manga_list = manga.get_manga_list(limit = 1) #limits the query to return just one manga
>>> manga_list[Manga(manga_id = 0001183c-2089-48e9-96b7-d48db5f1a611, title = {'en': 'Eight'}, altTitles = [{'ja': '8(エイト)'}], description = {'en': 'Tokyo in the 90s, the city center has been suffering from a continuing depopulation. Also affected is the Udagawa Junior High School where only six people are left, as their class leader, protector and very good friend Masato just died in an illegal skateboarding race. Five months later Eito Hachiya, nickname: Eight or "8" enrolls in school and wants to find out what happened. He even just looks like Masato! But mysteries surround him: Why does he know all the other six? Why can’t they remember him? \n \nNote: Was cancelled after ~25% of volume 4, the epilogue consists of an alternative ending for Eight.'}, isLocked = False, links = {'al': '38734', 'ap': 'eight', 'kt': '17709', 'mu': '6521', 'amz': 'https://www.amazon.co.jp/dp/B07WS2K894', 'mal': '8734', 'raw': 'https://csbs.shogakukan.co.jp/book?book_group_id=14478'}, originalLanguage = ja
lastVolume = 4, lastChapter = 37.6, publicationDemographic = seinen, status = completed, year = 2000, contentRating = safe
createdAt = 2018-02-04 21:32:02+00:00, uploadedAt = 2022-01-12 21:42:40+00:00), author_id = ['905aaced-1556-4925-bff0-14ea277fb0b1', '905aaced-1556-4925-bff0-14ea277fb0b1'], artist_id = [], cover_id = 51bf2e88-98ac-4fd7-afb5-80edff694d53
Searching manga
>>> manga_list = manga.get_manga_list(title = "You manga title here")
Getting manga information by its id
>>> manga = manga.view_manga_by_id(manga_id = "0001183c-2089-48e9-96b7-d48db5f1a611")
Getting random manga
>>> random_manga = Manga.random_manga()
Manga Feed
Get the chapter, or chapters from MDList.
>>> manga_feed = Manga.manga_feed(manga_id = "0001183c-2089-48e9-96b7-d48db5f1a611", limit = 1)
[Chapter(chapter_id = 015979c8-ffa4-4afa-b48e-3da6d10279b0, title = Navel-Gazing, volume = 3, chapter = 23.0, translatedLanguage = en, hash =
data = List[filenames], publishAt = 2018-03-19 01:32:00+00:00, createdAt = 2018-03-19 01:32:00+00:00, uploadedAt = 2018-03-19 01:32:00+00:00, group_id = 59957a04-fa91-4099-921d-7e7988a19acb, manga_id = 0001183c-2089-48e9-96b7-d48db5f1a611, uploader = e19519ce-8c5f-4d7c-8280-704a87d34429)]
Chapter
Get manga volumes and chapters
>>> chapter.get_manga_volumes_and_chapters(manga_id = "the manga id")
Get Chapter Info
>>> chp = chapter.get_chapter(chapter_id = "015979c8-ffa4-4afa-b48e-3da6d10279b0")
>> chp
Chapter(chapter_id = 015979c8-ffa4-4afa-b48e-3da6d10279b0, title = Navel-Gazing, volume = 3, chapter = 23.0, translatedLanguage = en, hash =
data = List[filenames], publishAt = 2018-03-19 01:32:00+00:00, createdAt = 2018-03-19 01:32:00+00:00, uploadedAt = 2018-03-19 01:32:00+00:00, group_id = 59957a04-fa91-4099-921d-7e7988a19acb, manga_id = 0001183c-2089-48e9-96b7-d48db5f1a611, uploader = e19519ce-8c5f-4d7c-8280-704a87d34429)
Chapter List
Returns a list of latest chapters
>>> chapter_list = chapter.chapter_list()
Chapter Images
Return the links for the chapter images.
>>> chapter.fetch_chapter_images()
Tag
Get Tag List
>>> tag_list = tag.tag_list()
Scanlation Group
Get Scanlation Group List
>>> scangroup.scanlation_group_list()
Cover
Get Cover Images List
>>> cover.get_coverart_list()
Get Cover by Id
>>> cover.get_cover(cover_id = "the cover id")
Edit Cover
>>> cover.edit_cover(cover_id = "the cover id", description = "the cover description, can be null", volume = "the volume number", version = "int, the cover version")
Get cover image link
>>> cover.fetch_cover_image()
This is a CoverArt method that returns the cover image url of that object
Private Calls
Login
Username and password combo-only logins are deprecated as MangaDex shift to OAuth. Personal clients are needed alongside it. #26
Method to login to the website
>>> auth.login(username = USERNAME, password = PASSWORD, client_id = clientId, client_secret = clientSecret)
It is recomended that you add this values to your environment variables and use text input for client-facing solutions for security reasons.
>>> auth.login(os.environ['md_username'], os.environ['md_password'],os.environ['client_id'], os.environ['client_secret'])
Your User Info
Get your user info
>>> my_user = user.me()
Get User Info
>>> user = user.get_user(user_id = "id of user")
Get Logged User Followed Manga List
Get your manga follow list!
>>> follow_list = follows.get_my_mangalist()
Get Logged User Followed Groups
Get the list of the Scanlation group you follow!
>>> scangroups_followlist = follows.get_my_followed_groups()
Get Logged User Followed Users
Get the list of the users you follow!
>>> followed_users = follows.get_my_followed_users()
Get chapters marked as read from a manga
Get a list of the chapters marked as read for a given manga
>>> read_chapters = manga.get_manga_read_markes(id = "the manga id")
Get all followed manga reading status
Get a list of the all the manga reading stauts
>>> my_manga_reading_stauts = manga.get_all_manga_reading_status()
Get a specific manga reading status
Get the reading status of a specific manga
>>> manga_reading_status = manga.get_manga_reading_status(manga_id = "the manga id")
Update Manga reading status
>>> manga.update_manga_reading_status(manga_id = "the manga id", status = "the new reading status")
The status
parameter can take the following values:
"reading"
"on_hold"
"plan_to_read"
"dropped"
"re_reading"
"completed"
Follow a manga
Follow a manga
>>> follows.follow_manga(manga_id = "the manga id")
Unfollow a manga
Unfollows a manga
>>> manga.unfollow_manga(manga_id = "the manga id")
Create manga
Creates a manga
>>> manga.create_manga(title = "manga title", )
Update Manga
Update manga information
>>> manga.update_manga(manga_id = "the manga id")
Delete Manga
Deletes manga
>>> manga.delete_manga(manga_id = "the manga id")
Add manga to custom list
Add a manga to a custom list
>>> customlist.add_manga_to_customlist(manga_id = "the manga id", list_id = "the list id")
Remove a manga from custom list
Removes a manga from a custom list
>>> customlist.remove_manga_from_customlist(id = "the manga id", listId = "the list id")
Create a custom list
>>> customlist.create_customlist() #this will create a custom list with no special parameters
Get custom list
>>> customlist.get_customlist(id = "custom list id")
Update custom list
>>> customlist.update_customlist(id = "custom list id")
Delete custom list
>>> customlist.delete_customlist(id = "the custom list id")
Get User Custom list
>>> customlist.get_user_customlists(id = "the user id")
Create Author
>>> author.create_author(name = "author name", version = 1, ObjReturn = False)
Update Author
>>> author.update_author(id = "the author id", version = "int with the version", name = "author's name", ObjReturn = False)
Delete Author
>>> author.delete_author(id = "the author id")
Disclaimer
All the credit for the API goes to the MangaDex Team.
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.
Source Distribution
Built Distribution
File details
Details for the file mangadex-2.7.tar.gz
.
File metadata
- Download URL: mangadex-2.7.tar.gz
- Upload date:
- Size: 22.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22b0bf4527e10fba62102d41cfcd4a444b4760e1a08b44c3f43f695bd9acd9bb |
|
MD5 | 4eea692113c691cdf3d5c8c11c630eea |
|
BLAKE2b-256 | 7e37e2e5347931f79f2e35b6b6804ca41705428beb37fd76d5c77ce716e1ecd3 |
File details
Details for the file mangadex-2.7-py3-none-any.whl
.
File metadata
- Download URL: mangadex-2.7-py3-none-any.whl
- Upload date:
- Size: 20.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfb2396149e9762fb5c2425de2efa2a2ea8180f6e235bceca8344b464014600d |
|
MD5 | 0660585b428692fcb52fdde8139ef270 |
|
BLAKE2b-256 | 43823757883abc77b5218bc75a4ff7057d7f3747e8045f86300d2bc8b1a9733a |