{"id":51302477,"url":"https://github.com/mat3ra/api-client","last_synced_at":"2026-06-30T21:03:57.910Z","repository":{"id":45021689,"uuid":"81351365","full_name":"mat3ra/api-client","owner":"mat3ra","description":"Python client for Exabyte RESTful API","archived":false,"fork":false,"pushed_at":"2026-04-14T04:21:39.000Z","size":237,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2026-06-19T12:23:47.135Z","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/mat3ra.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-02-08T16:38:54.000Z","updated_at":"2026-05-28T11:46:00.000Z","dependencies_parsed_at":"2025-02-03T02:21:52.711Z","dependency_job_id":"24c142a7-e6ab-44c3-aa55-6fea889a97e5","html_url":"https://github.com/mat3ra/api-client","commit_stats":{"total_commits":113,"total_committers":8,"mean_commits":14.125,"dds":"0.48672566371681414","last_synced_commit":"ca942bd4c366c064b08e411c002a8f0d616dfb64"},"previous_names":["mat3ra/api-client"],"tags_count":68,"template":false,"template_full_name":null,"purl":"pkg:github/mat3ra/api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat3ra%2Fapi-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat3ra%2Fapi-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat3ra%2Fapi-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat3ra%2Fapi-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mat3ra","download_url":"https://codeload.github.com/mat3ra/api-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mat3ra%2Fapi-client/sbom","scorecard":{"id":47568,"data":{"date":"2025-08-11","repo":{"name":"github.com/Exabyte-io/api-client","commit":"1c1899528187fc97800eceb199de352ef77fb84a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":4,"reason":"Found 4/10 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/cicd.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cicd.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/Exabyte-io/api-client/cicd.yml/dev?enable=pin","Warn: pipCommand not pinned by hash: run-tests.sh:40","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":0,"reason":"10 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2022-42986 / GHSA-43fp-rhv2-5gv8","Warn: Project is vulnerable to: PYSEC-2023-135 / GHSA-xqr8-7jwr-rhp7","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: PYSEC-2023-212 / GHSA-g4mx-q9vg-27p4","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2023-192 / GHSA-v845-jxx5-vc9f"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 24 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T23:05:52.821Z","repository_id":45021689,"created_at":"2025-08-14T23:05:52.821Z","updated_at":"2025-08-14T23:05:52.821Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34983192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-30T02:00:05.919Z","response_time":92,"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":["exabyte-io","materials","materials-informatics","materials-science","python-client","rest-api"],"created_at":"2026-06-30T21:03:57.168Z","updated_at":"2026-06-30T21:03:57.901Z","avatar_url":"https://github.com/mat3ra.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%2Fmat3ra%2Fapi-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmat3ra%2Fapi-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmat3ra%2Fapi-client/lists"}