Skip to content

scuttle/python-scuttle

Repository files navigation

python-scuttle

tests Code style: black

Python wrapper around SCUTTLE API.

Installation

With pip:

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

With Pipenv:

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

Usage

Check out the wiki.

Current SCUTTLE API documentation can be found on its wiki. Most methods are reproduced with similar names.

Testing

Install Pipenv and install development dependencies:

pipenv install --dev

Run tests in pipenv environment:

pipenv run python3 -m pytest

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