Metadata-Version: 2.4
Name: highspot
Version: 2.0.0
Summary: A Python toolset for utilizing the Highspot API
License-Expression: MIT
License-File: LICENSE
Author: Jeff Shurtliff
Author-email: jeff@shurt.us
Maintainer: Jeff Shurtliff
Maintainer-email: jeff@shurt.us
Requires-Python: >=3.10,<3.14.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Environment :: Web Environment
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: certifi (>=2024.7.4)
Requires-Dist: idna (>=3.15,<4)
Requires-Dist: requests (>=2.33.0,<3)
Requires-Dist: urllib3 (>=2.7.0,<3)
Project-URL: Changelog, https://highspot.readthedocs.io/en/latest/changelog.html
Project-URL: Documentation, https://highspot.readthedocs.io/en/latest/
Project-URL: Homepage, https://github.com/jeffshurtliff/highspot
Project-URL: Issue Tracker, https://github.com/jeffshurtliff/highspot/issues
Project-URL: Repository, https://github.com/jeffshurtliff/highspot
Description-Content-Type: text/markdown

# Highspot Python SDK
A Python toolset for utilizing the Highspot API

> **Python Version Requirement**<br>
> Highspot SDK `2.0.0` and newer require Python `3.10` or newer (and older than `3.14`).<br>
> 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.

```sh
pip install highspot --upgrade
```

You may also clone the repository and install from source using [Poetry](https://python-poetry.org/) as shown below.

```sh
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.

```python
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.

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

## License
[MIT License](https://github.com/jeffshurtliff/highspot/blob/master/LICENSE)

## Changelog
Refer to the [changelog](https://highspot.readthedocs.io/en/latest/changelog.html) for version change information.

## Reporting Issues
Issues can be reported within the [GitHub repository](https://github.com/jeffshurtliff/highspot/issues).

## Donations
If you would like to donate to this project then you can do so using 
[this PayPal link](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XDZ8M6UV6EFK6&item_name=highspot&currency_code=USD).

## Disclaimer
This package is considered unofficial and is in no way endorsed or supported by 
[Highspot](https://www.highspot.com).

