{"id":30314041,"url":"https://github.com/clarify/pyclarify","last_synced_at":"2025-08-17T18:56:27.812Z","repository":{"id":39925057,"uuid":"397531088","full_name":"clarify/pyclarify","owner":"clarify","description":"PyClarify is the official python SDK for connecting to Clarify!","archived":false,"fork":false,"pushed_at":"2024-11-11T10:34:36.000Z","size":4480,"stargazers_count":3,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-06T06:44:16.684Z","etag":null,"topics":["clarify","python","timeseries"],"latest_commit_sha":null,"homepage":"https://clarify.github.io/pyclarify/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clarify.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2021-08-18T08:41:11.000Z","updated_at":"2024-11-11T10:34:37.000Z","dependencies_parsed_at":"2024-02-26T15:25:31.666Z","dependency_job_id":"fd0cd12a-d96a-414c-8fb9-9a4fc7e37ae8","html_url":"https://github.com/clarify/pyclarify","commit_stats":{"total_commits":31,"total_committers":3,"mean_commits":"10.333333333333334","dds":0.06451612903225812,"last_synced_commit":"b99d4ae2b38c8d77fd6c57e944f5119c55231bd2"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/clarify/pyclarify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarify%2Fpyclarify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarify%2Fpyclarify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarify%2Fpyclarify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarify%2Fpyclarify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clarify","download_url":"https://codeload.github.com/clarify/pyclarify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarify%2Fpyclarify/sbom","scorecard":{"id":285053,"data":{"date":"2025-08-11","repo":{"name":"github.com/clarify/pyclarify","commit":"345ad229d6f269b05cb14f8e8faffc6087e122c5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/build_github_pages.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":"Code-Review","score":0,"reason":"Found 2/30 approved changesets -- score normalized to 0","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":"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":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build_github_pages.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build_github_pages.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build_github_pages.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build_github_pages.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build_github_pages.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/clarify/pyclarify/build_github_pages.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:33","Warn: pipCommand not pinned by hash: .github/workflows/build_github_pages.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/build_github_pages.yml:27","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   4 third-party GitHubAction dependencies pinned","Info:   0 out of   4 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":"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":"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":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/build.yml:17"],"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":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2020-73","Warn: Project is vulnerable to: GHSA-mr82-8j83-vxmv","Warn: Project is vulnerable to: PYSEC-2014-14 / GHSA-652x-xj99-gmcc","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2014-13 / GHSA-cfj3-7x9c-4p3h","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg"],"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 30 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-17T17:00:56.368Z","repository_id":39925057,"created_at":"2025-08-17T17:00:56.368Z","updated_at":"2025-08-17T17:00:56.368Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270892208,"owners_count":24663543,"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-17T02:00:09.016Z","response_time":129,"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":["clarify","python","timeseries"],"created_at":"2025-08-17T18:56:08.877Z","updated_at":"2025-08-17T18:56:27.787Z","avatar_url":"https://github.com/clarify.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://www.clarify.io\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/clarify/data-science-tutorials/main/media/logo_dark.png\" alt=\"Clarify logo\" title=\"Clarify\" align=\"right\" height=\"80\" /\u003e\n\u003c/a\u003e\n\n# PyClarify\n\n[![PyPI package](https://img.shields.io/badge/pip%20install-pyclarify-brightgreen)](https://pypi.org/project/pyclarify/)\n[![Version number](https://img.shields.io/pypi/v/pyclarify?color=green\u0026label=version)](https://pypi.org/project/pyclarify/)\n[![Downloads](https://static.pepy.tech/badge/pyclarify)](https://pepy.tech/project/pyclarify)\n[![Downloads](https://static.pepy.tech/personalized-badge/pyclarify?period=month\u0026units=none\u0026left_color=grey\u0026right_color=blue\u0026left_text=downloads/month)](https://pepy.tech/project/pyclarify)\n[![Actions Status](https://github.com/clarify/pyclarify/workflows/Build%20status/badge.svg)](https://github.com/clarify/pyclarify/actions)\n[![License](https://img.shields.io/github/license/clarify/pyclarify)](https://github.com/clarify/pyclarify/blob/main/LICENSE)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n\u003chr/\u003e\n\n```python\nfrom pyclarify import Client\n\ndata = {\n    \"times\": [\"2022-10-10T00:00:00\"],\n    \"series\": {\n        \"temperature\": [19],\n        \"pressure\": [1025]\n    }\n}\n\nclient = Client(\"credentials.json\")\nclient.insert(data)\n```\n\nPyClarify helps users of Clarify to easily read, write and manipulate data in Clarify.\n\n- Data scientists can easily filter data, convert it to `pandas` with our built in methods, and write results back.\n- System integrators can set up pipelines for automatic streaming of data, and update labels on the fly.\n\n# Useful tutorials and documentation\n\n- [PyClarify SDK](https://pypi.org/project/pyclarify/)\n- [PyClarify documentation](https://clarify.github.io/pyclarify/)\n- [Clarify Developer documentation](https://docs.clarify.io/developers/welcome)\n- [Basic tutorial on using Python with Clarify](https://colab.research.google.com/github/clarify/data-science-tutorials/blob/main/tutorials/Introduction.ipynb)\n\n# Prerequisites\n\nIn order to start using the Python SDK, you need\n\n- To know a bit of Python. For a refresher, see the [Official Python tutorial](https://docs.python.org/tutorial/).\n- Python3 (\u003e= 3.7) and pip.\n- Credentials from a Clarify integration. See the [introduction notebook](https://colab.research.google.com/github/clarify/data-science-tutorials/blob/main/tutorials/Introduction.ipynb) for a complete introduction.\n\n## Where to get it\n\nThe source code is currently hosted on GitHub at: https://github.com/clarify/pyclarify\n\nBinary installers for the latest released version are available at the [Python\nPackage Index (PyPI)](https://pypi.org/project/pyclarify).\n\n```sh\n# PyPI install\npip install pyclarify\n\n# Conda install\nconda install pyclarify\n```\n\n## Dependencies\n\n- [requests](https://requests.readthedocs.io/en/latest/) - The most used (and trusted) HTTP library.\n- [Pydantic](https://pydantic-docs.helpmanual.io) - Allowing for strict typing and data validation.\n- [Typing Extensions](https://typing.readthedocs.io) - Brings the typing use of new type system features on older Python versions, allowing us to support python 3.7+.\n\n# Interact with Clarify\n\nPyClarify provides a fast and easy way to interact with Clarify.\nThe `Client` class takes as an argument the path of your credentials in string format, which should always be the first step when starting to interact with PyClarify.\n\nFor information about the Clarify Developer documentation\nclick [here](https://docs.clarify.io/developers/welcome).\n\n## Quickstart\n\nWe recommend using Google Colab to quickly learn how to interact with Clarify using Python. We have created an interactive introduction tutorial where you will learn all the basics to get you started.\n\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/clarify/data-science-tutorials/blob/main/tutorials/Introduction.ipynb)\n\n### Access you data with the _ClarifyClient_\n\n```python\nfrom pyclarify import Client\n\nclient = Client(\"clarify-credentials.json\")\n```\n\n### Create new _Signals_\n\n```python\nfrom pyclarify import Signal\n\nsignal = Signal(\n    name = \"Home temperature\",\n    description = \"Temperature in the bedroom\",\n    labels = {\"data-source\": [\"Raspberry Pi\"], \"location\": [\"Home\"]}\n)\n\nresponse = client.save_signals(\n    input_ids=[\"INPUT_ID\"],\n    signals=[signal],\n    create_only=False\n)\n```\n\n### Populate your signals using _DataFrames_\n\n```python\nfrom pyclarify import DataFrame\n\ndata = DataFrame(\n    series={\"INPUT_ID_1\": [1, None], \"INPUT_ID_2\": [None, 5]},\n    times = [\"2021-11-01T21:50:06Z\",  \"2021-11-02T21:50:06Z\"],\n)\n\nresponse = client.insert(data)\n```\n\n### Query your stored signals\n\n```python\nresponse = client.select_signals(\n    skip=10,\n    limit=50,\n    sort=[\"-id\"]\n)\n```\n\n### Publish them as _Items_\n\n```python\nfrom pyclarify import Item\n\nclient = Client(\"./clarify-credentials.json\")\n\nitem = Item(\n    name = \"Home temperature\",\n    description = \"Temperature in the bedroom\",\n    labels = {\"data-source\": [\"Raspberry Pi\"], \"location\": [\"Home\"]},\n    visible=True\n)\nresponse = client.publish_signals(\n    signal_ids=['\u003cSIGNAL_ID\u003e'],\n    items=[item],\n    create_only=False\n)\n```\n\n### Use filters to get a specific selection\n\n```python\nfrom pyclarify.query import Filter, Regex\n\nonly_raspberries = Filter(\n    fields={\n        \"labels.unit-type\": Regex(value=\"Raspberry\")\n    }\n)\n\nresponse = client.select_items(\n    filter=only_raspberries\n)\n```\n\n### Get the data and include relationships\n\n```python\nresponse = client.data_frame(\n    filter=only_raspberries,\n    include=[\"item\"]\n)\n```\n\n### Look at our reference!\n\n[\u003cimg src=\"./docs/source/reference.png\" width=\"150\" /\u003e](https://clarify.github.io/pyclarify/)\n\n# Changelog\n\nWondering about upcoming or previous changes to the SDK? Take a look at the [CHANGELOG](https://github.com/clarify/pyclarify/blob/main/CHANGELOG.md).\n\n# Contributing\n\nWant to contribute? Check out [CONTRIBUTING](https://github.com/clarify/pyclarify/blob/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarify%2Fpyclarify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclarify%2Fpyclarify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarify%2Fpyclarify/lists"}