Delighted Python
================
Python wrapper for the `Delighted API <https://delightedapp.com/docs/api>`_. Get
your pythonic NPS on!
Getting started is easy!
-----------------------
Install from pip::
sudo pip install DelightedPython
Basic Usage::
from delighted import Delighted
## Initialize with API Key
client = Delighted('<your_api_key_here>')
## Get a list of all survey responses
responses = client.survey_response.get()
Person Resource
---------------
See `the docs <https://delightedapp.com/docs/api>`_ for valid parameters and usage.
People Resource Examples::
## Create a new person on delighted
client.person.create(email='getmynps@testing.com')
## Update a person record
client.person.update('getmynps@testing.com',
properties={'location': 'Boston'})
## Delete upcoming survey request for the given person
client.person.delete('getmynps@testing.com')
Survey Response Resource
------------------------
See `the docs <https://delightedapp.com/docs/api>`_ for valid parameters and usage.
Survey Response Resource Examples::
## Post new response
client.survey_response.create(person=123, score=10, comment='What a great app!')
## List all responses
client.survey_response.get()
Metrics Resource
----------------
See `the docs <https://delightedapp.com/docs/api>`_ for valid parameters and usage.
Metrics Resource Examples::
## Get NPS Metrics
client.metrics.get()
## Get NPS Metrics by Trend
client.metrics.get(trend=456)
Unit Tests
----------
To run unit test first add your test api key to delighted/test/test_delighted.py.
Then run the following::
python -m delighted.test.test_delighted
Important TODO's
----------------
1. Rework error throwing to be a bit more useful (see DelightedAPIError)
Acknowledgements
----------------
- The `Delighted <https://delightedapp.com/>`_ Team for creating a wonderful service and kick ass API
- Team `Testive <http://www.testive.com/>`_ for supporting the creation and open source of the wrapper
Metadata
Release files for DelightedPython 0.0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| DelightedPython-0.0.1.6.tar.gz | 5.2 kB | Without provenance | Details for DelightedPython-0.0.1.6.tar.gz |
Release files / DelightedPython-0.0.1.6.tar.gz
| Download URL | DelightedPython-0.0.1.6.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40c75e6f3ff8db59106b0ed8f842af45e94fc448c80b262a5206713c4c2b339c
|
|
BLAKE2b-256 checksum How to use checksums |
6fa0d00b38072c3bcbe217e9b14a9b5a73656d119c0d21e80d8daba2dcc34f33
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for DelightedPython 0.0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.