Short video showing example of passing data from an ELN to jupyter for analysis, then returning the result to the lab notes using APIs and python.

• rspace-client-python

  2 10 0.0 Python

  Python SDK and examples for the RSpace API

  

  Yes, the API is flexible and you can use it pretty much any way you like. You can learn more about the RSpace API here: https://researchspace.helpdocs.io/category/ifpi5pwbck-for-developers https://community.researchspace.com/public/apiDocs Our API github page here: https://github.com/rspace-os For a tutorial see: https://github.com/rspace-os/api-tutorial For more on using Python with our API see: https://github.com/rspace-os/rspace-client-python For a nice example of how our partner ChemAxon has utilized this API to integrate with their assay management system see: https://youtu.be/2N2dDMjK4JM As another simple example, here is a curl script you can use in the terminal of your mac to ingest files to the RSpace gallery. curl -X POST -H "accept: application/json" -H "apiKey: [add your API Key here]“ -H "content-type: multipart/form-data" -F "file=@ [add the path to a target file here]“ -F "caption=Demo input of image file using API and command line" “[add the URL of your server here]/api/v1/files” There is also a Command Line Interface (CLI) available that works with the API: You can read more about that here: https://github.com/richarda23/rspace-cli Here is an example of how you might use the CLI to create RSpace LabGroups: 1. Download the RSpace CLI for your platform. https://bintray.com/ra22597/rspace-cli/rspace-cli/0.0.14 2. Give it executable permissions: chmod 755 3. Create a file in the same folder as the executable with 'sysadmin-community.env' and add these 2 lines, save it RSPACE_API_KEY= RSPACE_URL=https://community.researchspace.com/api/v1 4. Keep the config file secret: chmod 400 sysadmin-community.env ---- to create a group 5. Run a command like this: ./rspace eln addGroup --name daltongroup2 --pi jdalton --members mpostdoc,testaccount1 --config sysadmin-community.env and get output like this : Id Name Type SharedFolderId Members 17301506 daltongp2 LAB_GROUP 814701 jdalton;mpostdoc;t.. Small print... Step 1 - the most up to date version link can be found on Github: https://github.com/richarda23/rspace-cli ( see download link in 'Downloading section) Step -3 config file can be anything you like but must have .env suffix. Step 5 - members string is comma-separated list of usernames NO SPACEs Run ./rspacex eln addGroup --help for helpdocs. Note that the restriction 'user must have logged in once' is no longer an issue. BUT the user accounts must exist. ( you can create users via 'addUser' command) Why use this rather than curl? 1) More secure - api keys are in files rather than logged to command line 2) POSTing stuff with curl has tricky syntax with quotes and curly braces, this is much simpler 3) Nicer output rather than JSON dump (although you can get output in various formats using -f option)

• api-tutorial

  1 2 0.0 Shell

  Entry-level language-agnostic tutorial to using the RSpace API

  

  Yes, the API is flexible and you can use it pretty much any way you like. You can learn more about the RSpace API here: https://researchspace.helpdocs.io/category/ifpi5pwbck-for-developers https://community.researchspace.com/public/apiDocs Our API github page here: https://github.com/rspace-os For a tutorial see: https://github.com/rspace-os/api-tutorial For more on using Python with our API see: https://github.com/rspace-os/rspace-client-python For a nice example of how our partner ChemAxon has utilized this API to integrate with their assay management system see: https://youtu.be/2N2dDMjK4JM As another simple example, here is a curl script you can use in the terminal of your mac to ingest files to the RSpace gallery. curl -X POST -H "accept: application/json" -H "apiKey: [add your API Key here]“ -H "content-type: multipart/form-data" -F "file=@ [add the path to a target file here]“ -F "caption=Demo input of image file using API and command line" “[add the URL of your server here]/api/v1/files” There is also a Command Line Interface (CLI) available that works with the API: You can read more about that here: https://github.com/richarda23/rspace-cli Here is an example of how you might use the CLI to create RSpace LabGroups: 1. Download the RSpace CLI for your platform. https://bintray.com/ra22597/rspace-cli/rspace-cli/0.0.14 2. Give it executable permissions: chmod 755 3. Create a file in the same folder as the executable with 'sysadmin-community.env' and add these 2 lines, save it RSPACE_API_KEY= RSPACE_URL=https://community.researchspace.com/api/v1 4. Keep the config file secret: chmod 400 sysadmin-community.env ---- to create a group 5. Run a command like this: ./rspace eln addGroup --name daltongroup2 --pi jdalton --members mpostdoc,testaccount1 --config sysadmin-community.env and get output like this : Id Name Type SharedFolderId Members 17301506 daltongp2 LAB_GROUP 814701 jdalton;mpostdoc;t.. Small print... Step 1 - the most up to date version link can be found on Github: https://github.com/richarda23/rspace-cli ( see download link in 'Downloading section) Step -3 config file can be anything you like but must have .env suffix. Step 5 - members string is comma-separated list of usernames NO SPACEs Run ./rspacex eln addGroup --help for helpdocs. Note that the restriction 'user must have logged in once' is no longer an issue. BUT the user accounts must exist. ( you can create users via 'addUser' command) Why use this rather than curl? 1) More secure - api keys are in files rather than logged to command line 2) POSTing stuff with curl has tricky syntax with quotes and curly braces, this is much simpler 3) Nicer output rather than JSON dump (although you can get output in various formats using -f option)

• WorkOS

  workos.com

  sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• rspace-cli

  1 2 0.0 Go

  CLI application for command-line interaction with RSpace ELN

  Yes, the API is flexible and you can use it pretty much any way you like. You can learn more about the RSpace API here: https://researchspace.helpdocs.io/category/ifpi5pwbck-for-developers https://community.researchspace.com/public/apiDocs Our API github page here: https://github.com/rspace-os For a tutorial see: https://github.com/rspace-os/api-tutorial For more on using Python with our API see: https://github.com/rspace-os/rspace-client-python For a nice example of how our partner ChemAxon has utilized this API to integrate with their assay management system see: https://youtu.be/2N2dDMjK4JM As another simple example, here is a curl script you can use in the terminal of your mac to ingest files to the RSpace gallery. curl -X POST -H "accept: application/json" -H "apiKey: [add your API Key here]“ -H "content-type: multipart/form-data" -F "file=@ [add the path to a target file here]“ -F "caption=Demo input of image file using API and command line" “[add the URL of your server here]/api/v1/files” There is also a Command Line Interface (CLI) available that works with the API: You can read more about that here: https://github.com/richarda23/rspace-cli Here is an example of how you might use the CLI to create RSpace LabGroups: 1. Download the RSpace CLI for your platform. https://bintray.com/ra22597/rspace-cli/rspace-cli/0.0.14 2. Give it executable permissions: chmod 755 3. Create a file in the same folder as the executable with 'sysadmin-community.env' and add these 2 lines, save it RSPACE_API_KEY= RSPACE_URL=https://community.researchspace.com/api/v1 4. Keep the config file secret: chmod 400 sysadmin-community.env ---- to create a group 5. Run a command like this: ./rspace eln addGroup --name daltongroup2 --pi jdalton --members mpostdoc,testaccount1 --config sysadmin-community.env and get output like this : Id Name Type SharedFolderId Members 17301506 daltongp2 LAB_GROUP 814701 jdalton;mpostdoc;t.. Small print... Step 1 - the most up to date version link can be found on Github: https://github.com/richarda23/rspace-cli ( see download link in 'Downloading section) Step -3 config file can be anything you like but must have .env suffix. Step 5 - members string is comma-separated list of usernames NO SPACEs Run ./rspacex eln addGroup --help for helpdocs. Note that the restriction 'user must have logged in once' is no longer an issue. BUT the user accounts must exist. ( you can create users via 'addUser' command) Why use this rather than curl? 1) More secure - api keys are in files rather than logged to command line 2) POSTing stuff with curl has tricky syntax with quotes and curly braces, this is much simpler 3) Nicer output rather than JSON dump (although you can get output in various formats using -f option)

Suggest a related project