Support for /canvas (#27)

* Rename files with _ in their name to -

* Enable color theme switching

* Fixed typo

RSA API is wrong since the A in RSA stands of "API" so I changed it to
Random Stuff API

* Change latest version to 5

* Remove `self` from example

self was not needed and would raise error when trying to run it

* Fix typo

* Code formatting | Removed unnecessary code

* Format file

* Add image method constants

* Remove kiss from ONE_IMAGE_METHODS

* add ALL_METHODS constant

* Format file

* Rename FOUR_IMAGE_METHODS to TEXT_METHODS

* Helper functions to validate required image/text

* Update gitignore

* Support for /canvas endpoint

* Split stuff into functions

* Code formatting

* Async support for /canvas endpoint

* Format code with black

Author: MarzaElise

.gitignore

@@ -137,4 +137,5 @@ tests
 test.bat
 
 # useless files
-delete.md
+delete.*
+test.*

docs/docs/getting_started.md renamed to docs/docs/getting-started.md

@@ -37,12 +37,12 @@ Some other methods are:
 ## Async usage
 This library also supports async usage to use in asynchrounous enivornments.
 
-For async usage, We use [`AsyncClient`](sections/clients/async_client.md) class which is an async version of `Client` class.
+For async usage, We use [`AsyncClient`](sections/clients/async-client.md) class which is an async version of `Client` class.
 ```py
 import randomstuff
 import asyncio
 
-async def coro(self):
+async def coro():
     async with randomstuff.AsyncClient(api_key="api-key") as client:
         response = await client.get_ai_response('Hi there.')
         print(response.message)
@@ -52,4 +52,4 @@ loop.run_until_complete(coro())
 ```
 
 !!! info "Information"
-    This class is exactly same as Client class except all methods are coroutine and asynchrounous. By similar, We mean that all methods have the same name.
+    This class is exactly same as Client class except all methods are coroutine and asynchrounous. By similar, We mean that all methods have the same name.

docs/docs/index.md

@@ -1,13 +1,13 @@
 # Welcome to randomstuff.py
 
-An easy to use and pythonic API wrapper around Random Stuff API. 
+An easy to use and pythonic API wrapper around Random Stuff API.
 
 ## Features
 
 * Easy to use, Organized & Object oriented design
 * Wraps entire API including version 3 and 4
 * Feature rich, Decent errors handling
-* Up-to-date — Always kept up-to-date with latest updates 
+* Up-to-date — Always kept up-to-date with latest updates
 
 !!! info "Get Started"
-    Please see the [Get Started](getting_started.md) page to see examples to quickly get started.
+    Please see the [Get Started](getting-started.md) page to see examples to quickly get started.

docs/docs/sections/clients/async_client.md renamed to docs/docs/sections/clients/async-client.md

@@ -3,7 +3,7 @@
 The main client class to make API calls.
 
 !!! warning "Non-async class"
-    All functions in this class are blocking meaning they are not suitable for async programs like Discord bots etc. Please have a look at [`AsyncClient`](async_client.md)
+    All functions in this class are blocking meaning they are not suitable for async programs like Discord bots etc. Please have a look at [`AsyncClient`](async-client.md)
 
 === "Parameters/Attributes"
 
@@ -43,7 +43,7 @@ The main client class to make API calls.
             | `server`    | The [AI server](../topics/lists.md#ai-servers) to use. Default is `primary`.  | Optional[`str`] |
             | `master`    | The bot's master AKA creator, This is used in responses. | Optional[`str`] |
             | `bot`    | The bot's name, This is used in responses. | Optional[`str`] |
-            | `uid`    | The [Unique ID](../topics/unique_id.md) to use. | Optional[`str`] |
+            | `uid`    | The [Unique ID](../topics/unique-id.md) to use. | Optional[`str`] |
 
 
         === "Parameters (Version 3)"
@@ -55,10 +55,10 @@ The main client class to make API calls.
             | `type`    | The type of AI response. Either `stable` or `unstable`  | Optional[`str`] |
             | `dev_name`    | The bot's dev AKA creator, This is used in responses. | Optional[`str`] |
             | `bot_name`    | The bot's name, This is used in responses. | Optional[`str`] |
-            | `unqiue_id`    | The [Unique ID](../topics/unique_id.md) to use. | Optional[`str`] |
+            | `unqiue_id`    | The [Unique ID](../topics/unique-id.md) to use. | Optional[`str`] |
 
         === "Returns"
-            - [`AIResponse`](../data_classes/ai_response.md) : The obtained response.
+            - [`AIResponse`](../data-classes/ai-response.md) : The obtained response.
 
     * ### **`get_image(type: str = 'any')`**
 
@@ -140,4 +140,4 @@ The main client class to make API calls.
             with Client(...) as client:
                 # do things here
             ``` 
-            as soon as with block ends, The session is closed.
+            as soon as with block ends, The session is closed.

docs/docs/sections/clients/client.md

@@ -14,4 +14,4 @@ Represents the response returned in `Client.get_ai_response()` method.
     | `server`    | The [AI server](../topics/lists.md#ai-servers) to use. Default is `primary`.  | Optional[`str`] |
     | `master`    | The bot's master AKA creator, This is used in responses. | Optional[`str`] |
     | `bot`    | The bot's name, This is used in responses. | Optional[`str`] |
-    | `uid`    | The [Unique ID](../topics/unique_id.md) to use. | Optional[`str`] |
+    | `uid`    | The [Unique ID](../topics/unique-id.md) to use. | Optional[`str`] |

docs/docs/sections/data_classes/ai_response.md renamed to docs/docs/sections/data-classes/ai-response.md

@@ -1,2 +1,2 @@
 # `Forbidden`
-Represents 403 & 401 responses returned by RSA API, Usually raised upon forbidden plans or missing API keys.
+Represents 403 & 401 responses returned by Random Stuff API, Usually raised upon forbidden plans or missing API keys.

docs/docs/sections/data_classes/current_weather.md renamed to docs/docs/sections/data-classes/current-weather.md

@@ -5,7 +5,7 @@ These are some questions that you might have, If your question is not here, Join
 [https://api-info.pgamerx.com/register](https://api-info.pgamerx.com/register) | Steps are pretty straight forward.
 
 ### What version of API should I be using?
-The latest version is always the best. Currently latest version is version 4. To use the latest version, Simply remove `version` kwarg from your Client instance.
+The latest version is always the best. Currently latest version is version 5. To use the latest version, Simply remove `version` kwarg from your Client instance.
 
 ### Why do I get `PlanNotAllowed` error on `get_joke()`, `get_image()` etc. method when I have a plan?
 Plans are only supported in following methods:
@@ -19,4 +19,4 @@ To use the other methods, You will have to use normal API key (API key with no p
 All objects are frozen dataclasses meaning their attributes cannot be changed.
 
 ### What is unique ID?
-Please see the [Unique ID](unique_id.md) page.
+Please see the [Unique ID](unique-id.md) page.

docs/docs/sections/data_classes/index.md renamed to docs/docs/sections/data-classes/index.md

@@ -2,7 +2,7 @@ site_name: randomstuff.py
 theme:
   name: material
   palette:
-    - accent: green
+    # - accent: green # setting this disables color theme switching for some reason
     - scheme: default
       toggle:
         icon: material/lightbulb
@@ -31,32 +31,32 @@ theme:
 nav:
   - Home:
     - Introduction: index.md
-    - Getting Started: getting_started.md
+    - Getting Started: getting-started.md
 
   - Clients:
     - Client: sections/clients/client.md
-    - AsyncClient: sections/clients/async_client.md
+    - AsyncClient: sections/clients/async-client.md
 
   - Data Classes:
-    - Home: sections/data_classes/index.md
-    - AIResponse: sections/data_classes/ai_response.md
-    - Joke: sections/data_classes/joke.md
-    - JokeFlags: sections/data_classes/joke_flags.md
-    - Waifu: sections/data_classes/waifu.md
-    - Weather: sections/data_classes/weather.md
-    - WeatherLocation: sections/data_classes/weather_location.md
-    - WeatherForecast: sections/data_classes/weather_forecast.md
-    - CurrentWeather: sections/data_classes/current_weather.md
+    - Home: sections/data-classes/index.md
+    - AIResponse: sections/data-classes/ai-response.md
+    - Joke: sections/data-classes/joke.md
+    - JokeFlags: sections/data-classes/joke-flags.md
+    - Waifu: sections/data-classes/waifu.md
+    - Weather: sections/data-classes/weather.md
+    - WeatherLocation: sections/data-classes/weather-location.md
+    - WeatherForecast: sections/data-classes/weather-forecast.md
+    - CurrentWeather: sections/data-classes/current-weather.md
 
   - Errors:
     - Home: sections/errors/index.md
     - Forbidden: sections/errors/forbidden.md
-    - BadAPIKey: sections/errors/bad_api_key.md
-    - PlanNotAllowed: sections/errors/plan_not_allowed.md
-    - ArgumentError: sections/errors/argument_error.md
-    - UnknownArgument: sections/errors/unknown_argument.md
-    - BadArgument: sections/errors/bad_argument.md
-    - HTTPError: sections/errors/http_error.md
+    - BadAPIKey: sections/errors/bad-api-key.md
+    - PlanNotAllowed: sections/errors/plan-not-allowed.md
+    - ArgumentError: sections/errors/argument-error.md
+    - UnknownArgument: sections/errors/unknown-argument.md
+    - BadArgument: sections/errors/bad-argument.md
+    - HTTPError: sections/errors/http-error.md
 
   - Submodules:
     - utils: sections/submodules/utils.md
@@ -65,10 +65,10 @@ nav:
     - FAQ: sections/topics/faq.md
     - Warnings: sections/topics/warnings.md
     - Lists: sections/topics/lists.md
-    - Unique ID: sections/topics/unique_id.md
+    - Unique ID: sections/topics/unique-id.md
 
   - What's new?:
-    - What's new: sections/whats_new.md
+    - What's new: sections/whats-new.md
 
 extra:
   homepage: https://github.com/nerdguyahmad/randomstuff.py

docs/docs/sections/data_classes/joke.md renamed to docs/docs/sections/data-classes/joke-flags.md

@@ -5,19 +5,31 @@
 """
 import randomstuff
 
-with randomstuff.Client(key="api-key-here") as client: # Input the API key that has the paid plan. Please note that you cannot use plans with version 2 of API!
-  """Below are examples for all the plans choose the one for the plan you have"""
-  response = client.get_ai_response(message="The message", plan='') # No plan (Normal aka Free)
-  print(response.message)
+with randomstuff.Client(
+    key="api-key-here"
+) as client:  # Input the API key that has the paid plan. Please note that you cannot use plans with version 2 of API!
+    """Below are examples for all the plans choose the one for the plan you have"""
+    response = client.get_ai_response(
+        message="The message", plan=""
+    )  # No plan (Normal aka Free)
+    print(response.message)
 
-  response = client.get_ai_response(message="The message", plan="pro") # Pro plan
-  print(response.message)
+    response = client.get_ai_response(
+        message="The message", plan="pro"
+    )  # Pro plan
+    print(response.message)
 
-  response = client.get_ai_response(message="The message", plan="ultra") # Ultra plan
-  print(response.message)
+    response = client.get_ai_response(
+        message="The message", plan="ultra"
+    )  # Ultra plan
+    print(response.message)
 
-  response = client.get_ai_response(message="The message", plan="biz") # Biz plan
-  print(response.message)
+    response = client.get_ai_response(
+        message="The message", plan="biz"
+    )  # Biz plan
+    print(response.message)
 
-  response = client.get_ai_response(message="The message", plan="mega") # Mega plan
-  print(response.message)
+    response = client.get_ai_response(
+        message="The message", plan="mega"
+    )  # Mega plan
+    print(response.message)

docs/docs/sections/data_classes/joke_flags.md renamed to docs/docs/sections/data-classes/joke.md

@@ -1,10 +1,12 @@
 import randomstuff
 import asyncio
 
+
 async def coro():
-  async with randomstuff.AsyncClient(api_key="key") as client:
-    response = await client.get_ai_response("Hello world")
-    print(response.message)
+    async with randomstuff.AsyncClient(api_key="key") as client:
+        response = await client.get_ai_response("Hello world")
+        print(response.message)
+
 
 loop = asyncio.get_event_loop()
 loop.run_until_complete(coro())

docs/docs/sections/data_classes/waifu.md renamed to docs/docs/sections/data-classes/waifu.md

@@ -6,4 +6,6 @@
 import randomstuff
 
 with randomstuff.Client(key="api-key-here") as client:
-  client.get_ai_response(message="Hi", server="primary") # Pass in type in server argument. Choose from `primary`, `backup` and `unstable`.
+    client.get_ai_response(
+        message="Hi", server="primary"
+    )  # Pass in type in server argument. Choose from `primary`, `backup` and `unstable`.

docs/docs/sections/data_classes/weather.md renamed to docs/docs/sections/data-classes/weather-forecast.md

@@ -8,7 +8,9 @@
 """
 import randomstuff
 
-with randomstuff.Client(key="api-key-here", version="4") as client: # Pass in API version in version argument. Choose one from 2 or 3 or 4 (v4 is beta).
+with randomstuff.Client(
+    key="api-key-here", version="4"
+) as client:  # Pass in API version in version argument. Choose one from 2 or 3 or 4 (v4 is beta).
 
-  """Put your rest of code here. You have to change nothing when changing API versions. Wrapper deals with that itself."""
-  ...
+    """Put your rest of code here. You have to change nothing when changing API versions. Wrapper deals with that itself."""
+    ...

docs/docs/sections/data_classes/weather_forecast.md renamed to docs/docs/sections/data-classes/weather-location.md

@@ -2,19 +2,39 @@
 
 with randomstuff.Client(key="api-key") as client:
 
-  joke = client.get_joke(type="any") # Available joke types: ('pun', 'spooky', 'dev', 'any')
+    joke = client.get_joke(
+        type="any"
+    )  # Available joke types: ('pun', 'spooky', 'dev', 'any')
 
-  print("Category: ", joke.category) # The category of the joke.
-  print("Joke Type: ", joke.type) # The type of joke, Can either be `single` or `twopart`.
-  print("Joke: ", joke.joke) # Actual joke. , if the joke type is single, This is a string otherwise it is a dictionary with two keys "setup" and "delivery".
-  print("ID: ", joke.id) # The joke's ID. Every joke has a unique ID.
-  print("Safe: ", joke.safe) # Determines if the joke is safe or not. If this is `True`, the joke is safe.
-  print("Language: ", joke.lang) # The language of joke.
+    print("Category: ", joke.category)  # The category of the joke.
+    print(
+        "Joke Type: ", joke.type
+    )  # The type of joke, Can either be `single` or `twopart`.
+    print(
+        "Joke: ", joke.joke
+    )  # Actual joke. , if the joke type is single, This is a string otherwise it is a dictionary with two keys "setup" and "delivery".
+    print("ID: ", joke.id)  # The joke's ID. Every joke has a unique ID.
+    print(
+        "Safe: ", joke.safe
+    )  # Determines if the joke is safe or not. If this is `True`, the joke is safe.
+    print("Language: ", joke.lang)  # The language of joke.
 
-  print("\n=== Flags ===\n")
-  print("NSFW: ", joke.flags.nsfw) # Determines if the joke is NSFW or not. If this is `True`, The joke is NSFW.
-  print("Religious: ", joke.flags.religious) # Determines if the joke is religious or not. If this is `True`, The joke is religious.
-  print("Political: ", joke.flags.political) # Determines if the joke is political or not. If this is `True`, The joke is political.
-  print("Racist: ", joke.flags.racist) # Determines if the joke is racist or not. If this is `True`, The joke is racist.
-  print("Sexist: ", joke.flags.sexist) # Determines if the joke is sexist or not. If this is `True`, The joke is sexist. 
-  print("Explicit: ", joke.flags.explicit) # Determines if the joke is explicit or not. If this is `True`, The joke is explicit.
+    print("\n=== Flags ===\n")
+    print(
+        "NSFW: ", joke.flags.nsfw
+    )  # Determines if the joke is NSFW or not. If this is `True`, The joke is NSFW.
+    print(
+        "Religious: ", joke.flags.religious
+    )  # Determines if the joke is religious or not. If this is `True`, The joke is religious.
+    print(
+        "Political: ", joke.flags.political
+    )  # Determines if the joke is political or not. If this is `True`, The joke is political.
+    print(
+        "Racist: ", joke.flags.racist
+    )  # Determines if the joke is racist or not. If this is `True`, The joke is racist.
+    print(
+        "Sexist: ", joke.flags.sexist
+    )  # Determines if the joke is sexist or not. If this is `True`, The joke is sexist.
+    print(
+        "Explicit: ", joke.flags.explicit
+    )  # Determines if the joke is explicit or not. If this is `True`, The joke is explicit.

docs/docs/sections/data_classes/weather_location.md renamed to docs/docs/sections/data-classes/weather.md

@@ -14,16 +14,18 @@
 from .errors import *
 from .joke import *
 from .waifu import *
+
 # To use randomstuff.utils module import it manually.
 
-__title__ = 'randomstuff.py'
-__summary__ = 'An easy to use and feature rich wrapper for Random Stuff API'
-__uri__ = 'https://github.com/nerdguyahmad/randomstuff.py'
-__email__ = '[email protected]'
-__author__ = 'nerdguyahmad'
-__version__ = '2.0.0a'
-__license__ = 'MIT'
-__copyright__ = '2021-present nerdguyahmad.'
+__title__ = "randomstuff.py"
+__summary__ = "An easy to use and feature rich wrapper for Random Stuff API"
+__uri__ = "https://github.com/nerdguyahmad/randomstuff.py"
+__email__ = "[email protected]"
+__author__ = "nerdguyahmad"
+__version__ = "2.0.0a"
+__license__ = "MIT"
+__copyright__ = "2021-present nerdguyahmad."
+
 
 def get_version():
-	return __version__
+    return __version__