# inm-rspace
Python tools for interaction with the Rspace Electronic Lab Notebook. Developed at INM - Leibniz Institute for New Materials in Saarbrücken, Germany.
`inm-rspace` adds functionality to the `rspace-client` API to make it easier to include personal scientific data workflows.
The main feature is the `Workflow` class, with which you can wrap arbitrary existing Python code in order to execute it on RSpace documents.
## Installation and Setup
You can install `inm-rspace` through PyPI, which should automatically take care of installing dependencies (especially `rspace-client`). Simply type:
`pip install inm-rspace`
However, to use the API, you need to first create an API key as explained [here](https://documentation.researchspace.com/article/v0dxtfvj7u-rspace-api-introduction).
Furthermore, `inm-rspace` assumes you have saved this API key as `RSPACE_API_KEY` along with your RSpace URL as `RSPACE_URL` (e.g. https://leibniz-inm.researchspace.com) as environment variables in your terminal.
## Examples
To learn how to generally use the `rspace-client` API, please refer to their [examples](https://github.com/rspace-os/rspace-client-python/tree/master/examples).
As for how to use the `inm-rspace` extension for workflows, check the `examples` folder of this repository.
## Documentation
The full API documentation is still in progress, but the current state is already available [here](https://sintharic.github.io/inm-rspace/).
Raw data
{
"_id": null,
"home_page": "https://github.com/sintharic/inm-rspace",
"name": "inm-rspace",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "eln, rspace, science, notebook",
"author": "Christian M\u00fcller",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/61/d4/88e45297469c2880aef2a0ba9373c0b0fe4353d649c2f5d45985022c5f04/inm_rspace-0.4.1.tar.gz",
"platform": null,
"description": "# inm-rspace\n\nPython tools for interaction with the Rspace Electronic Lab Notebook. Developed at INM - Leibniz Institute for New Materials in Saarbr\u00fccken, Germany.\n\n`inm-rspace` adds functionality to the `rspace-client` API to make it easier to include personal scientific data workflows.\nThe main feature is the `Workflow` class, with which you can wrap arbitrary existing Python code in order to execute it on RSpace documents.\n\n\n## Installation and Setup\n\nYou can install `inm-rspace` through PyPI, which should automatically take care of installing dependencies (especially `rspace-client`). Simply type:\n\n`pip install inm-rspace`\n\nHowever, to use the API, you need to first create an API key as explained [here](https://documentation.researchspace.com/article/v0dxtfvj7u-rspace-api-introduction).\nFurthermore, `inm-rspace` assumes you have saved this API key as `RSPACE_API_KEY` along with your RSpace URL as `RSPACE_URL` (e.g. https://leibniz-inm.researchspace.com) as environment variables in your terminal.\n\n\n## Examples\n\nTo learn how to generally use the `rspace-client` API, please refer to their [examples](https://github.com/rspace-os/rspace-client-python/tree/master/examples).\n\nAs for how to use the `inm-rspace` extension for workflows, check the `examples` folder of this repository.\n\n\n## Documentation\n\nThe full API documentation is still in progress, but the current state is already available [here](https://sintharic.github.io/inm-rspace/).",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools for working with the RSpace ELN",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://sintharic.github.io/inm-rspace",
"Homepage": "https://github.com/sintharic/inm-rspace",
"Repository": "https://github.com/sintharic/inm-rspace"
},
"split_keywords": [
"eln",
" rspace",
" science",
" notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6c67f57a17ae253900815a21154f3207ad0f6f281a2ee0aa02b6ad4f4e6f0d9",
"md5": "119f25b8678cf7e75fc866031f810fa1",
"sha256": "08622c951f04538f5e9a1ad47cafa3e321a3657bde940c160ba194f796a92f61"
},
"downloads": -1,
"filename": "inm_rspace-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "119f25b8678cf7e75fc866031f810fa1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9839,
"upload_time": "2025-07-09T11:48:23",
"upload_time_iso_8601": "2025-07-09T11:48:23.279398Z",
"url": "https://files.pythonhosted.org/packages/e6/c6/7f57a17ae253900815a21154f3207ad0f6f281a2ee0aa02b6ad4f4e6f0d9/inm_rspace-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61d488e45297469c2880aef2a0ba9373c0b0fe4353d649c2f5d45985022c5f04",
"md5": "5ae4dbee54430ae7d07010cdc9e23041",
"sha256": "fc3db704c3c56c42369d399b1240c20e5e09c4067554c2d7c37c4ea6e47c8f7f"
},
"downloads": -1,
"filename": "inm_rspace-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "5ae4dbee54430ae7d07010cdc9e23041",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9377,
"upload_time": "2025-07-09T11:48:24",
"upload_time_iso_8601": "2025-07-09T11:48:24.135667Z",
"url": "https://files.pythonhosted.org/packages/61/d4/88e45297469c2880aef2a0ba9373c0b0fe4353d649c2f5d45985022c5f04/inm_rspace-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 11:48:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sintharic",
"github_project": "inm-rspace",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "rspace-client",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
}
],
"lcname": "inm-rspace"
}
JSON
