Skip to main content

Client to the Orlo deployment data capture API

Project description

# orloclient

Python client for the [Orlo](https://github.com/eBayClassifiedsGroup/orlo) server.

# Installation
```
pip install orloclient
```

# Usage

With an Orlo server running on localhost:5000:
```python
$ python
Python 2.7.10 (default, Jul 13 2015, 12:05:58)
[GCC 4.2.1 Compatible Apple LLVM 6.1.0 (clang-602.0.53)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from orloclient import Orlo
>>> orlo = Orlo(
... uri='http://localhost:5000'
... )
>>> release_id = orlo.create_release(
... user='testuser',
... platforms=['dc1', 'dc2'],
... team='A-Team',
... references=['test-ticket1']
... )
>>> first_package_id = orlo.create_package(
... release_id=release_id,
... name='first_package',
... version='1.0.0',
... )
>>> second_package_id = orlo.create_package(
... release_id=release_id,
... name='second_package',
... version='2.0.0',
... )
>>> orlo.package_start(release_id=release_id, package_id=first_package_id)
True
>>> orlo.package_stop(release_id=release_id, package_id=first_package_id, success=True)
True
>>> orlo.package_start(release_id=release_id, package_id=second_package_id)
True
>>> orlo.package_stop(release_id=release_id, package_id=second_package_id, success=False)
True
>>> orlo.release_stop(release_id)
True
>>> orlo.get_releases(release_id=release_id)
>>> import json
>>> release = orlo.get_releases(release_id)
>>> print(json.dumps(release, indent=4, sort_keys=True))
{
"releases": [
{
"duration": 224,
"ftime": "2015-11-24T19:23:24Z",
"id": "3155d4ce-b7c2-4d36-88ed-1d12d70fee8b",
"packages": [
{
"diff_url": null,
"duration": 64,
"ftime": "2015-11-24T19:22:13Z",
"id": "db0c8cc2-d87a-45ca-b8c1-48a3d7296e0a",
"name": "second_package",
"status": "FAILED",
"stime": "2015-11-24T19:21:08Z",
"version": "2.0.0"
},
{
"diff_url": null,
"duration": 19,
"ftime": "2015-11-24T19:22:04Z",
"id": "e3f758a1-4f87-4638-9186-2860eab88385",
"name": "first_package",
"status": "SUCCESSFUL",
"stime": "2015-11-24T19:21:45Z",
"version": "1.0.0"
}
],
"platforms": [
"dc1",
"dc2"
],
"references": [
"test-ticket1"
],
"stime": "2015-11-24T19:19:40Z",
"team": "A-Team",
"user": "testuser"
}
]
}
```

# Tests

There are two test suites, test_orloclient and test_integration. The former tests the orlo client functions while mocking the requests library, courtesy of [HTTPretty](https://github.com/gabrielfalcao/HTTPretty), while the integration tests run an actual Orlo server to test against.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orloclient-0.1.0.post1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

orloclient-0.1.0.post1-py2-none-any.whl (16.1 kB view details)

Uploaded Python 2

File details

Details for the file orloclient-0.1.0.post1.tar.gz.

File metadata

File hashes

Hashes for orloclient-0.1.0.post1.tar.gz
Algorithm Hash digest
SHA256 3352f8ead02b06a9cbd37f6ab3b6d288e7feea13f480d5e4f9b5a8e88068cc36
MD5 ea502560e42edf3e37b391029b62bfe7
BLAKE2b-256 d1fb7bf3f872caf770fbe8f400cd03ec3429ad636daa941e818c7b2f7290d8ec

See more details on using hashes here.

File details

Details for the file orloclient-0.1.0.post1-py2-none-any.whl.

File metadata

File hashes

Hashes for orloclient-0.1.0.post1-py2-none-any.whl
Algorithm Hash digest
SHA256 7710f1bddccd95778acd9784cef398b846918908e33c622a169b06ed9ca01fa1
MD5 e748126b81f4f703d2de8e3c62b1ce51
BLAKE2b-256 b338b83d5b14e305320227b291fd36900aa278717cacb8a97e134dfdf495a979

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page