Merge branch 'master' into details

Author: rossjrw

Pipfile

@@ -8,6 +8,7 @@ pytest = "*"
 pipfile-requirements = "*"
 pylint = "*"
 python-dateutil = "*"
+black = "==19.10b0"
 
 [packages]
 requests = "*"

pylintrc

@@ -0,0 +1,3 @@
+[DESIGN]
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=50

pyproject.toml

@@ -0,0 +1,5 @@
+[tool.black]
+line-length = 80
+target-version = ['py38']
+skip-string-normalization = true
+include = '\.pyi?$'

scuttle/versions/base.py

@@ -2,11 +2,14 @@
 
 import requests
 
+
 class BaseApi:
     version = None
+
     def __init__(self, domain, api_key):
         self.endpoint = "https://{}.scuttle.bluesoul.net/api/v{}".format(
-            domain, type(self).version)
+            domain, type(self).version
+        )
         self.api_key = api_key
 
     def request(self, namespace, value=None, data=None):
@@ -15,8 +18,6 @@ def request(self, namespace, value=None, data=None):
         if data is not None:
             send['data'] = data
         response = getattr(requests, method)(
-            "{}/{}".format(
-                self.endpoint,
-                namespace.format(value)),
-            **send)
+            "{}/{}".format(self.endpoint, namespace.format(value)), **send
+        )
         return response.json()

scuttle/versions/v1.py

@@ -57,6 +57,7 @@ def verbose(self, *args, **kwargs):
 
 class Api(BaseApi):
     """API version 1"""
+
     version = 1
 
     def __init__(self, *args):

scuttle/wrapper.py

@@ -6,6 +6,7 @@
 
 from scuttle.versions import v1
 
+
 def scuttle(wiki, api_key, api_version=1):
     """Create a new API wrapper for a given wiki and API version.
 
@@ -18,6 +19,7 @@ def scuttle(wiki, api_key, api_version=1):
         raise NotImplementedError
     return ApiWrapper(wiki, api_key, api_version)
 
+
 class ApiWrapper:
     def __init__(self, wiki, api_key, api_version):
         self.domain = wiki
@@ -27,8 +29,9 @@ def __init__(self, wiki, api_key, api_version):
         if self.version == 1:
             self.api = v1.Api(self.domain, self.api_key)
         else:
-            raise ModuleNotFoundError("API version {} does not exist."
-                                      .format(self.version))
+            raise ModuleNotFoundError(
+                "API version {} does not exist.".format(self.version)
+            )
 
     def __getattr__(self, attr):
         # Redirect attribute requests to api.

setup.py

@@ -6,25 +6,21 @@
 from scuttle import __version__
 
 from os import path
+
 this_directory = path.abspath(path.dirname(__file__))
 with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
 setup(
     name='scuttle',
     version=__version__,
-    packages=[
-        'scuttle',
-        'scuttle.versions'
-    ],
+    packages=['scuttle', 'scuttle.versions'],
     url="http://github.com/scuttle/python-scuttle",
     license="MIT",
     author="Ross Williams",
     author_email="ross@rossjrw.com",
     description="Python wrapper for SCUTTLE API.",
     long_description=long_description,
     long_description_content_type='text/markdown',
-    install_requires=[
-        "requests"
-    ]
+    install_requires=["requests"],
 )

test/test_api.py

@@ -8,22 +8,26 @@
 
 API_KEY = os.environ['SCUTTLE_API_KEY']
 
+
 def test_basic():
     wiki = scuttle.scuttle('en', None, 1)
     assert wiki.domain == 'en'
     assert wiki.version == 1
     assert isinstance(wiki.api, scuttle.versions.v1.Api)
 
+
 def test_get_nonexistent_version():
     with pytest.raises(ModuleNotFoundError) as error:
         scuttle.scuttle('en', None, 0)
         assert str(error.value) == "API version 0 does not exist."
 
+
 def test_get_default_version():
     wiki = scuttle.scuttle('en', None)
     assert wiki.version == 1
     assert isinstance(wiki.api, scuttle.versions.v1.Api)
 
+
 def test_wiki():
     wiki = scuttle.scuttle('en', API_KEY, 1)
     assert wiki.wikis()[0]['subdomain'] == "admin"
@@ -66,8 +70,16 @@ def test_page():
     assert set(pages[0].keys()) == {'id', 'slug', 'wd_page_id'}
     page_id = pages[0]['id']
     assert wiki.page_by_id(page_id)['id'] == page_id
-    assert wiki.page_by_slug("scp-001")['metadata']['wikidot_metadata']['fullname'] == "scp-001"
-    assert wiki.page_by_slug("component:ar-theme")['metadata']['wikidot_metadata']['created_by'] == "Croquembouche"
+    assert (
+        wiki.page_by_slug("scp-001")['metadata']['wikidot_metadata']['fullname']
+        == "scp-001"
+    )
+    assert (
+        wiki.page_by_slug("component:ar-theme")['metadata']['wikidot_metadata'][
+            'created_by'
+        ]
+        == "Croquembouche"
+    )
     if len(votes := wiki.page_votes(page_id)) > 0:
         assert isinstance(votes[0]['vote'], int)
     if len(tags := wiki.page_tags(page_id)) > 0:
@@ -97,13 +109,18 @@ def test_revisions():
     assert len(first_rev) == 1
     final_rev = wiki.page_revisions.verbose(page_id, limit=1, direction='desc')
     print(f"{final_rev=}")
-    assert first_rev[0]['metadata']['wikidot_metadata']['timestamp'] <= final_rev[0]['metadata']['wikidot_metadata']['timestamp']
+    assert (
+        first_rev[0]['metadata']['wikidot_metadata']['timestamp']
+        <= final_rev[0]['metadata']['wikidot_metadata']['timestamp']
+    )
+
 
 def test_forums():
     wiki = scuttle.scuttle('en', API_KEY, 1)
     forum_id = wiki.forums()[0]['id']
     assert wiki.forum(forum_id)['id'] == forum_id
 
+
 def test_tags():
     # TODO
     pass