Setup everything

rossjrw · rossjrw · commit 80cba1986f13 · 2020-05-20T06:38:00.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+__pycache__
+*.secret.*
+*.vim
+*.sw*
+env
+.venv
+.vscode
+pylintrc
+.cache
+Pipfile.lock
diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+pytest = "*"
+pipfile-requirements = "*"
+pylint = "*"
+
+[packages]
+
+[requires]
+python_version = "3.6"
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
 # python-scuttle
 Python wrapper around SCUTTLE API.
+
+## Installation
+
+## Usage
+
+## Testing
+
+Install [Pipenv](https://pypi.org/project/pipenv/) and install development
+dependencies:
+
+```shell
+pipenv install --dev
+```
+
+Run tests in pipenv environment:
+
+```shell
+pipenv run pytest
+```
+
+Tests require a SCUTTLE API key with full permissions. This key should be the
+contents of `token.secret.txt` which is to be placed in the test directory. Do
+make sure it's in the gitignore.
diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,2 @@
+[pytest]
+testpaths = test/
diff --git a/test/test_api.py b/test/test_api.py
