{"id":22007062,"url":"https://github.com/exabyte-io/api-client","last_synced_at":"2026-03-11T21:20:10.747Z","repository":{"id":45021689,"uuid":"81351365","full_name":"Exabyte-io/api-client","owner":"Exabyte-io","description":"Python client for Exabyte RESTful API","archived":false,"fork":false,"pushed_at":"2025-02-08T01:36:10.000Z","size":174,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":9,"default_branch":"dev","last_synced_at":"2025-04-18T01:28:33.755Z","etag":null,"topics":["exabyte-io","materials","materials-informatics","materials-science","python-client","rest-api"],"latest_commit_sha":null,"homepage":"https://docs.exabyte.io/api","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Exabyte-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-02-08T16:38:54.000Z","updated_at":"2025-02-08T01:35:30.000Z","dependencies_parsed_at":"2025-02-03T02:21:52.711Z","dependency_job_id":"24c142a7-e6ab-44c3-aa55-6fea889a97e5","html_url":"https://github.com/Exabyte-io/api-client","commit_stats":{"total_commits":113,"total_committers":8,"mean_commits":14.125,"dds":"0.48672566371681414","last_synced_commit":"ca942bd4c366c064b08e411c002a8f0d616dfb64"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exabyte-io%2Fapi-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exabyte-io%2Fapi-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exabyte-io%2Fapi-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Exabyte-io%2Fapi-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Exabyte-io","download_url":"https://codeload.github.com/Exabyte-io/api-client/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252589749,"owners_count":21772926,"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","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":["exabyte-io","materials","materials-informatics","materials-science","python-client","rest-api"],"created_at":"2024-11-30T01:16:48.534Z","updated_at":"2025-12-25T22:26:07.866Z","avatar_url":"https://github.com/Exabyte-io.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/mat3ra-api-client.svg)](https://badge.fury.io/py/mat3ra-api-client)\n\nThis package provides access to Mat3ra.com [RESTful API](https://docs.mat3ra.com/rest-api/overview/).\n\n# Installation\n\nWe recommend creating a virtual environment before installing:\n\n```bash\nvirtualenv my-virtualenv\nsource my-virtualenv/bin/activate\n```\n\nInstall using pip:\n\n- from PyPI:\n\n```bash\npip install mat3ra-api-client\n```\n\n- from source code in development mode:\n\n```bash\ngit clone git@github.com:Exabyte-io/api-client.git\ncd api-client\npip install -e .\n```\n\n# Usage\n\n```python\nfrom mat3ra.api_client import APIClient\n\n# Authenticate with OIDC token\nclient = APIClient.authenticate()\n\n# Access endpoints\nmaterials = client.materials.list()\n```\n\n# Examples\n\n[api-examples](https://github.com/Exabyte-io/api-examples) repository contains examples for performing most-common tasks in the Mat3ra.com platform through its RESTful API in Jupyter Notebook format.\n\n# Testing\n\nThe package uses pytest for testing. Tests are organized into unit and integration tests.\n\n## Running Tests\n\n### Unit Tests (No environment setup required)\n\nRun all unit tests:\n```bash\npytest tests/py/unit\n```\n\n### Integration Tests (Requires API credentials)\n\nIntegration tests require the following environment variables to be set:\n\n- `TEST_HOST` - API host (e.g., `platform.mat3ra.com`)\n- `TEST_PORT` - API port (e.g., `443`)\n- `TEST_ACCOUNT_ID` - Your account ID\n- `TEST_AUTH_TOKEN` - Your authentication token\n- `TEST_SECURE` - Use HTTPS (optional, default: `False`)\n- `TEST_VERSION` - API version (optional, default: `2018-10-01`)\n\nTo run integration tests:\n```bash\nexport TEST_HOST=platform.mat3ra.com\nexport TEST_PORT=443\nexport TEST_ACCOUNT_ID=your-account-id\nexport TEST_AUTH_TOKEN=your-auth-token\nexport TEST_SECURE=true\n\npytest tests/py/integration\n```\n\n### Run All Tests\n\n```bash\npytest tests/py\n```\n\n### Run Tests with Coverage\n\n```bash\npytest tests/py/unit --cov=mat3ra.api_client --cov-report=term --cov-report=html\n```\n\n**Note:** Integration tests will be automatically skipped if required environment variables are not set.\n\n\n© 2020 Exabyte Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexabyte-io%2Fapi-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexabyte-io%2Fapi-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexabyte-io%2Fapi-client/lists"}