https://github.com/elabftw/elabapi-python
eLabFTW REST API v2 Python library
https://github.com/elabftw/elabapi-python
Last synced: 20 days ago
JSON representation
eLabFTW REST API v2 Python library
- Host: GitHub
- URL: https://github.com/elabftw/elabapi-python
- Owner: elabftw
- License: mit
- Created: 2022-11-28T23:57:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T15:54:06.000Z (24 days ago)
- Last Synced: 2025-04-09T23:14:55.496Z (20 days ago)
- Language: Shell
- Size: 66.4 KB
- Stars: 27
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# elabapi-python
[](https://pypi.org/project/elabapi-python/)
[](https://pypi.org/project/elabapi-python/)
Python library for eLabFTW REST API.
# Description
This repository allows generating a python library to interact with [eLabFTW](https://github.com/elabftw/elabftw) REST API v2. It uses [Swagger Codegen](https://github.com/swagger-api/swagger-codegen/tree/3.0.0) to generate it based on the OpenApi specification of [eLabFTW REST API v2](https://doc.elabftw.net/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
~~~bash
# 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](./examples/00-getting-started.py).
Find more examples in the [examples folder](./examples).
## Basic concepts
~~~python
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
~~~bash
# 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
~~~
## Installing the library for dev
~~~bash
./helper.sh install-dev
~~~
## Publishing a new version
1. Bump version in config.json
2. Commit and push
3. Tag and push --tags
4. Create release on GitHub
# License
MIT, see [license file](./LICENSE).