{"id":20358103,"url":"https://github.com/irods/irods_client_http_python","last_synced_at":"2026-01-23T06:20:44.942Z","repository":{"id":245311905,"uuid":"817426307","full_name":"irods/irods_client_http_python","owner":"irods","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-21T19:05:06.000Z","size":57,"stargazers_count":1,"open_issues_count":11,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-12T03:35:13.716Z","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/irods.png","metadata":{"files":{"readme":"README.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-19T17:20:49.000Z","updated_at":"2024-08-21T19:05:10.000Z","dependencies_parsed_at":"2024-08-21T21:19:13.502Z","dependency_job_id":"dd964692-4de6-46ad-95f7-0a75644b763f","html_url":"https://github.com/irods/irods_client_http_python","commit_stats":null,"previous_names":["ramen-noodle/irods-manager","irods/irods_client_http_python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/irods/irods_client_http_python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_client_http_python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_client_http_python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_client_http_python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_client_http_python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/irods","download_url":"https://codeload.github.com/irods/irods_client_http_python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irods%2Firods_client_http_python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28682259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: 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":[],"created_at":"2024-11-14T23:25:22.930Z","updated_at":"2026-01-23T06:20:44.920Z","avatar_url":"https://github.com/irods.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iRODS HTTP API Python Wrapper\n\nThis is a Python wrapper for the [iRODS HTTP API](https://github.com/irods/irods_client_http_api). \n\nDocumentation for the endpoint operations can be found [here](https://github.com/irods/irods_client_http_api/blob/main/API.md).\n\n## Setup\n**NOTICE:** This project is not yet available through pip. To use, clone the repository into the desired location.\n```\ngit clone https://github.com/irods/irods_client_http_python.git\n```\n## Usage\nTo use the wrapper, follow the steps listed below.\n\n```py\nfrom irods_client import IrodsClient\n\n# Create an instance of the wrapper with the base url of the iRODS server to\n# be accessed. \u003chost\u003e, \u003cport\u003e, and \u003cversion\u003e are placeholders, and need\n# to be replaced by appropriate values.\napi = IrodsClient('http://\u003chost\u003e:\u003cport\u003e/irods-http-api/\u003cversion\u003e')\n\n# Most endpoint operations require a user to be authenticated in order to\n# be executed. Authenticate with a username and password, and store the\n# token received.\ntoken = api.authenticate('\u003cusername\u003e', '\u003cpassword\u003e')\n\n# When calling authenticate for the first time on a new instance, the token\n# will be automatically set. To change the token to use operations as a\n# different user, use `setToken()`.\napi.setToken(token)\n\n# Once a token is set, the rest of the operations can be used.\nresponse = api.collections.create('/\u003czone_name\u003e/home/\u003cusername\u003e/new_collection')\n\n# After executing the operation, the iRODS response data can be accessed like this.\nif response['status_code'] != 200:\n    # Handle HTTP error.\n\nif response['data']['irods_response']['status_code'] \u003c 0:\n    # Handle iRODS error.\n```\n\nThe data returned by the wrapper will be in this format:\n```py\n{\n    'status_code': \u003cinteger\u003e,\n    'data': \u003cdict\u003e\n}\n```\nwhere `status_code` is the HTTP status code from the response, and `data` is the result of the iRODS operation.\n\nIf there is data returned by the iRODS server, it will contain a dictionary called `irods_response`, which has an additional `status_code` indicating the result of the operation on the servers side, as well as any other expected data if the operation was successful.\n```py\n{\n    'irods_response': {\n        'status_code': \u003cinteger\u003e\n        # Other properties vary between endpoints\n    }\n}\n```\n\nMore information regarding iRODS response data is available [here](https://github.com/irods/irods_client_http_api/blob/main/API.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firods%2Firods_client_http_python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firods%2Firods_client_http_python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firods%2Firods_client_http_python/lists"}