This library allows you to interact with HelpScout using Python.
Project description
HelpScout
This library allows you to interact with HelpScout using Python.
Installation
Installation is easiest using Pip and PyPi:
pip install helpscout
If you would like to contribute, or prefer Git:
git clone https://github.com/LasLabs/python-helpscout.git cd python-helpscout pip install -r requirements.txt pip install .
Usage
The HelpScout object is the primary point of interaction with the HelpScout API.
Connecting to the HelpScout API will require an API Key, which is generated from within your HelpScout account. In the below example, our key is API_KEY.
from helpscout import HelpScout
hs = HelpScout('API_KEY')The HelpScout API endpoints are exposed as variables on the instantiated HelpScout object. The available endpoints are:
They can also be viewed from the __apis__ property of HelpScout:
>>> hs.__apis__
{'Conversations': <helpscout.auth_proxy.AuthProxy object at 0x10783ddd0>,
'Customers': <helpscout.auth_proxy.AuthProxy object at 0x10783dd90>,
'Mailboxes': <helpscout.auth_proxy.AuthProxy object at 0x10783ded0>,
'Users': <helpscout.auth_proxy.AuthProxy object at 0x10783df50>,
'Teams': <helpscout.auth_proxy.AuthProxy object at 0x10783df10>,
}
API usage is as simple as calling the method with the required parameters:
for customer in hs.Customers.list():
print(customer.first_name)Known Issues / RoadMap
Add the ability to accept web hooks via HTTP
Add better validations (like regexes for emails)
Verify required attributes, particularly when creating for API instead of receiving
Attachment handling in Conversations (Create/Delete Attachment)
Raw email source handling in Conversations (Get Thread Source)
Implement List Customers by Mailbox
Implement Search endpoint
Implement Workflows
Credits
Contributors
Dave Lasley <dave@laslabs.com>
Maintainer
This module is maintained by LasLabs Inc.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for helpscout-0.0.1b38-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0952fa46d85dfb4fd4f367054e86183a16a05b0b048f2619b24cfe1e0de6a1dd |
|
| MD5 | 867dc47d7c90d3a209b4e9bb33b6eba7 |
|
| BLAKE2b-256 | 25fc6a0812ee8c627df8fb45af37b846dc127f758227c4194b0ebfe77e38c788 |
Hashes for helpscout-0.0.1b38-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 190f5cd9563846529159cd498faf15b6c7440631415fac0a4ff564183b0bd243 |
|
| MD5 | 83ee378eb74bd8f5c906b413dec52f00 |
|
| BLAKE2b-256 | b5d99f4d159ea9e9a506c26cbff15e8404822206c731f9a3399db5a570fc3087 |
