fair-test


Namefair-test JSON
Version 0.1.4 PyPI version JSON
download
home_page
SummaryA library to define and publish FAIR metrics tests APIs complying with the FAIRMetrics working group specifications. Each API can expose multiple metric tests endpoint, each test assesses the compliance of a subject URL with a FAIR principle. Those APIs can be used by FAIR evaluation services, such as FAIR enough and the FAIR evaluator.
upload_time2023-01-13 07:41:39
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT License Copyright (c) 2022-present Vincent Emonet <vincent.emonet@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords api fair evaluation test
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
<div align="center">

# ☑️ FAIR Test

[![Version](https://img.shields.io/pypi/v/fair-test)](https://pypi.org/project/fair-test) [![Python versions](https://img.shields.io/pypi/pyversions/fair-test)](https://pypi.org/project/fair-test) [![MIT license](https://img.shields.io/pypi/l/fair-test)](https://github.com/MaastrichtU-IDS/fair-test/blob/main/LICENSE)

[![Publish to PyPI](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/publish.yml/badge.svg)](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/publish.yml) [![Run tests](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/test.yml/badge.svg)](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/test.yml) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=MaastrichtU-IDS_fair-test&metric=coverage)](https://sonarcloud.io/dashboard?id=MaastrichtU-IDS_fair-test)

</div>

`fair-test` is a library to build and deploy [FAIR](https://www.go-fair.org/fair-principles/) metrics tests APIs, supporting the specifications used by the [FAIR Metrics Working Group](https://github.com/FAIRMetrics/Metrics), that can be queried to assess if a resource is complying with the [FAIR principles](https://www.go-fair.org/fair-principles/) (Findable, Accessible, Interoperable, Reusable).

It aims to enable python developers to easily write, and deploy FAIR metric tests functions that can be queried by various FAIR evaluations services, such as [FAIR enough](https://fair-enough.semanticscience.org/) and the [FAIRsharing FAIR Evaluator](https://fairsharing.github.io/FAIR-Evaluator-FrontEnd/).

## 📖 Documentation

Visit the `fair-test` documentation website for more details on how to use the library to publish new FAIR tests: [**https://maastrichtu-ids.github.io/fair-test**](https://maastrichtu-ids.github.io/fair-test)

## 🧑‍💻 Contribute

If you wish to contribute to the `fair-test` library, checkout the [Contribute page](https://maastrichtu-ids.github.io/fair-test/contributing/) in the documentation to get started.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "fair-test",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "API,FAIR,evaluation,test",
    "author": "",
    "author_email": "Vincent Emonet <vincent.emonet@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1a/71/992ca5985ac0089c4f9a312ae2a0d7ab1288df92972d9c0b4a03846dac17/fair_test-0.1.4.tar.gz",
    "platform": null,
    "description": "\n<div align=\"center\">\n\n# \u2611\ufe0f FAIR Test\n\n[![Version](https://img.shields.io/pypi/v/fair-test)](https://pypi.org/project/fair-test) [![Python versions](https://img.shields.io/pypi/pyversions/fair-test)](https://pypi.org/project/fair-test) [![MIT license](https://img.shields.io/pypi/l/fair-test)](https://github.com/MaastrichtU-IDS/fair-test/blob/main/LICENSE)\n\n[![Publish to PyPI](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/publish.yml/badge.svg)](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/publish.yml) [![Run tests](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/test.yml/badge.svg)](https://github.com/MaastrichtU-IDS/fair-test/actions/workflows/test.yml) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=MaastrichtU-IDS_fair-test&metric=coverage)](https://sonarcloud.io/dashboard?id=MaastrichtU-IDS_fair-test)\n\n</div>\n\n`fair-test` is a library to build and deploy [FAIR](https://www.go-fair.org/fair-principles/) metrics tests APIs, supporting the specifications used by the [FAIR Metrics Working Group](https://github.com/FAIRMetrics/Metrics), that can be queried to assess if a resource is complying with the [FAIR principles](https://www.go-fair.org/fair-principles/) (Findable, Accessible, Interoperable, Reusable).\n\nIt aims to enable python developers to easily write, and deploy FAIR metric tests functions that can be queried by various FAIR evaluations services, such as [FAIR enough](https://fair-enough.semanticscience.org/) and the [FAIRsharing FAIR Evaluator](https://fairsharing.github.io/FAIR-Evaluator-FrontEnd/).\n\n## \ud83d\udcd6 Documentation\n\nVisit the `fair-test` documentation website for more details on how to use the library to publish new FAIR tests: [**https://maastrichtu-ids.github.io/fair-test**](https://maastrichtu-ids.github.io/fair-test)\n\n## \ud83e\uddd1\u200d\ud83d\udcbb Contribute\n\nIf you wish to contribute to the `fair-test` library, checkout the [Contribute page](https://maastrichtu-ids.github.io/fair-test/contributing/) in the documentation to get started.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022-present Vincent Emonet <vincent.emonet@gmail.com>  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "A library to define and publish FAIR metrics tests APIs complying with the FAIRMetrics working group specifications. Each API can expose multiple metric tests endpoint, each test assesses the compliance of a subject URL with a FAIR principle. Those APIs can be used by FAIR evaluation services, such as FAIR enough and the FAIR evaluator.",
    "version": "0.1.4",
    "split_keywords": [
        "api",
        "fair",
        "evaluation",
        "test"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c29bd4d3d3899b65165d201c466e9709849fe6a9d1ff6478030b29bace45d74a",
                "md5": "151ebb164bb94164303ce16783127fef",
                "sha256": "7c4651979fd5bac8af302074806e30a183d71fb273f39f329fe841fe421fff06"
            },
            "downloads": -1,
            "filename": "fair_test-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "151ebb164bb94164303ce16783127fef",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 19251,
            "upload_time": "2023-01-13T07:41:37",
            "upload_time_iso_8601": "2023-01-13T07:41:37.602278Z",
            "url": "https://files.pythonhosted.org/packages/c2/9b/d4d3d3899b65165d201c466e9709849fe6a9d1ff6478030b29bace45d74a/fair_test-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1a71992ca5985ac0089c4f9a312ae2a0d7ab1288df92972d9c0b4a03846dac17",
                "md5": "c612c8a9f5df2d69683cf9c387b390d5",
                "sha256": "661b8510cf0e3b865eb749f5f70bc360797399b95a6ec865f457ac4a083a87eb"
            },
            "downloads": -1,
            "filename": "fair_test-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "c612c8a9f5df2d69683cf9c387b390d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 920425,
            "upload_time": "2023-01-13T07:41:39",
            "upload_time_iso_8601": "2023-01-13T07:41:39.111295Z",
            "url": "https://files.pythonhosted.org/packages/1a/71/992ca5985ac0089c4f9a312ae2a0d7ab1288df92972d9c0b4a03846dac17/fair_test-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-13 07:41:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "fair-test"
}
        
Elapsed time: 0.02873s