v5 prep

Author: AbstractUmbra

.github/workflows/build.yaml

@@ -19,33 +19,35 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [ 3.9 ]
+        python-version: [ "3.9", "3.10" ]
 
     steps:
       - name: Checkout source
         uses: actions/checkout@v2
 
-      - name: Set up Python
+      - name: "Set up Python ${{ matrix.python-version }}"
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Set up Poetry
-        uses: Gr1N/setup-poetry@v4
+      - name: "Set up Poetry ${{ matrix.python-version }}"
+        uses: Gr1N/setup-poetry@v7
+        with:
+          poetry-preview: true
 
-      - name: Install Python deps
+      - name: "Install Python deps ${{ matrix.python-version }}"
         run: |
-          poetry install -E requests --no-dev
+          poetry install --all-extras
 
-      - name: Check it imports
+      - name: "Check it imports ${{ matrix.python-version }}"
         run: |
           poetry run python -c 'import mystbin'
 
-      - name: Build wheels
+      - name: "Build wheels ${{ matrix.python-version }}"
         run: |
           poetry build
 
-      - name: Upload artifacts
+      - name: "Upload artifacts ${{ matrix.python-version }}"
         uses: actions/upload-artifact@v2
         with:
           name: distributions
@@ -72,7 +74,9 @@ jobs:
           path: dist
 
       - name: Set up Poetry
-        uses: Gr1N/setup-poetry@v4
+        uses: Gr1N/setup-poetry@v7
+        with:
+          poetry-preview: true
 
       - name: Publish to PyPI
         env:

.gitignore

@@ -6,3 +6,4 @@ __pycache__/
 /*.egg-info/
 docs/build
 docs/_static/
+*.ipynb

README.md

@@ -13,16 +13,17 @@
 <br>
 
 A small simple wrapper around the [MystB.in](https://mystb.in/) API.
+API docs can be found [here](https://api.mystb.in/docs).
 ----------
 ### Features
 
-- [x] - `POST`ing to the API, which will return the provided url.
-- [x] - `GET`ting from the API, provided you know the URL or paste ID.
-- [ ] - `DELETE`ing from the API, provided the paste is attached to your account.
-- [ ] - `PATCH`ing to the API, provided the paste is attached to your account.
-- [x] - Ability to pass in a sync or async session / parameter so it is flexible.
-- [x] - Write a real underlying Client for this, it will be required for...
-- [ ] - ... Authorization. Awaiting the API making this public as it is still WIP.
+- [x] - Creating pastes.
+- [x] - Editing pastes.
+- [x] - Deleting pastes.
+- [x] - Getting pastes.
+- [ ] - User endpoints.
+- [ ] - Sync client.
+  - This one will take some time as I have no motivation to do it, but PRs are welcome if others want to do it.
 
 ### Installation
 This project will be on [PyPI](https://pypi.org/project/mystbin.py/) as a stable release, you can always find that there.

docs/client.rst

@@ -4,17 +4,17 @@ API Reference
 .. currentmodule:: mystbin
 
 Client
-------
+-------
 .. autoclass:: Client
     :members:
 
-.. autoclass:: SyncClient
-    :members:
-
 Paste
------
+------
 .. autoclass:: Paste
     :members:
 
-.. autoclass:: PasteData
+File
+-----
+
+.. autoclass:: File
     :members:

docs/exceptions.rst

@@ -3,14 +3,10 @@ Exceptions
 
 .. currentmodule:: mystbin
 
-BadPasteID
-~~~~~~~~~~
-.. autoexception:: BadPasteID()
+APIException
+~~~~~~~~~~~~~
+.. autoexception:: APIException()
 
-MystbinException
-~~~~~~~~~~~~~~~~
-.. autoexception:: MystbinException()
-
-APIError
-~~~~~~~~
-.. autoexception:: APIError()
+AuthenticationRequired
+~~~~~~~~~~~~~~~~~~~~~~~
+.. autoexception:: AuthenticationRequired()

mystbin/__init__.py

@@ -22,13 +22,13 @@
 DEALINGS IN THE SOFTWARE.
 """
 
+__version__ = "5.0.0a"
+
 from typing import Literal, NamedTuple
 
 from .client import Client as Client
-from .client import SyncClient as SyncClient
-from .errors import *
-from .objects import Paste as Paste
-from .objects import PasteData as PasteData
+from .paste import File as File
+from .paste import Paste as Paste
 
 
 class VersionInfo(NamedTuple):
@@ -39,5 +39,4 @@ class VersionInfo(NamedTuple):
     serial: int
 
 
-__version__ = "4.0.2"
-version_info: VersionInfo = VersionInfo(major=4, minor=0, micro=2, releaselevel="final", serial=0)
+version_info: VersionInfo = VersionInfo(major=5, minor=0, micro=0, releaselevel="alpha", serial=0)