Skip to content

api key to example #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srautiai merged 2 commits into from
Sep 29, 2016
Merged

api key to example #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
699a8c7
updated README with api key and example to use public cloud
aknackiron Sep 9, 2016
b1b870f
Updated README with api key information
aknackiron Sep 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Python client for Testdroid Cloud APIv2
=======================================

Expand Down Expand Up @@ -31,11 +32,13 @@ Module

You can use this class as a command line utility or import it to your own code.

There are two methods of authentication, email and password or api key. The prefered approach is using api key as in examle below.

Example:

```python
>>> from testdroid import Testdroid
>>> testdroid = Testdroid(username="admin@localhost", password="admin", url="http://localhost:9080/testdroid-cloud")
>>> testdroid = Testdroid(apikey="<your api key>")
>>> testdroid.get_test_run(1233, 12345)
{u'displayName': u'Test Run 1', u'logZipState': u'BLANK', u'screenshotZipState': u'BLANK', u'projectId': 12340, u'number': 1, u'successRatio': 0.814815, u'createTime': 1393595647000, u'executionRatio': 1.0, u'state': u'FINISHED', u'startedByDisplayName': u'John Doe', u'id': 10}
```
Expand All @@ -56,7 +59,7 @@ Set up sandbox

Build example

`python setup.py clean && python setup.py sdist && pip install -U dist/testdroid-0.1.7.tar.gz`
`python setup.py clean && python setup.py sdist && pip install -U dist/testdroid-<latest version>.tar.gz`

Usage

Expand Down