{"id":30196590,"url":"https://github.com/ebayclassifiedsgroup/orloclient","last_synced_at":"2025-08-13T05:27:10.214Z","repository":{"id":57449597,"uuid":"45262515","full_name":"eBayClassifiedsGroup/orloclient","owner":"eBayClassifiedsGroup","description":"Python client module to Orlo","archived":false,"fork":false,"pushed_at":"2017-05-11T12:15:21.000Z","size":139,"stargazers_count":1,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-09T12:11:51.718Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eBayClassifiedsGroup.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-30T16:20:19.000Z","updated_at":"2021-10-22T16:15:30.000Z","dependencies_parsed_at":"2022-09-26T17:31:20.213Z","dependency_job_id":null,"html_url":"https://github.com/eBayClassifiedsGroup/orloclient","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/eBayClassifiedsGroup/orloclient","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eBayClassifiedsGroup%2Forloclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eBayClassifiedsGroup%2Forloclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eBayClassifiedsGroup%2Forloclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eBayClassifiedsGroup%2Forloclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eBayClassifiedsGroup","download_url":"https://codeload.github.com/eBayClassifiedsGroup/orloclient/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eBayClassifiedsGroup%2Forloclient/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270184212,"owners_count":24541485,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-13T05:26:42.603Z","updated_at":"2025-08-13T05:27:10.151Z","avatar_url":"https://github.com/eBayClassifiedsGroup.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"orloclient\n==========\n\nPython client for the [Orlo](https://github.com/eBayClassifiedsGroup/orlo) server.\n\nInstallation\n------------\n\n::\n\n    pip install orloclient\n\nConfiguration\n-------------\n\nIf orlo server is on the same box, put a section in /etc/orlo.ini:\n\n::\n\n    [client]\n    uri=http://orlo.host\n\nOtherwise, orloclient will read the ini file above from ``~/.orlo.ini`` or ``\n./orlo.ini``.\n\nThis is the only configuration at present and is not required, it just saves you from\nconstantly having to type ``--uri http://orlo.host`` on the command line.\n\nCommand-line Usage\n------------------\n\nWith an Orlo server running on localhost:5000, and client/uri configured in orlo.ini:\n\n::\n\n    $ orloclient create-release -p test -u alex\n    Created release with id e42a478f-cc08-42e9-a9fb-c98ec65c414d\n\n    $ orloclient create-package e42a478f-cc08-42e9-a9fb-c98ec65c414d test-package 1.0.0\n    Created package with id 7510ffc0-4f0e-4fc1-925f-96ecb84e6db8\n\n    $ orloclient start 7510ffc0-4f0e-4fc1-925f-96ecb84e6db8\n\n    $ orloclient stop 7510ffc0-4f0e-4fc1-925f-96ecb84e6db8\n\n    $ orloclient list\n    [\n      {\n        \"user\": \"alex\",\n        \"platforms\": [\n          \"test\"\n        ],\n        \"packages\": [\n          {\n            \"status\": \"SUCCESSFUL\",\n            \"release_id\": \"e42a478f-cc08-42e9-a9fb-c98ec65c414d\",\n            \"id\": \"7510ffc0-4f0e-4fc1-925f-96ecb84e6db8\",\n            {...}\n          }\n        ],\n        {..}\n      }\n    ]\n\n\nSee ``orloclient -h`` for more details.\n\n\nUsage in Python\n---------------\n\n::\n\n    vagrant@debian-jessie:/vagrant$ ipython\n    Python 2.7.9 (default, Mar  1 2015, 12:57:24)\n    Type \"copyright\", \"credits\" or \"license\" for more information.\n\n    IPython 4.0.1 -- An enhanced Interactive Python.\n    ?         -\u003e Introduction and overview of IPython's features.\n    %quickref -\u003e Quick reference.\n    help      -\u003e Python's own help system.\n    object?   -\u003e Details about 'object', use 'object??' for extra details.\n\n    In [1]: import orloclient, json\n\n    In [2]: client = orloclient.OrloClient(uri='http://localhost:5000')\n\n    In [3]: release = client.create_release(user='alex', platforms=['alexdev'])\n\n    In [4]: package = client.create_package(release, name='package-one', version='1.0.0')\n\n    In [5]: client.package_start(package)\n    Out[5]: True\n\n    In [6]: client.package_stop(package)\n    Out[6]: True\n\n    In [7]: client.release_stop(release)\n    Out[7]: True\n\n    In [8]: doc = client.get_release_json(release.id)\n\n    In [9]: print(json.dumps(doc, indent=2))\n    {\n      \"releases\": [\n        {\n          \"platforms\": [\n            \"alexdev\"\n          ],\n          \"ftime\": \"2016-03-03T16:56:03Z\",\n          \"stime\": \"2016-03-03T16:55:05Z\",\n          \"team\": null,\n          \"duration\": 57,\n          \"references\": [],\n          \"packages\": [\n            {\n              \"status\": \"SUCCESSFUL\",\n              \"rollback\": false,\n              \"name\": \"package-one\",\n              \"version\": \"1.0.0\",\n              \"ftime\": \"2016-03-03T16:55:56Z\",\n              \"stime\": \"2016-03-03T16:55:52Z\",\n              \"duration\": 4,\n              \"diff_url\": null,\n              \"id\": \"9877cd69-1196-42dc-8d6c-0b7c95e11a5d\"\n            }\n          ],\n          \"id\": \"700ff271-f705-4bfb-8582-b74633759feb\",\n          \"user\": \"alex\"\n        }\n      ]\n    }\n\n\nTests\n-----\n\nThere are two test suites, test_orloclient and test_integration. The former tests the orlo client functions while mocking the requests library, courtesy of HTTPretty \u003chttps://github.com/gabrielfalcao/HTTPretty\u003e, while the integration tests run an actual Orlo server to test against.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febayclassifiedsgroup%2Forloclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febayclassifiedsgroup%2Forloclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febayclassifiedsgroup%2Forloclient/lists"}