Skip to main content

Mangadex CLI

Project description

Unofficial MangaDex API and CLI

Full documentation can be found at https://mdapi.readthedocs.io/en/latest/py-modindex/. There are no examples currently, but they will be coming soon.

Basic API usage

In absence of full examples, here's a brief example snippet:

from mdapi import MdAPI

md = MdAPI()

user = md.user.get_self()
if user is None:
    print("Please login using `mdex login`")
    quit()
print(f"Logged in as {user.username}")

results = md.manga.search("Murenase")
manga = next(results)
print(f"Found {manga.title}")

read_chapters = md.manga.get_read(manga)

chapters = md.manga.get_chapters(manga, order=ChapterSortOrder(chapter="asc"))
chapter = next(chapters)

print(f"First chapter: {chapter.title}")
print("Already read:", chapter.id in read_chapters)

urls = md.chapter.page_urls_for(chapter)
print("First page:")
print(next(urls))

md.chapter.mark_read(chapter)

CLI Commands

To read a chapter, the three commands needed are, in order:

  • mdex search [query here]
  • mdex chapters [manga uuid]
  • mdex read [chapter uuid]

Additionally, mdex login, mdex logout, and mdex whoami are provided. These can be used to generate a .mdauth file without requiring a call to md.auth.login() from code with a plaintext password. They will also be used in future when additional functionality is added to the CLI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdex-0.0.13.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

mdex-0.0.13-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file mdex-0.0.13.tar.gz.

File metadata

  • Download URL: mdex-0.0.13.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0

File hashes

Hashes for mdex-0.0.13.tar.gz
Algorithm Hash digest
SHA256 f1240640bacb84abf116392cf984701c0d2e60a180b7da4f5bfc27e824059cc4
MD5 03380d76ba65a3024972cb77721b6272
BLAKE2b-256 9cd587ae7c24f417e858ba3164221f931c4cb9ebc3e750cc61de534bbd70f117

See more details on using hashes here.

File details

Details for the file mdex-0.0.13-py3-none-any.whl.

File metadata

  • Download URL: mdex-0.0.13-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0

File hashes

Hashes for mdex-0.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 bb5a87d9f7cb6f3ccdc45db4c5ba15ebbffb9b2b99fff03954d9b7d941e90370
MD5 4264e2899624f720463764593bc0c38d
BLAKE2b-256 ba8b72c204c8cce4da145c980999ce0a7817709a99a78a8b3e2041316fcc8c61

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page