# Highspot Python SDK
A Python toolset for utilizing the Highspot API
## 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 below.
```sh
git clone git://github.com/jeffshurtliff/highspot.git
cd highspot/
python setup.py 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¤cy_code=USD).
## Disclaimer
This package is considered unofficial and is in no way endorsed or supported by
[Highspot](https://www.highspot.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/jeffshurtliff/highspot",
"name": "highspot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Jeff Shurtliff",
"author_email": "jeff.shurtliff@rsa.com",
"download_url": "https://files.pythonhosted.org/packages/43/c0/e0a402c5ff7fc3435d01c1125049734c9d4df6cf97f9c9f1413d20ff74d1/highspot-1.0.0.tar.gz",
"platform": null,
"description": "# Highspot Python SDK\nA Python toolset for utilizing the Highspot API\n\n## Installation\nThe package can be installed via pip using the syntax below.\n\n```sh\npip install highspot --upgrade\n```\n\nYou may also clone the repository and install from source using below.\n\n```sh\ngit clone git://github.com/jeffshurtliff/highspot.git\ncd highspot/\npython setup.py install\n```\n\n## Usage\nThis section provides basic usage instructions for the package.\n\n### Importing the package\nRather than importing the base package, it is recommended that you import the primary `Highspot` class using the syntax\nbelow.\n\n```python\nfrom highspot import Highspot\n```\n\n### Initializing a Highspot object instance\nThe primary `Highspot` object serves many purposes, the most important being to establish a connection to the \nHighspot environment with which you intend to interact. As such, when initializing an instance of the `Highspot` \nobject, you will need to pass it the API credentials it will use to authenticate so that the connection can be \nestablished.\n\n#### Passing the information directly into the object\nThe API credentials can be passed directly into the `Highspot` object when initializing it, as\ndemonstrated in the example below.\n\n```python\nhs = Highspot(username='a1b2c3d4e5', password='abc123DEF456')\n```\n\n## License\n[MIT License](https://github.com/jeffshurtliff/highspot/blob/master/LICENSE)\n\n## Changelog\nRefer to the [changelog](https://highspot.readthedocs.io/en/latest/changelog.html) for version change information.\n\n## Reporting Issues\nIssues can be reported within the [GitHub repository](https://github.com/jeffshurtliff/highspot/issues).\n\n## Donations\nIf you would like to donate to this project then you can do so using \n[this PayPal link](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XDZ8M6UV6EFK6&item_name=highspot¤cy_code=USD).\n\n## Disclaimer\nThis package is considered unofficial and is in no way endorsed or supported by \n[Highspot](https://www.highspot.com).\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python toolset for utilizing the Highspot API",
"version": "1.0.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b335b9952e96e3060fb937e640aa0ab5",
"sha256": "c73176cdd2f8020a390a7ba94849711820b82e7b2b300063b451b2e38fa82c34"
},
"downloads": -1,
"filename": "highspot-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b335b9952e96e3060fb937e640aa0ab5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16065,
"upload_time": "2022-12-11T18:32:46",
"upload_time_iso_8601": "2022-12-11T18:32:46.485651Z",
"url": "https://files.pythonhosted.org/packages/43/c0/e0a402c5ff7fc3435d01c1125049734c9d4df6cf97f9c9f1413d20ff74d1/highspot-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-11 18:32:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jeffshurtliff",
"github_project": "highspot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": [
[
"==",
"2022.12.7"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"2.1.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.28.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.26.12"
]
]
}
],
"lcname": "highspot"
}
JSON
