Skip to main content

This library allows you to interact with HelpScout using Python.

Project description

License: MIT | Build Status | Test Coverage | Code Climate

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

Maintainer

LasLabs Inc.

This module is maintained by LasLabs Inc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for helpscout, version 0.0.1b38
Filename, size File type Python version Upload date Hashes
Filename, size helpscout-0.0.1b38-py2-none-any.whl (39.5 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size helpscout-0.0.1b38-py3-none-any.whl (39.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size helpscout-0.0.1b38.tar.gz (19.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page