Changelogs

v1.6.0

• Redesigned the objects

  • Removed BaseObject class

  • Flags object has been renamed to JokeFlags

  • Added language alias for Joke.lang

  • All objects are now frozen dataclasses which means they are now immutable and are read-only.

  • All objects now have proper __repr__ attributes

• Entire library is now properly typehinted. Thanks to @MarzaElise for their contributions in typehinting the library.

• Moved get_safe_joke from utils module to Client and AsyncClient classes. Thanks to @MarzaElise

• Client now works with async context manager. Thanks to @MarzaElise

• AsyncClient now raises a new error UnsupportedUsage on exiting context manager. Thanks to @MarzaElise

• Added support for /weather endpoint. You can now fetch weathers easily using get_weather methods.

  • Added get_weather in both client classes

  • Added four new classes Weather, CurrentWeather, WeatherLocation, WeatherForecast

  • Added new error, InvalidCityError raised upon invalid city provided in get_weather method.

Version 1.5 were minor versions

v1.4.2

• Restructured the library's data classes

  • All the data classes now inherit from a super class called BaseObject

  • AI response now is wrapped into a class called AIResponse to stay even with new responses from version 4 AI response endpoint.

• Restructured the Exceptions hierarchy

  • New Exception sub class: HTTPError for 500s errors. Credits to @Creepy-Creeper3625

  • Added new Exception sub class: ArgumentError.

  • VersionError,PlanError and ServerError are changed to InvalidVersionError ,InvalidPlanError and InvalidServerError that are now inherited from ArgumentError.

  • Added Exception class: Forbidden

  • Added two sub-classes of Forbidden: PlanNotAllowed and BadAPIKey

• Restructured library files

  • All data classes are now in a single module object

• AsyncClient now has proper default version. (GH-7)

• utils.generate_unique_id now is called generate_uid (As per version 4.) (GH-8)

• Added errors.HTTPError class for 500s statuses. (GH-6)

• AsyncClient now properly inherits from Client (GH-9)

• Added utils.format_joke method to format a "two-part" joke into custom (human readable) format.

• Added utils.get_safe_joke method to filter or ignore any unsafe joke.

• Warnings now have certain colours using Unicode. Credits to @Creepy-Creeper3625

v1.4.0

• Deprecated version 2 of API

• Added support for version 4

• Version 3 usage now triggers console warnings

• AI method now uses kwargs due to change in parameters for version 4 and 3.

v1.3.2

• Added initial support for v4 beta

• get_ai_response_beta() argument added with different parameters names as default method. This is use able only with v4 beta. See this

• get_joke methods in both Client and AsyncClient classes now return correct link.

• Warning added for v4 beta.

v1.3.1

• Added support for unique_key query on /ai/response.

• get_ai_response() take optional argument unique_id which is used to chat with a certain key. See Unique Key page for more info.

• New module randomstuff.utils

• utils.generate_unique_id is a new method used to generate secure unique IDs.

v1.3.0

• Added support for bot_name and dev_name queries on /ai/response.

• get_ai_response() take optional arguments dev_name and bot_name which determines developer name and bot name respectively.

• Added warnings.

• You are now warned when initialising client with version='2'.

• Add suppress_warnings optional argument in clients that determines whether you get console warnings or not.

v1.2.2

• All methods and classes now raise errors.AuthError when invalid API key is passed.

• Same for unauthorised plan in get_ai_response()

v1.2.1

• get_joke() works properly now.

v1.2.0

• Add support for v2

• Client and AsyncClient now take version argument that determines the API version

• Added support for plans

• get_ai_response() now takes plan argument which determines the plan to use.

v1.0.2

• Fixed minor bugs

v1.0.1

• Initial Release