3.3.0

API Version 5.7.1

Hondana Changelog

Fix release and new features.

Added

Added a new user friendly way to submit reports to MangaDex. (9885597 and 4ba8599)

• Included a new local cache of the report reasons which are loaded as an enum.
• Included a new example for using the report method.
  Removed Client.get_report_reason_list() public method as this was not user friendly or utilised. (820a8d6)

Changes

Removed preflight items from within the exposed source code to a private part of local CI. (80f2229)
New batch of test payloads as the previous iterations had broken data with no resolution in sight. (1e732e3)

Fixes

Fixed Artist and Author's .biography property from being incorrectly accessed if the "en" key did not exist and relevant tests for such. (1e732e3)
Fix the internal HTTPClient type being accessed at runtime unnecessarily. (3e62a29)

Notes

Deprecation of Client.mark_chapter_as_read() and Client.mark_chapter_as_unread() in favour of Client.batch_update_manga_read_markers(). (5b6070b)

Noted Contributors

3.2.0

API Version 5.7.1

Hondana Changelog

Update to remove singular updates to (un)read markers on chapters.
This just means you must use the batch endpoint. This is noted within Hondana as Client.batch_update_manga_read_markers.
Chapter.mark_as_read() and Chapter.mark_as_unread() both now use the batch endpoint internallt.

Added

Manga.latest_uploaded_chapter attribute has been added. (2407d39)

Changes

Deprecation of Client.mark_chapter_as_read() and Client.mark_chapter_as_unread() in favour of Client.batch_update_manga_read_markers(). (5b6070b)
Rename Chapter.mark_chapter_as_unread() to Chapter.mark_as_unread(). (3b20a56)

Fixes

Fixed the handling of Tag.description as it was previously marked as the incorrect type. Handling it correctly and accouting for PHP empty-object-isms. (a2b8469)

Notes

Noted Contributors

3.1.0

API Version 5.6.1

Hondana Changelog

Mostly a documentation update, but one minor change with version parameters.

Added

Changes

• Removed Client.create_settings_template as this will be a MandaDex admin/staff only endpoint. (078dcad)
• Updated documentation for Client.delete_user. (715092d)
• Removed useless captcha handling from HTTP request flow. (ba236cd)
  • This actually cannot be done via 3rd party applications, period.
• Updated documentation for Client.recover_account. (0057b6a)
• Updated documentation for Client.get_at_home_url. (9dcbe5e)
• Removed the version parameter for creation endpoints, as this was ignored on MD's side as it is not supposed to be provided by the user. (3fefb07)
• Add some clarity around publish_at in the documentation. (ccd3f4d)
• Add small informational relating to the include_future_updates boolean in feed endpoints. (c077f93)
• Add note about Client.my_chapter_read_history. (673d344)

Fixes

Notes

• Most changes in this version has been based on information from MangaDex staff themselves, listed below.

Noted Contributors

@Tristan971 for their feedback on the library and helping clear up some documentation and knowledge inconsistencies.

3.0.5

API Version 5.6.0

Hondana Changelog

Added

• hondana.query.MangaListOrderQuery now supports rating as an option. (1672cbe)
• hondana.MangaStatitics.bayesian has been added as it is now offered by MangaDex. (4a48998)

Changes

• HTTPClient._get_token now raises AuthenticationRequired instead of ValueError when no auth is set.

Fixes

Notes

Noted Contributors

3.0.4

API Version 5.5.10

Hondana Changelog

Added

• Client.my_chapter_read_history() method to return the current logged in user's read history as a rich type. Also adds necessary payloads and helper objects. (8e9c004)
• Add update_history parameter to Client.mark_chapter_as_read() and Chapter.mark_as_read(), adds a default of True so it is not breaking. (371a1e9)

Changes

• types.LocalisedString has been removed in favour of the already existing types.LocalizedString. (c1b51f9)
• Author.biography and Artist.biography were reworked as they are localised. Also added the localized_biography method. (681ee6f)

Fixes

• Add a mutex/lock around the token generation at login/re-auth stages. Fixes a rare occurrence of doubly generating tokens with asynchronous requests. (8989537)
• Fix incorrect types in Author/Artist biographies when the data is empty. Thanks PHP. (80b1aa4)
• Fix library __repr__ and __str__ methods be all uniform. (c44b9ed)

Notes

• The types submodule has been reworked to not have all items imported at the top level to avoid namespace clutter. (3ff4ff5)
  • This means that hondana.types.MangaResponse should now be hondana.types.manga.MangaResponse.

Noted Contributors

3.0.3

API Version 5.5.8!

Hondana Changelog

Added

Changes

• Client.get_chapter has a new key word argument fetch_full_manga, as the Manga relationship has no relationships of it's own, so details are not present without another HTTP request. (390d47a)
• Manga.cover_url method's parameter was renamed from type to size to avoid a rare issue due to a reserved keyword. (26a39c2)
• Large documentation overhaul, which enabled type-hint signatures. This seems like overkill in most scenarios but it can help resolve types and defaults in the documentation. (daa063e)
  • More changes are intended, however I am waiting on a bug in Sphinx to be fixed before these can be done.
• Also added the documentation capability of showing the source code from the docs pages. (39e3283)
• Allow user code to pass a custom sorting key to ChapterUpload.upload_images. (9a209e6)

Fixes

• The underlying HTTP request method did not handle HTTP 503 errors from MangaDex, which are common when a cache lookup fails and the endpoint needs to be re-hit. This was fixed in #28. (f1a79e5)
• LegacyItem's __repr__ displayed incorrect names for the attributes, this has been fixed. (17b7a73)
• Cleaned up the internal sorting method for chapter upload and removed an unneeded regex. (6264e51)
• Added missing includes parameter on CustomList Manga Feed. (b3bbce0)

Notes

Version 3.0.2 had a bad push cycle so was immediately deprecated and removed from GH and PyPi.

Noted Contributors

@PythonCoderAS - Fixing common errors HTTP error handling.

3.0.1

API Version 5.5.8!

Hondana Changelog

Added

Changes

• ChapterUpload.upload_images' sort functionality has been extended to support more filename formats, and documentation has been added. (8a7d06d and d5aba0f)

Fixes

• Manga.update was missing a documentation entry for the primary_cover parameter, this has been added. (8ae9f16)

Notes

Noted Contributors

@Axelancerr - For more typo fixes and code optimizations.

3.0.0

API Version 5.5.8!

Hondana Changelog

Added

• hondana.UploadData was added as the return type for ChapterUpload.upload_images to provide more access to error and success information. (99a7a37)

Changes

• BREAKING: Client.view_manga has been removed in favour of Client.get_manga. (256a0a0)
• BREAKING: ChapterUpload.upload_images, and Client.upload_chapter now take pathlib.Path objects instead of raw bytes due to requiring access to the filenames for error checking. (99a7a37)

Fixes

• Internal types fixes to comply with proper practice and pyright usage. (39e317b)
• Docs fixes. (27d8312)

Notes

Noted Contributors

2.2.2

API Version 5.5.8!

Hondana Changelog

Added

• Added a depreacted utility decorator for use in deprecated methods. (14a7db9)
• end key-word argument in Chapter.download for the ability to download select pages. (4cdc304)
• Chapter.download_bytes for downloading chapter images and yielding the raw bytes, rather than dumping to a file. (4cdc304)
• Add capability to edit chapters with ChapterUpload and all helper methods. (97689c8)

Changes

• GitHub actions have been improved to use newer versions and caching where necessary. (d379cba and 81d8427)

Fixes

• Internal utility fixes for the relationship parsing utility. (3c60835 and b11fc4f)
• Fixes title and volume parameters of Client.upload_session as they should have been optional. (12d1cf4 and 5d0dfe3)
  • Also fixed a bug in the chapter upload process thanks to incorrect documentation. (12d1cf4)

Notes

• Client.view_manga is marked as deprecated and due for removal in version 3.0 in favour of Client.get_manga.
• I have tested the upload capabilities as best I can using the official test manga.

Noted Contributors

@PythonCoderAS - For working on 4cdc304 and improving the library.

2.2.1

API Version 5.5.8!

Hondana Changelog

Added

• Client.get_my_custom_list_follows() method was added to get all of the custom lists you follow. (44d6374)
• Client.check_if_following_custom_list() method was added to check if you currentlt follow a specific custom list. (44d6374)
• Client.follow_custom_list() and CustomList.follow() methods were added to allow you to follow a custom list. (44d6374)
• Client.unfollow_custom_list() and CustomList.unfollow() methods were added to allow you to unfollow a custom list. (44d6374)

Changes

• ChapterUpload will now raise ValueError on initialisation if you try to provide more than 10 scanlator groups per upload. (5861a32)
• Added optional [speedup] extra to the library install to add orjson as a dependency for faster json payload parsing. (96507e0)
• Removed the dependency for aiofiles as the overhead was rather unnecessary in testing. (fe9501a)

Fixes

Notes

• Client.view_manga is marked as deprecated and due for removal in version 3.0 in favour of Client.get_manga.

Noted Contributors