python-scuttle

Python wrapper around SCUTTLE API.

Installation

To install the latest release from PyPI:

pip install python-scuttle

Or, to install the latest commit to master from source:

pip install -e git+https://github.com/scuttle/python-scuttle.git

Usage

Check out the wiki for theoretical usage and concept explanation, or the tests for live usage.

Current SCUTTLE API documentation can be found on its wiki. As of writing, all methods are reproduced with similar names.

Testing

Install Pipenv and development dependencies:

pipenv install --dev

Run tests in pipenv environment:

pipenv run pytest

Tests require a SCUTTLE API key with full read permissions. Tests will look for this key in the SCUTTLE_API_KEY environment variable. Tests require at least Python 3.8.