# FAIR Wizard Integration SDK
*Integrate FAIR Wizard within your environment easily*
[](https://integration-sdk.fair-wizard.com)
[](https://github.com/fair-wizard/fair-wizard-integration-sdk/releases)
[](LICENSE)
## Usage
### Installation
To install the SDK, you can simply install it via pip from PyPI:
```bash
pip install fair-wizard-integration-sdk
```
Alternatively, you can install it via pip from GitHub repository directly:
```bash
pip install git+https://github.com/fair-wizard/fair-wizard-integration-sdk.git#egg=fair-wizard-integration-sdk
pip install https://github.com/numpy/numpy/releases/download/vX.Y.Z/fair_wizard_integration_sdk-X.Y.Z.tar.gz
```
Alternatively, you can clone the repository and install it locally:
```bash
git clone git@github.com:fair-wizard/fair-wizard-integration-sdk.git
cd fair-wizard-integration-sdk
git checkout develop
git checkout vX.Y.Z
pip install .
```
### Local Development (and Testing)
You can check [examples](./examples) and [tests](./tests) for how to use the SDK.
We also recommend reading the documentation for further details.
### Documentation
To generate the documentation, run the following command:
```bash
cd docs
pip install -r requirements.txt
make html
```
The documentation will be generated in the `docs/_build/html` directory.
## License
This project is licensed under the Apache License v2.0 - see the
[LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "fair-wizard-integration-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "fair-wizard, integration, automation, sdk",
"author": null,
"author_email": "Vojt\u011bch Knaisl <vojtech.knaisl@fair-wizard.com>, Marek Such\u00e1nek <marek.suchanek@fair-wizard.com>",
"download_url": "https://files.pythonhosted.org/packages/38/1f/1724ad9379c4292f9423ce453a8fa9efe87b44353f5b992811684e32a9f4/fair_wizard_integration_sdk-1.0.1.tar.gz",
"platform": null,
"description": "# FAIR Wizard Integration SDK\n\n*Integrate FAIR Wizard within your environment easily*\n\n[](https://integration-sdk.fair-wizard.com)\n[](https://github.com/fair-wizard/fair-wizard-integration-sdk/releases)\n[](LICENSE)\n\n## Usage\n\n### Installation\n\nTo install the SDK, you can simply install it via pip from PyPI:\n\n```bash\npip install fair-wizard-integration-sdk\n```\n\nAlternatively, you can install it via pip from GitHub repository directly:\n\n```bash\npip install git+https://github.com/fair-wizard/fair-wizard-integration-sdk.git#egg=fair-wizard-integration-sdk\npip install https://github.com/numpy/numpy/releases/download/vX.Y.Z/fair_wizard_integration_sdk-X.Y.Z.tar.gz\n```\n\nAlternatively, you can clone the repository and install it locally:\n\n```bash\ngit clone git@github.com:fair-wizard/fair-wizard-integration-sdk.git\ncd fair-wizard-integration-sdk\n\ngit checkout develop\ngit checkout vX.Y.Z\n\npip install .\n```\n\n### Local Development (and Testing)\n\nYou can check [examples](./examples) and [tests](./tests) for how to use the SDK.\n\nWe also recommend reading the documentation for further details.\n\n### Documentation\n\nTo generate the documentation, run the following command:\n\n```bash\ncd docs\npip install -r requirements.txt\nmake html\n```\n\nThe documentation will be generated in the `docs/_build/html` directory.\n\n## License\n\nThis project is licensed under the Apache License v2.0 - see the\n[LICENSE](LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for building integrations with FAIR Wizard",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://fair-wizard.com",
"Repository": "https://github.com/fair-wizard/fair-wizard-integration-sdk"
},
"split_keywords": [
"fair-wizard",
" integration",
" automation",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85abb15719b0eb21bee2df9a29722c6fd34dc92a3c594f2c3e6aa38169a0efdd",
"md5": "e1ac29b8b130bae658e19df4d91b4861",
"sha256": "5edee28a25d9997ce77febe91841bc40b9ba55cd2fdb0a4f179445b662f8dcde"
},
"downloads": -1,
"filename": "fair_wizard_integration_sdk-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1ac29b8b130bae658e19df4d91b4861",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<4,>=3.11",
"size": 12928,
"upload_time": "2024-11-13T02:53:16",
"upload_time_iso_8601": "2024-11-13T02:53:16.275397Z",
"url": "https://files.pythonhosted.org/packages/85/ab/b15719b0eb21bee2df9a29722c6fd34dc92a3c594f2c3e6aa38169a0efdd/fair_wizard_integration_sdk-1.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "381f1724ad9379c4292f9423ce453a8fa9efe87b44353f5b992811684e32a9f4",
"md5": "d72557cdbda4df3ac7e547e806fb3f6c",
"sha256": "0de2edade61dfb7137735c7fab7bdf4e6d6bccba753482647d28c7a91d6df6a6"
},
"downloads": -1,
"filename": "fair_wizard_integration_sdk-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d72557cdbda4df3ac7e547e806fb3f6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 10359,
"upload_time": "2024-11-13T02:53:18",
"upload_time_iso_8601": "2024-11-13T02:53:18.845244Z",
"url": "https://files.pythonhosted.org/packages/38/1f/1724ad9379c4292f9423ce453a8fa9efe87b44353f5b992811684e32a9f4/fair_wizard_integration_sdk-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 02:53:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fair-wizard",
"github_project": "fair-wizard-integration-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fair-wizard-integration-sdk"
}
JSON
