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
vagrant@debian-jessie:/vagrant$ ipython
Python 2.7.9 (default, Mar 1 2015, 12:57:24)
Type "copyright", "credits" or "license" for more information.

IPython 4.0.1 -- An enhanced Interactive Python.
? -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help -> Python's own help system.
object? -> Details about 'object', use 'object??' for extra details.

In [1]: import orloclient, json

In [2]: client = orloclient.OrloClient(uri='http://localhost:5000')

In [3]: release = client.create_release(user='alex', platforms=['alexdev'])

In [4]: package = client.create_package(release, name='package-one', version='1.0.0')

In [5]: client.package_start(package)
Out[5]: True

In [6]: client.package_stop(package)
Out[6]: True

In [7]: client.release_stop(release)
Out[7]: True

In [8]: doc = client.get_release_json(release.id)

In [9]: print(json.dumps(doc, indent=2))
{
"releases": [
{
"platforms": [
"alexdev"
],
"ftime": "2016-03-03T16:56:03Z",
"stime": "2016-03-03T16:55:05Z",
"team": null,
"duration": 57,
"references": [],
"packages": [
{
"status": "SUCCESSFUL",
"rollback": false,
"name": "package-one",
"version": "1.0.0",
"ftime": "2016-03-03T16:55:56Z",
"stime": "2016-03-03T16:55:52Z",
"duration": 4,
"diff_url": null,
"id": "9877cd69-1196-42dc-8d6c-0b7c95e11a5d"
}
],
"id": "700ff271-f705-4bfb-8582-b74633759feb",
"user": "alex"
}
]
}
```

# 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.4.1.post1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distributions

orloclient-0.4.1.post1-py2-none-any.whl (20.9 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for orloclient-0.4.1.post1.tar.gz
Algorithm Hash digest
SHA256 eeb6adc74eaa4c9442da70e46495ba1400524601bbcf1b2cf55f5b89f5420a87
MD5 7c2b919a1082bf57f8068a29d2c8b8fc
BLAKE2b-256 1499ca1090467e7e8968b83754efecafe34d88c38389689083336a7e18f51b06

See more details on using hashes here.

File details

Details for the file orloclient-0.4.1.post1.macosx-10.12-x86_64.tar.gz.

File metadata

File hashes

Hashes for orloclient-0.4.1.post1.macosx-10.12-x86_64.tar.gz
Algorithm Hash digest
SHA256 899894df4288d2a6f0d26c3cfe14d82c7d929bd9ad03a8ac1b66e8b1168c3dea
MD5 81d434a2bdc3b93fd9daf59de573b013
BLAKE2b-256 ea631cc409d87c89f32b43ff4d9d261adc1ad0ab63232b4babeaf298e5213468

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for orloclient-0.4.1.post1-py2-none-any.whl
Algorithm Hash digest
SHA256 8ba90d742affc6202754bba0647286b578a6c09b0ed7081f6af1c0e305843cda
MD5 c78e64957b55ca13596e448edff431e0
BLAKE2b-256 24ee6f7d6c1349d74f39219c28723778cd63e380386846ea7571a6f8abf0c5cc

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