Skip to content
/ openapi-mangadex-python Public

Python-based generated MangaDex OpenAPI client (Unofficial).

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

mahmudindev/openapi-mangadex-python

BranchesTags

Repository files navigation

mangadex-openapi

MangaDex is an ad-free manga reader offering high-quality images!

This document details our API as it is right now. It is in no way a promise to never change it, although we will endeavour to publicly notify any major change.

Acceptable use policy

Usage of our services implies acceptance of the following:

  • You MUST credit us
  • You MUST credit scanlation groups if you offer the ability to read chapters
  • You CANNOT run ads or paid services on your website and/or apps

These may change at any time for any and no reason and it is up to you check for updates from time to time.

Security issues

If you believe you found a security issue in our API, please check our security.txt to get in touch privately.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 5.10.2
  • Package version: 5.10.2.dev1
  • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import mangadex_openapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import mangadex_openapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import mangadex_openapi
from mangadex_openapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mangadex.org
# See configuration.py for a list of all supported configuration parameters.
configuration = mangadex_openapi.Configuration(
    host = "https://api.mangadex.org"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: Bearer
configuration = mangadex_openapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with mangadex_openapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mangadex_openapi.ApiClientApi(api_client)
    id = 'id_example' # str | ApiClient ID
    version = 'version_example' # str |  (optional)

    try:
        # Delete Api Client
        api_response = api_instance.delete_apiclient(id, version=version)
        print("The response of ApiClientApi->delete_apiclient:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiClientApi->delete_apiclient: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.mangadex.org

Class Method HTTP request Description
ApiClientApi delete_apiclient DELETE /client/{id} Delete Api Client
ApiClientApi get_apiclient GET /client/{id} Get Api Client by ID
ApiClientApi get_apiclient_secret GET /client/{id}/secret Get Secret for Client by ID
ApiClientApi get_list_apiclients GET /client List own Api Clients
ApiClientApi post_create_apiclient POST /client Create ApiClient
ApiClientApi post_edit_apiclient POST /client/{id} Edit ApiClient
ApiClientApi post_regenerate_apiclient_secret POST /client/{id}/secret Regenerate Client Secret
AtHomeApi get_at_home_server_chapter_id GET /at-home/server/{chapterId} Get MangaDex@Home server URL
AuthenticationApi get_auth_check GET /auth/check Check the set of permissions associated with the current token
AuthenticationApi post_auth_login POST /auth/login Login
AuthenticationApi post_auth_logout POST /auth/logout Logout
AuthenticationApi post_auth_refresh POST /auth/refresh Refresh token
AuthorApi delete_author_id DELETE /author/{id} Delete Author
AuthorApi get_author GET /author Author list
AuthorApi get_author_id GET /author/{id} Get Author
AuthorApi post_author POST /author Create Author
AuthorApi put_author_id PUT /author/{id} Update Author
CaptchaApi post_captcha_solve POST /captcha/solve Solve Captcha
ChapterApi delete_chapter_id DELETE /chapter/{id} Delete Chapter
ChapterApi get_chapter GET /chapter Chapter list
ChapterApi get_chapter_id GET /chapter/{id} Get Chapter
ChapterApi put_chapter_id PUT /chapter/{id} Update Chapter
CoverApi delete_cover DELETE /cover/{mangaOrCoverId} Delete Cover
CoverApi edit_cover PUT /cover/{mangaOrCoverId} Edit Cover
CoverApi get_cover GET /cover CoverArt list
CoverApi get_cover_id GET /cover/{mangaOrCoverId} Get Cover
CoverApi upload_cover POST /cover/{mangaOrCoverId} Upload Cover
CustomListApi delete_list_id DELETE /list/{id} Delete CustomList
CustomListApi delete_manga_id_list_list_id DELETE /manga/{id}/list/{listId} Remove Manga in CustomList
CustomListApi follow_list_id POST /list/{id}/follow Follow CustomList
CustomListApi get_list_id GET /list/{id} Get CustomList
CustomListApi get_user_id_list GET /user/{id}/list Get User's CustomList list
CustomListApi get_user_list GET /user/list Get logged User CustomList list
CustomListApi post_list POST /list Create CustomList
CustomListApi post_manga_id_list_list_id POST /manga/{id}/list/{listId} Add Manga in CustomList
CustomListApi put_list_id PUT /list/{id} Update CustomList
CustomListApi unfollow_list_id DELETE /list/{id}/follow Unfollow CustomList
FeedApi get_list_id_feed GET /list/{id}/feed CustomList Manga feed
FeedApi get_user_follows_manga_feed GET /user/follows/manga/feed Get logged User followed Manga feed (Chapter list)
FollowsApi get_user_follows_group GET /user/follows/group Get logged User followed Groups
FollowsApi get_user_follows_group_id GET /user/follows/group/{id} Check if logged User follows a Group
FollowsApi get_user_follows_list GET /user/follows/list Get logged User followed CustomList list
FollowsApi get_user_follows_list_id GET /user/follows/list/{id} Check if logged User follows a CustomList
FollowsApi get_user_follows_manga GET /user/follows/manga Get logged User followed Manga list
FollowsApi get_user_follows_manga_id GET /user/follows/manga/{id} Check if logged User follows a Manga
FollowsApi get_user_follows_user GET /user/follows/user Get logged User followed User list
FollowsApi get_user_follows_user_id GET /user/follows/user/{id} Check if logged User follows a User
ForumsApi forums_thread_create POST /forums/thread Create forums thread
InfrastructureApi get_ping GET /ping Ping healthcheck
LegacyApi post_legacy_mapping POST /legacy/mapping Legacy ID mapping
MangaApi commit_manga_draft POST /manga/draft/{id}/commit Submit a Manga Draft
MangaApi delete_manga_id DELETE /manga/{id} Delete Manga
MangaApi delete_manga_id_follow DELETE /manga/{id}/follow Unfollow Manga
MangaApi delete_manga_relation_id DELETE /manga/{mangaId}/relation/{id} Delete Manga relation
MangaApi get_manga_aggregate GET /manga/{id}/aggregate Get Manga volumes & chapters
MangaApi get_manga_drafts GET /manga/draft Get a list of Manga Drafts
MangaApi get_manga_id GET /manga/{id} Get Manga
MangaApi get_manga_id_draft GET /manga/draft/{id} Get a specific Manga Draft
MangaApi get_manga_id_feed GET /manga/{id}/feed Manga feed
MangaApi get_manga_id_status GET /manga/{id}/status Get a Manga reading status
MangaApi get_manga_random GET /manga/random Get a random Manga
MangaApi get_manga_relation GET /manga/{mangaId}/relation Manga relation list
MangaApi get_manga_status GET /manga/status Get all Manga reading status for logged User
MangaApi get_manga_tag GET /manga/tag Tag list
MangaApi get_search_manga GET /manga Manga list
MangaApi post_manga POST /manga Create Manga
MangaApi post_manga_id_follow POST /manga/{id}/follow Follow Manga
MangaApi post_manga_id_status POST /manga/{id}/status Update Manga reading status
MangaApi post_manga_relation POST /manga/{mangaId}/relation Create Manga relation
MangaApi put_manga_id PUT /manga/{id} Update Manga
RatingApi delete_rating_manga_id DELETE /rating/{mangaId} Delete Manga rating
RatingApi get_rating GET /rating Get your ratings
RatingApi post_rating_manga_id POST /rating/{mangaId} Create or update Manga rating
ReadMarkerApi get_manga_chapter_readmarkers GET /manga/{id}/read Manga read markers
ReadMarkerApi get_manga_chapter_readmarkers2 GET /manga/read Manga read markers
ReadMarkerApi get_reading_history GET /user/history Get users reading history
ReadMarkerApi post_manga_chapter_readmarkers POST /manga/{id}/read Manga read markers batch
ReportApi get_report_reasons_by_category GET /report/reasons/{category} Get a list of report reasons
ReportApi get_reports GET /report Get a list of reports by the user
ReportApi post_report POST /report Create a new Report
ScanlationGroupApi delete_group_id DELETE /group/{id} Delete Scanlation Group
ScanlationGroupApi delete_group_id_follow DELETE /group/{id}/follow Unfollow Scanlation Group
ScanlationGroupApi get_group_id GET /group/{id} Get Scanlation Group
ScanlationGroupApi get_search_group GET /group Scanlation Group list
ScanlationGroupApi post_group POST /group Create Scanlation Group
ScanlationGroupApi post_group_id_follow POST /group/{id}/follow Follow Scanlation Group
ScanlationGroupApi put_group_id PUT /group/{id} Update Scanlation Group
SettingsApi get_settings GET /settings Get an User Settings
SettingsApi get_settings_template GET /settings/template Get latest Settings template
SettingsApi get_settings_template_version GET /settings/template/{version} Get Settings template by version id
SettingsApi post_settings POST /settings Create or update an User Settings
SettingsApi post_settings_template POST /settings/template Create Settings template
StatisticsApi get_statistics_chapter_uuid GET /statistics/chapter/{uuid} Get statistics about given chapter
StatisticsApi get_statistics_chapters GET /statistics/chapter Get statistics about given chapters
StatisticsApi get_statistics_group_uuid GET /statistics/group/{uuid} Get statistics about given scanlation group
StatisticsApi get_statistics_groups GET /statistics/group Get statistics about given groups
StatisticsApi get_statistics_manga GET /statistics/manga Find statistics about given Manga
StatisticsApi get_statistics_manga_uuid GET /statistics/manga/{uuid} Get statistics about given Manga
UploadApi abandon_upload_session DELETE /upload/{uploadSessionId} Abandon upload session
UploadApi begin_edit_session POST /upload/begin/{chapterId} Start an edit chapter session
UploadApi begin_upload_session POST /upload/begin Start an upload session
UploadApi commit_upload_session POST /upload/{uploadSessionId}/commit Commit the upload session and specify chapter data
UploadApi delete_uploaded_session_file DELETE /upload/{uploadSessionId}/{uploadSessionFileId} Delete an uploaded image from the Upload Session
UploadApi delete_uploaded_session_files DELETE /upload/{uploadSessionId}/batch Delete a set of uploaded images from the Upload Session
UploadApi get_upload_session GET /upload Get the current User upload session
UploadApi put_upload_session_file POST /upload/{uploadSessionId} Upload images to the upload session
UploadApi upload_check_approval_required POST /upload/check-approval-required Check if a given manga / locale for a User needs moderation approval
UserApi delete_user_id DELETE /user/{id} Delete User
UserApi get_user GET /user User list
UserApi get_user_id GET /user/{id} Get User
UserApi get_user_me GET /user/me Logged User details
UserApi post_user_delete_code POST /user/delete/{code} Approve User deletion

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Bearer

  • Type: Bearer authentication

Author

support@mangadex.org

About

Python-based generated MangaDex OpenAPI client (Unofficial).

Topics

client sdk openapi comics mangadex

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages