diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..d09fe9c --- /dev/null +++ b/.coveragerc @@ -0,0 +1,5 @@ +[report] +omit = + */python?.?/* + */site-packages/nose/* + tests.py diff --git a/.travis.yml b/.travis.yml index 8314d74..c973ea5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,9 @@ language: python python: - - "2.7" -# command to install dependencies + - 2.6 install: -# - pip install -r requirements.txt --use-mirrors - - pip install toopher -# command to run tests -script: python tests.py + - pip install -r requirements.txt --use-mirrors +script: + nosetests tests.py --with-coverage --cover-package=toopher +after_success: + coveralls diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dc36c5f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# ToopherAPI Python Client + +#### Python Version +>=2.6.0 + +#### Installing Dependencies +Toopher uses [pip](https://pypi.python.org/pypi/pip) to install packages. + +To ensure all dependencies are up-to-date run: +```shell +$ pip install -r requirements.txt +``` + +#### Tests +To run tests enter: +```shell +$ python tests.py +``` diff --git a/README-Iframe.md b/README-Iframe.md new file mode 100644 index 0000000..ed10347 --- /dev/null +++ b/README-Iframe.md @@ -0,0 +1,119 @@ +Authenticating using the Toopher ` +``` + +There is no difference in the markup required for a Pairing vs. an Authentication iframe request (the generated URI embeds all relevant information). + +# Examples + +#### Generating an Authentication iframe URI +Every Toopher Authentication session should include a unique `request_token` - a randomized string that is included in the signed request to the Toopher API and returned in the signed response from the Toopher `