GitHub - ELN-uzun/elabapi-python: eLabFTW REST API v2 Python library

Python library for eLabFTW REST API.

Description

This repository allows generating a python library to interact with eLabFTW REST API v2. It uses Swagger Codegen to generate it based on the OpenApi specification of eLabFTW REST API v2.

As such, it doesn't contain the generated code, but only instructions on how to generate it for local development.

Users should install the library with pip, as described below.

Installation

# create a virtual environment
python -m venv elab
# activate it
source elab/bin/activate
# on Windows
# C:\> elab\Scripts\activate.bat
# install the library
pip install elabapi-python

Usage

Getting started

The easiest way to get started is to look at an example script: 00-getting-started.py.

Find more examples in the examples folder.

Basic concepts

import elabapi_python
# Initialize a configuration object from the library
configuration = elabapi_python.Configuration()
# Set the host
configuration.host = "https://eln.example.org/api/v2"
# Create an API client object with our configuration
api_client = elabapi_python.ApiClient(configuration)
# Set the Api Key in Authorization header
api_client.set_default_header(header_name='Authorization', header_value=5-abc123...)

# Depending on your needs, instantiate the correct object with api_client as argument
info_client = elabapi_python.InfoApi(api_client)
exp_client = elabapi_python.ExperimentsApi(api_client)
items_client = elabapi_python.ItemsApi(api_client)

Unofficial documentation

From TU Graz, Shared RDM Project:

https://github.com/sharedRDM/elabftw_api_support

Dev

Using the helper script

# generate the library
./helper.sh generate
# generate from local file: openapi.yaml must be in current dir
./helper.sh generate-from-local
# build packages
./helper.sh build