Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.5 KB

Contributing

Pull requests welcome.

Working on the client locally

This is a Python 3 application. It has not been tested against any version of Python 2.

    brew install python3

Dependency management

This is done through pip and virtualenv. We recommend using VirtualEnvWrapper.

Setting up a Virtualenv for python3

    mkvirtualenv -p /usr/local/bin/python3 notifications-python-client

Install the dependencies

    pip3 install -r requirements_for_test.txt

Tests

The ./scripts/run_tests.py script will run all the tests. py.test is used for testing.

Running the script will also check for conformance with pep8.

Additionally code coverage is checked via pytest-cov.

Integration tests

The ./scripts/run_integration_tests.py script will run the integration tests. The integration tests will test the contract of the response to all the api calls, ensuring the latest version of notifications-api do not break the contract of the notifications-python-client.

Command line tool

Use this to test the client without having to create an application.

    PYTHONPATH=. python /utils/make_api_call.py <base_api_url> <api_key> [fetch|create]

This will use the API referred to in the base_api_url argument to send a text message.