Start building interface

Author: rossjrw

Pipfile

@@ -9,6 +9,7 @@ pipfile-requirements = "*"
 pylint = "*"
 
 [packages]
+requests = "*"
 
 [requires]
 python_version = "3.6"

README.md

@@ -17,7 +17,7 @@ pipenv install --dev
 Run tests in pipenv environment:
 
 ```shell
-pipenv run pytest
+pipenv run python3 -m pytest
 ```
 
 Tests require a SCUTTLE API key with full permissions. This key should be the

scuttle/__init__.py

@@ -0,0 +1 @@
+from .wrapper import scuttle

scuttle/api_1.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+
+"""Provides generic methods for accessing version 1 of the API."""

scuttle/wrapper.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+
+"""Provides methods to interface with a given API instance."""
+
+import requests
+
+def scuttle(wiki, api_version=None):
+    """Create a new API wrapper for a given wiki and API version.
+
+    str `wiki`: The domain of the wiki.
+    int `api_version`: The version of the API to use. If not provided, defaults
+    to latest.
+    """
+

test/test_api.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+import pytest
+import scuttle
+
+TOKEN = None
+with open("token.secret.txt", 'r') as token_file:
+    TOKEN = token_file.readline().strip()
+
+def test_something():
+    wiki = scuttle.scuttle('en', 1)