dyff-client


Namedyff-client JSON
Version 0.3.2 PyPI version JSON
download
home_pageNone
SummaryPython client for the Dyff AI auditing platform.
upload_time2024-04-24 22:18:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseApache-2.0
keywords ai audit safety evaluation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # dyff-client

<!-- BADGIE TIME -->

[![pipeline status](https://img.shields.io/gitlab/pipeline-status/dyff/packages/dyff-client?branch=main)](https://gitlab.com/dyff/packages/dyff-client/-/commits/main)
[![coverage report](https://img.shields.io/gitlab/pipeline-coverage/dyff/packages/dyff-client?branch=main)](https://gitlab.com/dyff/packages/dyff-client/-/commits/main)
[![latest release](https://img.shields.io/gitlab/v/release/dyff/packages/dyff-client)](https://gitlab.com/dyff/packages/dyff-client/-/releases)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![code style: black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/psf/black)
[![imports: isort](https://img.shields.io/badge/imports-isort-1674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![cici-tools Enabled](https://img.shields.io/badge/%E2%9A%A1_cici--tools-enabled-c0ff33)](https://gitlab.com/buildgarden/tools/cici-tools)

<!-- END BADGIE TIME -->

Python client for the Dyff AI auditing platform.

> Do not use this software unless you are an active collaborator on the
> associated research project.
>
> This project is an output of an ongoing, active research project. It is
> published without warranty, is subject to change at any time, and has not been
> certified, tested, assessed, or otherwise assured of safety by any person or
> organization. Use at your own risk.

## Installation

`dyff-client` requires Python 3.9+ and can be installed via `pip`:

```bash
python3 -m pip install dyff-client
```

## Configuration

```python
from dyff.client import Client

client = Client(api_key="XXXXXX")
```

The API key must be provisioned by a Dyff administrator.

## Usage

```python
dataset = client.datasets.create_arrow_dataset(
    "/my/data", account="XXX", name="mydata"
)
```

For more examples, see the [client
examples](https://docs.dyff.io/examples/client/).

For the full API, see the [client API
reference](https://docs.dyff.io/api-reference/client/).

## License

Copyright 2024 UL Research Institutes.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

<http://www.apache.org/licenses/LICENSE-2.0>

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dyff-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "ai, audit, safety, evaluation",
    "author": null,
    "author_email": "Digital Safety Research Institute <contact@dsri.org>",
    "download_url": "https://files.pythonhosted.org/packages/ef/be/60d1bf94e204d59781c61a135ca61255a92aa78041f3f3aff6ec7c1e5076/dyff_client-0.3.2.tar.gz",
    "platform": null,
    "description": "# dyff-client\n\n<!-- BADGIE TIME -->\n\n[![pipeline status](https://img.shields.io/gitlab/pipeline-status/dyff/packages/dyff-client?branch=main)](https://gitlab.com/dyff/packages/dyff-client/-/commits/main)\n[![coverage report](https://img.shields.io/gitlab/pipeline-coverage/dyff/packages/dyff-client?branch=main)](https://gitlab.com/dyff/packages/dyff-client/-/commits/main)\n[![latest release](https://img.shields.io/gitlab/v/release/dyff/packages/dyff-client)](https://gitlab.com/dyff/packages/dyff-client/-/releases)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![code style: black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/psf/black)\n[![imports: isort](https://img.shields.io/badge/imports-isort-1674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![cici-tools Enabled](https://img.shields.io/badge/%E2%9A%A1_cici--tools-enabled-c0ff33)](https://gitlab.com/buildgarden/tools/cici-tools)\n\n<!-- END BADGIE TIME -->\n\nPython client for the Dyff AI auditing platform.\n\n> Do not use this software unless you are an active collaborator on the\n> associated research project.\n>\n> This project is an output of an ongoing, active research project. It is\n> published without warranty, is subject to change at any time, and has not been\n> certified, tested, assessed, or otherwise assured of safety by any person or\n> organization. Use at your own risk.\n\n## Installation\n\n`dyff-client` requires Python 3.9+ and can be installed via `pip`:\n\n```bash\npython3 -m pip install dyff-client\n```\n\n## Configuration\n\n```python\nfrom dyff.client import Client\n\nclient = Client(api_key=\"XXXXXX\")\n```\n\nThe API key must be provisioned by a Dyff administrator.\n\n## Usage\n\n```python\ndataset = client.datasets.create_arrow_dataset(\n    \"/my/data\", account=\"XXX\", name=\"mydata\"\n)\n```\n\nFor more examples, see the [client\nexamples](https://docs.dyff.io/examples/client/).\n\nFor the full API, see the [client API\nreference](https://docs.dyff.io/api-reference/client/).\n\n## License\n\nCopyright 2024 UL Research Institutes.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use\nthis file except in compliance with the License. You may obtain a copy of the\nLicense at\n\n<http://www.apache.org/licenses/LICENSE-2.0>\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Python client for the Dyff AI auditing platform.",
    "version": "0.3.2",
    "project_urls": {
        "Home": "https://gitlab.com/dyff/packages/dyff-client",
        "Issues": "https://gitlab.com/dyff/packages/dyff-client/-/issues"
    },
    "split_keywords": [
        "ai",
        " audit",
        " safety",
        " evaluation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68d47d91c2747738d717372ffb9e0765c1537b0868718277adc6744a4fb2997c",
                "md5": "0dc2ce4f7923cf82961e3637a28c9feb",
                "sha256": "4705b1ee3a381550e89318a2b7cdc4b31a2ae0ff5dc4ece8277dac02f4354444"
            },
            "downloads": -1,
            "filename": "dyff_client-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0dc2ce4f7923cf82961e3637a28c9feb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 131497,
            "upload_time": "2024-04-24T22:18:08",
            "upload_time_iso_8601": "2024-04-24T22:18:08.816765Z",
            "url": "https://files.pythonhosted.org/packages/68/d4/7d91c2747738d717372ffb9e0765c1537b0868718277adc6744a4fb2997c/dyff_client-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "efbe60d1bf94e204d59781c61a135ca61255a92aa78041f3f3aff6ec7c1e5076",
                "md5": "94630be611461a75083195e6fcab1ab1",
                "sha256": "9e7b551fed990541db373e63917c67dbd73b10ac80d5602abe7d518355dfc3aa"
            },
            "downloads": -1,
            "filename": "dyff_client-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "94630be611461a75083195e6fcab1ab1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 130949,
            "upload_time": "2024-04-24T22:18:10",
            "upload_time_iso_8601": "2024-04-24T22:18:10.709817Z",
            "url": "https://files.pythonhosted.org/packages/ef/be/60d1bf94e204d59781c61a135ca61255a92aa78041f3f3aff6ec7c1e5076/dyff_client-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-24 22:18:10",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "dyff",
    "gitlab_project": "packages",
    "lcname": "dyff-client"
}
        
Elapsed time: 0.26853s