Skip to content
This repository has been archived by the owner on Nov 5, 2023. It is now read-only.

v1.1.0 Minor Release
Compare
Choose a tag to compare
@CosmicHorrorDev CosmicHorrorDev released this 24 May 02:15
· 99 commits to master since this release
v1.1.0
225efd2

Breaking Changes

  • (#37) All the .from_data(...) constructors now just take the raw data instead of filename and dirname too
  • (#36) The ranking functions now take library objects instead of the raw data, so rank_search_subtitles now takes a list of SearchResults and rank_guess_media takes the new GuessMediaResult
  • (#47) Media and MediaInfo's filename and dirname are both private now. They now include getters and setters if you want to take a look at the docs. This was done because they're assumed to be pathlib.Paths, but the user may want to pass in any pathlike value
  • (#42) .report_move(...) was renamed to .report_media(...) to match the media agnostic tone of the rest of the library

New Features

  • (#40) ranking module was made public since the different ranking functions make good fallbacks for custom ranking functions
  • (#41) Several endpoints dealing with subtitles related actions can now take SubtitlesInfo objects along with SearchResults
  • (#43) report_media now raises a ValueError when it's used with a SearchResult that wasn't found using the filehash and size
  • (#34) search_subtitles and guess_media now have unranked variants that directly return a list of SearchResults and GuessMediaResults for each query respectively
  • (#45) .search_subtitles(...) can now take queries as a zip too which works well for giving the desired language codes
  • (2f9ffde) atomicwrites is now included as an optional dependency to allow for saving subtitles atomically
  • (2d670be) the library now aggressively checks for wrong types and tries to return information on the allowed types

Bugfixes

  • (#46) .guess_media(...) previously had some weird edge-cases that would throw an obscure error (searching for "", or something with no results like "asdkfjldsflgskdmfkl"). Now the library handles these cases and the ranked version returns None while the unranked variant gets GuessMediaResult with no data (full of None and empty lists)

Documentation

  • (#39) More advanced examples were added to show a more featureful quickstart and more robust searching

Misc.

  • (93f6df3) Added a PR template
  • (#33) Releases are now automatically published to pypi when a new release tag is pushed to the repo
Assets 2