<div align="center">
<h1 align="center">
<a href="https://jisho.org/word/%E6%9C%AC%E6%A3%9A">Hondana 『本棚』</a>
<br>
<sub>
<img src=".github/assets/md.svg" height="60">
</sub>
</h1>
<a href='https://github.com/AbstractUmbra/Hondana/actions/workflows/build.yaml'>
<img src='https://github.com/AbstractUmbra/Hondana/actions/workflows/build.yaml/badge.svg' alt='Build status' />
</a>
<a href='https://github.com/AbstractUmbra/Hondana/actions/workflows/coverage_and_lint.yaml'>
<img src='https://github.com/AbstractUmbra/Hondana/actions/workflows/coverage_and_lint.yaml/badge.svg' alt='Linting and Typechecking' />
</a>
</div>
<div align="center">
<a href='https://api.mangadex.org/'>
<img src='https://img.shields.io/website?down_color=red&down_message=offline&label=API%20Status&logo=MangaDex%20API&up_color=lime&up_message=online&url=https%3A%2F%2Fapi.mangadex.org%2Fping' alt='API Status'/>
</a>
<a href='https://hondana.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/hondana/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://discord.gg/aYGYJxwqe5">
<img src='https://img.shields.io/discord/705500489248145459?color=blue&label=Discord&logo=Discord%20Server&logoColor=green' alt='Discord Server'>
</a>
</div>
<h1></h1>
<br>
A lightweight and asynchronous wrapper around the [MangaDex v5 API](https://api.mangadex.org/docs.html).
You can see our stable docs [here](https://hondana.readthedocs.io/en/stable/)!
---
## Features
We are currently at 100% feature compliance with the API.
## Examples
Please take a look at the [examples](./examples/) directory for working examples.
**NOTE**: More examples will follow as the library is developed.
### Current caveats to note
- There are no API endpoints for Artist. It seems they are not differentiated from Author types except in name only.
- I have separated them logically, but under the hood all Artists are Authors and their `__eq__` reports as such.
- The tags and report reasons are locally cached since you **must** pass UUIDs to the api (and I do not think you're going to memorize those), there's a convenience method for updating the local cache as `Client.update_tags` and `Client.update_report_reasons` respectively.
- I have added [an example](./examples/updating_local_tags.py) on how to do the above for tags.
- To use these tags, you can see an example [here](./examples/search_manga.py#L17-L22).
- [Settings related endpoints](https://api.mangadex.org/docs.html#operation/get-settings-template) are not currently exposed. I have implemented their documented use, but I do not expect them to currently function.
- Once this is exposed fully I will implement a richer interface.
- Currently, if there are any errors in a chapter upload process, the error key does not contain filenames or identifiable information on exactly what file failed upload.
- This means that I locally compare the succeeded files with the ones missing from the full response payload. The examples have been updated with how to check for an error.
- Currently, the `Client.my_chapter_read_history` method will not work. It is disabled on MD's side due to an issue they had previously. If/when it is re-introduced the method will remain the same.
### Further information/tidbits
- For a bit more clarity on a Chapter's `readableAt` vs `publishAt`, see [this page](https://api.mangadex.org/docs/dates/#readableat) on the MangaDex docs.
- A query with the `include_future_updates` bool set to `True` will include chapters that are pending release by scanlation groups on MangaDex, but which may be available on their sites.
### How to request your own personal OAuth2 Client.
For authentication with `hondana` to work, you'll need to create and request your own personal OAuth2 client within the MangaDex web portal.
This can be done [here](https://mangadex.org/settings) (under the "API Clients" section).
Within here you'll want to hit "Create":-
Fill out the relevant name and description of the api client, and hit "Create" once again.
This is currently (as of 10th Nov 2023) still a manual review and approval process by the MangaDex team, so check back regularly to find out if your client is active or still awaiting review.
Once it is active, you can fetch it's client id and client secret:-
You then pass this information to the `hondana.Client` constructor alongside your username and password for MangaDex, as this will be used to authenticate you within the API.
### Contributing
If you would like to contribute to Hondana, please take a look at [the contributing guidelines](./.github/CONTRIBUTING.md) and follow the procedure there.
If you have any question please feel free to join my Discord server:
<div align="left">
<a href="https://discord.gg/aYGYJxwqe5">
<img src="https://discordapp.com/api/guilds/705500489248145459/widget.png?style=banner2" alt="Discord Server"/>
</a>
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/AbstractUmbra/hondana",
"name": "hondana",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "mangadex, manga, api, wrapper",
"author": "Alex N\u00f8rgaard",
"author_email": "umbra@abstractumbra.dev",
"download_url": null,
"platform": null,
"description": "<div align=\"center\">\n <h1 align=\"center\">\n <a href=\"https://jisho.org/word/%E6%9C%AC%E6%A3%9A\">Hondana \u300e\u672c\u68da\u300f</a>\n <br>\n <sub>\n <img src=\".github/assets/md.svg\" height=\"60\">\n </sub>\n </h1>\n <a href='https://github.com/AbstractUmbra/Hondana/actions/workflows/build.yaml'>\n <img src='https://github.com/AbstractUmbra/Hondana/actions/workflows/build.yaml/badge.svg' alt='Build status' />\n </a>\n <a href='https://github.com/AbstractUmbra/Hondana/actions/workflows/coverage_and_lint.yaml'>\n <img src='https://github.com/AbstractUmbra/Hondana/actions/workflows/coverage_and_lint.yaml/badge.svg' alt='Linting and Typechecking' />\n </a>\n</div>\n<div align=\"center\">\n <a href='https://api.mangadex.org/'>\n <img src='https://img.shields.io/website?down_color=red&down_message=offline&label=API%20Status&logo=MangaDex%20API&up_color=lime&up_message=online&url=https%3A%2F%2Fapi.mangadex.org%2Fping' alt='API Status'/>\n </a>\n <a href='https://hondana.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/hondana/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://discord.gg/aYGYJxwqe5\">\n <img src='https://img.shields.io/discord/705500489248145459?color=blue&label=Discord&logo=Discord%20Server&logoColor=green' alt='Discord Server'>\n </a>\n</div>\n<h1></h1>\n<br>\n\nA lightweight and asynchronous wrapper around the [MangaDex v5 API](https://api.mangadex.org/docs.html).\nYou can see our stable docs [here](https://hondana.readthedocs.io/en/stable/)!\n\n---\n\n## Features\n\nWe are currently at 100% feature compliance with the API.\n\n## Examples\n\nPlease take a look at the [examples](./examples/) directory for working examples.\n\n**NOTE**: More examples will follow as the library is developed.\n\n### Current caveats to note\n\n- There are no API endpoints for Artist. It seems they are not differentiated from Author types except in name only.\n - I have separated them logically, but under the hood all Artists are Authors and their `__eq__` reports as such.\n- The tags and report reasons are locally cached since you **must** pass UUIDs to the api (and I do not think you're going to memorize those), there's a convenience method for updating the local cache as `Client.update_tags` and `Client.update_report_reasons` respectively.\n - I have added [an example](./examples/updating_local_tags.py) on how to do the above for tags.\n - To use these tags, you can see an example [here](./examples/search_manga.py#L17-L22).\n- [Settings related endpoints](https://api.mangadex.org/docs.html#operation/get-settings-template) are not currently exposed. I have implemented their documented use, but I do not expect them to currently function.\n - Once this is exposed fully I will implement a richer interface.\n- Currently, if there are any errors in a chapter upload process, the error key does not contain filenames or identifiable information on exactly what file failed upload.\n - This means that I locally compare the succeeded files with the ones missing from the full response payload. The examples have been updated with how to check for an error.\n- Currently, the `Client.my_chapter_read_history` method will not work. It is disabled on MD's side due to an issue they had previously. If/when it is re-introduced the method will remain the same.\n\n### Further information/tidbits\n\n- For a bit more clarity on a Chapter's `readableAt` vs `publishAt`, see [this page](https://api.mangadex.org/docs/dates/#readableat) on the MangaDex docs.\n- A query with the `include_future_updates` bool set to `True` will include chapters that are pending release by scanlation groups on MangaDex, but which may be available on their sites.\n\n### How to request your own personal OAuth2 Client.\n\nFor authentication with `hondana` to work, you'll need to create and request your own personal OAuth2 client within the MangaDex web portal.\nThis can be done [here](https://mangadex.org/settings) (under the \"API Clients\" section).\n\nWithin here you'll want to hit \"Create\":-\n\n\nFill out the relevant name and description of the api client, and hit \"Create\" once again.\n\nThis is currently (as of 10th Nov 2023) still a manual review and approval process by the MangaDex team, so check back regularly to find out if your client is active or still awaiting review.\n\nOnce it is active, you can fetch it's client id and client secret:-\n\n\nYou then pass this information to the `hondana.Client` constructor alongside your username and password for MangaDex, as this will be used to authenticate you within the API.\n\n### Contributing\n\nIf you would like to contribute to Hondana, please take a look at [the contributing guidelines](./.github/CONTRIBUTING.md) and follow the procedure there.\n\nIf you have any question please feel free to join my Discord server:\n\n<div align=\"left\">\n <a href=\"https://discord.gg/aYGYJxwqe5\">\n <img src=\"https://discordapp.com/api/guilds/705500489248145459/widget.png?style=banner2\" alt=\"Discord Server\"/>\n </a>\n</div>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An asynchronous wrapper around the MangaDex v5 API",
"version": "3.5.1",
"project_urls": {
"Discord": "https://discord.gg/aYGYJxwqe5",
"Homepage": "https://github.com/AbstractUmbra/hondana",
"Issue Tracker": "https://github.com/AbstractUmbra/hondana/issues",
"Repository": "https://github.com/AbstractUmbra/hondana"
},
"split_keywords": [
"mangadex",
" manga",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "872ff73dfd67453a27677e199db23c7e03d6aaf7149fd77d5716fb0891dbc0ca",
"md5": "cd8eb4b02dfb8709b2683519118af4e5",
"sha256": "14bd51f875476f7baf971b00e76e7a0e6f18bc6e863bf211032557d6b4893d8e"
},
"downloads": -1,
"filename": "hondana-3.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd8eb4b02dfb8709b2683519118af4e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 139661,
"upload_time": "2024-05-05T14:50:58",
"upload_time_iso_8601": "2024-05-05T14:50:58.144142Z",
"url": "https://files.pythonhosted.org/packages/87/2f/f73dfd67453a27677e199db23c7e03d6aaf7149fd77d5716fb0891dbc0ca/hondana-3.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-05 14:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AbstractUmbra",
"github_project": "hondana",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hondana"
}
JSON
