Highspot Python SDK

A Python toolset for utilizing the Highspot API

Python Version Requirement
Highspot SDK 2.0.0 and newer require Python 3.10 or newer (and older than 3.14).
Version 1.0.0 is the final release that supports Python versions older than 3.10, and can be installed using pip install "highspot<2".

Installation

The package can be installed via pip using the syntax below.

pip install highspot --upgrade

You may also clone the repository and install from source using Poetry as shown below.

git clone git://github.com/jeffshurtliff/highspot.git
cd highspot/
poetry install

Usage

This section provides basic usage instructions for the package.

Importing the package

Rather than importing the base package, it is recommended that you import the primary Highspot class using the syntax below.

from highspot import Highspot

Initializing a Highspot object instance

The primary Highspot object serves many purposes, the most important being to establish a connection to the Highspot environment with which you intend to interact. As such, when initializing an instance of the Highspot object, you will need to pass it the API credentials it will use to authenticate so that the connection can be established.

Passing the information directly into the object

The API credentials can be passed directly into the Highspot object when initializing it, as demonstrated in the example below.

hs = Highspot(username='a1b2c3d4e5', password='abc123DEF456')

License

MIT License

Changelog

Refer to the changelog for version change information.

Reporting Issues

Issues can be reported within the GitHub repository.

Donations

If you would like to donate to this project then you can do so using this PayPal link.

Disclaimer

This package is considered unofficial and is in no way endorsed or supported by Highspot.