{"id":21881182,"url":"https://github.com/wtsi-hgi/irobot-client","last_synced_at":"2026-04-14T00:31:20.263Z","repository":{"id":146402541,"uuid":"97102593","full_name":"wtsi-hgi/irobot-client","owner":"wtsi-hgi","description":"Basic client to interact with the iRobot HTTP API","archived":false,"fork":false,"pushed_at":"2018-03-27T16:25:22.000Z","size":6514,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":11,"default_branch":"develop","last_synced_at":"2025-03-22T00:44:40.170Z","etag":null,"topics":["irobot","python","tool"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wtsi-hgi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-13T09:03:26.000Z","updated_at":"2018-03-27T16:25:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"00c6b9a5-8d0e-4888-8d14-4353aff03309","html_url":"https://github.com/wtsi-hgi/irobot-client","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/wtsi-hgi/irobot-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Firobot-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Firobot-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Firobot-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Firobot-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wtsi-hgi","download_url":"https://codeload.github.com/wtsi-hgi/irobot-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wtsi-hgi%2Firobot-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31776852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T00:11:49.126Z","status":"ssl_error","status_checked_at":"2026-04-14T00:10:29.837Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["irobot","python","tool"],"created_at":"2024-11-28T09:18:03.913Z","updated_at":"2026-04-14T00:31:20.240Z","avatar_url":"https://github.com/wtsi-hgi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/wtsi-hgi/irobot-client.svg?branch=develop)](https://travis-ci.org/wtsi-hgi/irobot-client)\n[![codecov.io](https://codecov.io/gh/wtsi-hgi/irobot-client/graph/badge.svg?branch=develop)](https://codecov.io/github/wtsi-hgi/irobot-client)\n\n\n# iRobot Client\n\nBasic [iRobot](https://github.com/wtsi-hgi/irobot) client to interact with the iRobot HTTP API.  The client has a [Common Workflow Language](http://www.commonwl.org/v1.0/) wrapper for integration with Arvados and other applications if needed.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine or in a Docker container for development and testing purposes.\n\n### Prerequisites\n\nWhat things you need to install the software: \n- python 3.6 \n\n\n### Installing\n\nFrom GitHub:\n```\ngit clone https://github.com/wtsi-hgi/irobot-client.git\ncd irobot-client\npython setup.py install\n```\n\nAlternatively in a Docker container but *without* test resources (CANNOT run the cwl inside the irobot-client container):\n```\ndocker run -it mercury/irobot-client\n```\n\n#### Check that the iRobot-Client works:\nThe best way to check the client works without connecting to the irobot server is to run a docker container with the [Bissell](https://github.com/wtsi-hgi/bissell) image from [dockerhub](https://hub.docker.com/r/mercury/bissell/).\n```\nmkdir testdir\nirobotclient http://localhost:5000/test.cram testdir --arvados_token testtoken -f\n```\nThe above command should download two files (`test.cram` and it's associated index file: `test.cram.crai`) to the `testdir` folder.\n\n### Usage\n#### Command line interface\n```\nusage: irobotclient [options] INPUT_FILE OUTPUT_DIR\n\nCommand line interface for iRobot HTTP requests\n\npositional arguments:\n  input_file            path and name of input file\n  output_dir            path of output directory\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -u URL, --url URL     Use this tag if no irobot URL is set as an environment variable {IROBOT_URL}. URL scheme, domain and port for irobot. EXAMPLE: http://irobot:5000/\n  --arvados_token ARVADOS_TOKEN\n                        Arvados authentication token; if not supplied here it will be sourced from the environment {ARVADOS_TOKEN} or default to an\n  --basic_username BASIC_USERNAME\n                        Basic authentication username; if not supplied here it will be sourced from the environment {BASIC_USERNAME} then, failing that, current system user\n  --basic_password BASIC_PASSWORD\n                        Basic authentication password; if not supplied here it will be sourced from the environment {BASIC_PASSWORD}\n  -f, --force           force overwrite output file if it already exists\n  --no_index            Do not download index files for CRAM/BAM files\n  -o, --override_url    Override a URL set in the IROBOT_URL environment \n                        variable\"\n```\n\n#### Common Workflow Language (CWL)\nThe below commands run the cwl wrapper passing in the example YAML file defining program argument values.\n```\ncd cwl\npip install -r cwl_requirements.txt\ncwl-runner cwl_wrapper.cwl config_example.yml\n```\nIf the Bissell container is up and running, the above command should return a test_text.txt file to your working directory.  To specify a different output directory use the cwl-runner `--outdir OUTDIR` option.\n\n## Deployment\n\nValues required for the client can be passed in as arguments on the command line, a YAML file when using CWL, or the following can be set as environment variables:\n```\nIROBOT_URL      -   URL scheme, domain and port for irobot. EXAMPLE: http://irobot:5000/\nARVADOS_TOKEN   -   Arvados authentication token\nBASIC_USERNAME  -   Basic authentication username\nBASIC_PASSWORD  -   Basic authentication password\n```\n\n## Running the tests\n- [ ] TODO: Update unittests\n- [ ] TODO: Create automated test script for cwl\n- [ ] TODO: Explain how to run the automated tests for this system\n\n### And coding style tests\n\n- [ ] TODO: This project follows the unittest and PEP8 coding style.\n\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/wtsi-hgi/irobot-client/releases). \n\n## Authors\n\n* [Elizabeth Weatherill](https://github.com/EWeatherill)\n\nSee also the list of [contributors](https://github.com/wtsi-hgi/irobot-client/graphs/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the GNU General Public License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n* [Chris Harrison](https://github.com/Xophmeister) - iRobot developer\n* [Colin Nolan](https://github.com/colin-nolan) - Code reviewer\n* [Josh Randall](https://github.com/jrandall) - Team lead and [Bissell](https://github.com/wtsi-hgi/bissell) author\n* [Billie Thompson](https://github.com/PurpleBooth) - [README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)\n* Stack Overflow\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwtsi-hgi%2Firobot-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwtsi-hgi%2Firobot-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwtsi-hgi%2Firobot-client/lists"}