| Name | elabftwcontrol JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | Package for easily interacting with eLabFTW data from the cli and in Python |
| upload_time | 2024-11-20 11:04:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
science
lab notebooks
data management
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="left">
<a href="https://github.com/din14970/elabftwcontrol/actions"><img alt="Actions Status" src="https://github.com/din14970/elabftwcontrol/workflows/build/badge.svg"></a>
<a href="https://pypi.org/project/elabftwcontrol/"><img alt="PyPI" src="https://img.shields.io/pypi/v/elabftwcontrol.svg?style=flat"></a>
<a href='https://coveralls.io/github/din14970/elabftwcontrol?branch=master'><img src='https://coveralls.io/repos/github/din14970/elabftwcontrol/badge.svg?branch=master' alt='Coverage Status' /></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
# Elabftwcontrol
Elabftwcontrol is a library and CLI tool for interacting with the popular electronic lab notebook (ELN) software [eLabFTW](https://www.elabftw.net/).
It works by implementing higher level abstractions on top of the basic [api](https://github.com/elabftw/elabapi-python/).
It is a 3rd party tool not officially supported by eLabFTW maintainers.
Elabftwcontrol should not to be confused with [elabctl](https://github.com/elabftw/elabctl), the official tool for managing an eLabFTW installation.
Things elabftwcontrol aims to facilitate:
* downloading data from experiments and items in various (tabular) formats
* uploading or mutating experiments and items
* managing templates, item categories and other eLabFTW resources declaratively with yaml files (partially implemented)
⚠️ Elabftwcontrol is currently a work in progress and the API may be prone to change at any time
## Installation
You can install elabftwcontrol with pip (if you will use it as a library) or pipx (if you will use it via the CLI):
```
$ pip install elabftwcontrol
or
$ pipx install elabftwcontrol
```
## Usage
### CLI
Use the `elabftwctl` command to interact with eLabFTW. Check out the options via `--help`.
### Python
Documentation and examples are a work in progress, at this moment you will have to look through the code.
Raw data
{
"_id": null,
"home_page": null,
"name": "elabftwcontrol",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "science, lab notebooks, data management",
"author": null,
"author_email": "Niels Cautaerts <niels.cautaerts@vito.be>",
"download_url": "https://files.pythonhosted.org/packages/8b/29/441274dd38526cd575173ab03556416bd67994d41d4c52deb4dba74b9d11/elabftwcontrol-0.1.4.tar.gz",
"platform": null,
"description": "<p align=\"left\">\n<a href=\"https://github.com/din14970/elabftwcontrol/actions\"><img alt=\"Actions Status\" src=\"https://github.com/din14970/elabftwcontrol/workflows/build/badge.svg\"></a>\n<a href=\"https://pypi.org/project/elabftwcontrol/\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/elabftwcontrol.svg?style=flat\"></a>\n<a href='https://coveralls.io/github/din14970/elabftwcontrol?branch=master'><img src='https://coveralls.io/repos/github/din14970/elabftwcontrol/badge.svg?branch=master' alt='Coverage Status' /></a>\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n</p>\n\n# Elabftwcontrol\n\nElabftwcontrol is a library and CLI tool for interacting with the popular electronic lab notebook (ELN) software [eLabFTW](https://www.elabftw.net/).\nIt works by implementing higher level abstractions on top of the basic [api](https://github.com/elabftw/elabapi-python/).\nIt is a 3rd party tool not officially supported by eLabFTW maintainers.\nElabftwcontrol should not to be confused with [elabctl](https://github.com/elabftw/elabctl), the official tool for managing an eLabFTW installation.\n\nThings elabftwcontrol aims to facilitate:\n* downloading data from experiments and items in various (tabular) formats\n* uploading or mutating experiments and items\n* managing templates, item categories and other eLabFTW resources declaratively with yaml files (partially implemented)\n\n\u26a0\ufe0f Elabftwcontrol is currently a work in progress and the API may be prone to change at any time\n\n## Installation\nYou can install elabftwcontrol with pip (if you will use it as a library) or pipx (if you will use it via the CLI):\n\n```\n$ pip install elabftwcontrol\n\nor\n\n$ pipx install elabftwcontrol\n```\n\n## Usage\n\n### CLI\nUse the `elabftwctl` command to interact with eLabFTW. Check out the options via `--help`.\n\n### Python\nDocumentation and examples are a work in progress, at this moment you will have to look through the code.\n",
"bugtrack_url": null,
"license": null,
"summary": "Package for easily interacting with eLabFTW data from the cli and in Python",
"version": "0.1.4",
"project_urls": {
"Repository": "https://github.com/din14970/elabftwcontrol"
},
"split_keywords": [
"science",
" lab notebooks",
" data management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f281a41323a80d4f6f425aea17eb91eb3ca033e0828d5003484b7a9c358cbbf",
"md5": "2e60a87fd61fa502edaf500f370dd5e0",
"sha256": "21a01a4a4204b7580b5c641324652897a92dd3dec41467531ed3a6b905e7a55f"
},
"downloads": -1,
"filename": "elabftwcontrol-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e60a87fd61fa502edaf500f370dd5e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 52942,
"upload_time": "2024-11-20T11:04:05",
"upload_time_iso_8601": "2024-11-20T11:04:05.608121Z",
"url": "https://files.pythonhosted.org/packages/4f/28/1a41323a80d4f6f425aea17eb91eb3ca033e0828d5003484b7a9c358cbbf/elabftwcontrol-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b29441274dd38526cd575173ab03556416bd67994d41d4c52deb4dba74b9d11",
"md5": "e7b99875be177f955887574353cdae26",
"sha256": "2db67223f58955b9bc9840f65903cd34bae5b4e9e6b34d153769275281f6543b"
},
"downloads": -1,
"filename": "elabftwcontrol-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "e7b99875be177f955887574353cdae26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 170645,
"upload_time": "2024-11-20T11:04:08",
"upload_time_iso_8601": "2024-11-20T11:04:08.697983Z",
"url": "https://files.pythonhosted.org/packages/8b/29/441274dd38526cd575173ab03556416bd67994d41d4c52deb4dba74b9d11/elabftwcontrol-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 11:04:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "din14970",
"github_project": "elabftwcontrol",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "elabftwcontrol"
}
