formatting, cleanup and version bump

Author: AbstractUmbra

mystbin/__init__.py

@@ -27,6 +27,8 @@
 from .client import MystbinClient
 from .errors import *
 
-__version__ = "0.3.2"
-VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel serial")
-version_info = VersionInfo(major=0, minor=3, micro=1, releaselevel='final', serial=0)
+__version__ = "0.3.3"
+VersionInfo = namedtuple(
+    "VersionInfo", "major minor micro releaselevel serial")
+version_info = VersionInfo(major=0, minor=3, micro=3,
+                           releaselevel='final', serial=0)

mystbin/__main__.py

@@ -28,6 +28,7 @@
 
 import aiohttp
 import pkg_resources
+
 try:
     import requests
 except ImportError:

mystbin/client.py

@@ -27,6 +27,7 @@
 from typing import TYPE_CHECKING, Awaitable, Callable, Optional, Type, Union
 
 import aiohttp
+
 if TYPE_CHECKING:
     import requests
 
@@ -85,7 +86,7 @@ def post(self, content: str, syntax: str = None) -> Union[Paste, Awaitable]:
         This will post to the Mystb.in API and return the url.
         Can pass an optional suffix for the syntax highlighting.
 
-        Attributes
+        Parameters
         ----------
         content: :class:`str`
             The content you are posting to the Mystb.in API.
@@ -131,7 +132,7 @@ def get(self, paste_id: str) -> Union[PasteData, Awaitable]:
         This will perform a GET request against the Mystb.in API and return the url.
         Must be passed a valid paste ID or URL.
 
-        Attributes
+        Parameters
         ----------
         paste_id: :class:`str`
             The ID of the paste you are going to retrieve.

mystbin/constants.py

@@ -24,6 +24,8 @@
 
 from re import compile
 
+__all__ = ("API_BASE_URL", "PASTE_BASE", "CLIENT_TIMEOUT", "MB_URL_RE")
+
 API_BASE_URL = "https://mystb.in/api/pastes"
 PASTE_BASE = "https://mystb.in/{}{}"
 

mystbin/errors.py

@@ -22,13 +22,17 @@
 DEALINGS IN THE SOFTWARE.
 """
 
+__all__ = ("APIError", "BadPasteID")
+
 
 class BadPasteID(ValueError):
     """ Bad Paste ID. """
 
+
 class MystbinException(Exception):
     """ Error when interacting with Mystbin. """
 
+
 class APIError(MystbinException):
     """
     Exception relationg to the API of Mystbin.

mystbin/objects.py

@@ -27,11 +27,12 @@
 
 from .constants import PASTE_BASE
 
+
 class Paste:
     """
     A class representing the return data from the API after performing a POST request.
 
-    Parameters
+    Attributes
     ----------
     paste_id: :class:`str`
         The ID returned from the API. Genertally it is 3 random choice English words.
@@ -72,11 +73,12 @@ def with_syntax(self, new_syntax: str) -> str:
         new_syntax = f".{new_syntax}" if new_syntax else None
         return PASTE_BASE.format(self.paste_id, new_syntax)
 
+
 class PasteData:
     """
     A class representing the return data from the API after performing a GET request.
 
-    Parameters
+    Attributes
     ----------
     paste_id: :class:`str`
         The ID you wish to retrieve from the API.
@@ -89,7 +91,10 @@ class PasteData:
     paste_date: :class:`datetime.datetime`
         The date this paste was created on the API.
     """
-    __slots__ = ("paste_id", "_paste_data", "paste_content", "paste_syntax", "paste_nick", "paste_date")
+
+    __slots__ = ("paste_id", "_paste_data", "paste_content",
+                 "paste_syntax", "paste_nick", "paste_date")
+
     def __init__(self, paste_id: str, paste_data: dict):
         self.paste_id = paste_id
         self._paste_data = paste_data
@@ -119,4 +124,3 @@ def created_at(self) -> datetime.datetime:
     def content(self) -> str:
         """ :class:`str`: Return the paste content but dedented correctly. """
         return dedent(self.paste_content)
-

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mystbin.py"
-version = "0.3.2"
+version = "0.3.3"
 description = "A small simple wrapper around the mystb.in API."
 authors = ["AbstractUmbra <Umbra@AbstractUmbra.xyz>"]
 license = "MIT"