Development¶
Running the tests¶
Run the unit tests:
nosetests tests/unit
Run the integration tests:
# THESE SHOULD ONLY BE RUN ON A TEST APP!
INTERCOM_PERSONAL_ACCESS_TOKEN=xxx nosetests tests/integration
Generate the Documentation¶
cd docs
make html
Code coverage¶
Generate a code coverage report:
nosetests --with-coverage --cover-package=intercom tests/unit
Runtime Dependencies¶
- Requests – an HTTP library “for human beings”
- inflection – Inflection is a string transformation library. It singularizes and pluralizes English words, and transforms strings from CamelCase to underscored string.
- six – Six is a Python 2 and 3 compatibility library. It provides utility functions for smoothing over the differences between the Python versions with the goal of writing Python code that is compatible on both Python versions.
- certifi – Certifi is a carefully curated collection of Root Certificates for validating the trustworthiness of SSL certificates while verifying the identity of TLS hosts.
- pytz – pytz brings the Olson tz database into Python. This library allows accurate and cross platform timezone calculations. It also solves the issue of ambiguous times at the end of daylight saving time.
Development Dependencies¶
- nose – makes unit testing easier.
- coverage – code coverage.
- mock – patching methods for unit testing.
- Sphinx – documentation decorator.
- Sphinx theme for readthedocs.org – theme for the documentation.