# slims-python-api: Interact with SLims from python
The SLims python api allows you to interact with your SLims instance by using Python. It allows you to extend the versatile capability of SLims even further.
## Installing
The required Python version is 3.9
If you run SLIMS 6.3 you run
```
pip install 'slims-python-api>=6.3.0,<6.4.0'
```
If you run SLIMS 6.2 you run
```
pip install 'slims-python-api>=6.2.0,<6.3.0'
````
## Documentation
The documentation can be found on the following page:
http://slims-python-api.readthedocs.io/en/latest/
## Getting Started
To get you started we provided a few cookbook examples:
### [Data Manipulation](cookbook/data-manipulation)
In this script, we demonstrate creating, modifying and removing content.
### [Flow Example](cookbook/flow-example)
Learn how to create a SLimsgate flow with python. In the given example you will create a very simple two steps flow. In the first step a content record can be selected in the UI. In the second step a new id
for that content record can be chosen.
### [Live Report](cookbook/live-report)
This web application is displaying on a web page a live report for a selected period. It shows how a webportal can be used to create a specific report directly through the api.
### [Order Submission](cookbook/order-submission)
In this sample web application, a user can create an order direclty through a web portal, with customizable appearance and formatting
### [Plotting](cookbook/plotting)
In this example, we demonstrate how graphical plots can be created with python while fetching the data through the api.
## Contributions
If you want to contribute to the project, we welcome any addition and we will merge it through a pulls request
## Questions, Suggestions
If you have any questions/suggestions or defects, please use the Agilent service desk (https://servicedesk.li.agilent.com/support)
Raw data
{
"_id": null,
"home_page": "http://www.genohm.com",
"name": "slims-python-api",
"maintainer": "Genohm",
"docs_url": null,
"requires_python": "",
"maintainer_email": "support@genohm.com",
"keywords": "genohm,slims",
"author": "Genohm",
"author_email": "support@genohm.com",
"download_url": "https://files.pythonhosted.org/packages/b0/a0/c3e4894d833692f8693351d77a82631d907f26b5ea2bf64a72186141fba1/slims-python-api-6.9.0.tar.gz",
"platform": null,
"description": "# slims-python-api: Interact with SLims from python\n\nThe SLims python api allows you to interact with your SLims instance by using Python. It allows you to extend the versatile capability of SLims even further.\n\n## Installing\n\nThe required Python version is 3.9\n\nIf you run SLIMS 6.3 you run\n\n```\npip install 'slims-python-api>=6.3.0,<6.4.0'\n```\n\nIf you run SLIMS 6.2 you run\n\n``` \npip install 'slims-python-api>=6.2.0,<6.3.0'\n````\n\n## Documentation\n\nThe documentation can be found on the following page:\n\nhttp://slims-python-api.readthedocs.io/en/latest/\n\n\n## Getting Started\n\nTo get you started we provided a few cookbook examples:\n\n### [Data Manipulation](cookbook/data-manipulation)\n\nIn this script, we demonstrate creating, modifying and removing content.\n\n\n### [Flow Example](cookbook/flow-example)\nLearn how to create a SLimsgate flow with python. In the given example you will create a very simple two steps flow. In the first step a content record can be selected in the UI. In the second step a new id\nfor that content record can be chosen.\n\n### [Live Report](cookbook/live-report)\nThis web application is displaying on a web page a live report for a selected period. It shows how a webportal can be used to create a specific report directly through the api.\n\n### [Order Submission](cookbook/order-submission)\nIn this sample web application, a user can create an order direclty through a web portal, with customizable appearance and formatting\n\n### [Plotting](cookbook/plotting)\nIn this example, we demonstrate how graphical plots can be created with python while fetching the data through the api.\n\n\n## Contributions\nIf you want to contribute to the project, we welcome any addition and we will merge it through a pulls request\n\n\n## Questions, Suggestions\nIf you have any questions/suggestions or defects, please use the Agilent service desk (https://servicedesk.li.agilent.com/support)\n\n\n\n",
"bugtrack_url": null,
"license": "TODO",
"summary": "A python api for SLims.",
"version": "6.9.0",
"project_urls": {
"Homepage": "http://www.genohm.com"
},
"split_keywords": [
"genohm",
"slims"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc6a223b7fec5f5a9552c894d9600db5df78589be5d7639dd9cb815a05863009",
"md5": "b67ab75100a24a42ae08df3d7d4de699",
"sha256": "15ddc0fc5da62329d2a4fd8cae2f5349202cd09aead90593a67e54d3c86e4798"
},
"downloads": -1,
"filename": "slims_python_api-6.9.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b67ab75100a24a42ae08df3d7d4de699",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17005,
"upload_time": "2024-03-08T08:07:45",
"upload_time_iso_8601": "2024-03-08T08:07:45.846299Z",
"url": "https://files.pythonhosted.org/packages/cc/6a/223b7fec5f5a9552c894d9600db5df78589be5d7639dd9cb815a05863009/slims_python_api-6.9.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a0c3e4894d833692f8693351d77a82631d907f26b5ea2bf64a72186141fba1",
"md5": "1ddb5bb411f0ab949e89701ff5cf5b2c",
"sha256": "195c6b30520425d75dea7ab8d326e59a2125efcd8d14cc966d5cfade93712265"
},
"downloads": -1,
"filename": "slims-python-api-6.9.0.tar.gz",
"has_sig": false,
"md5_digest": "1ddb5bb411f0ab949e89701ff5cf5b2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21087,
"upload_time": "2024-03-08T08:07:47",
"upload_time_iso_8601": "2024-03-08T08:07:47.132850Z",
"url": "https://files.pythonhosted.org/packages/b0/a0/c3e4894d833692f8693351d77a82631d907f26b5ea2bf64a72186141fba1/slims-python-api-6.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 08:07:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "slims-python-api"
}
JSON