elements-http-upload 0.2.0

A small convenience command-line utility to upload files via HTTP to an elements instance

Elements HTTP Upload Uitility

A small convenience command-line utility to upload files via HTTP to an elements instance

The command-line utility provided by this package has been tested with an ELEMENTS installation of v25.1.2. It mimics the upload of the web interface when uploading a file via HTTP(S). The file is split into chunks and uploaded one by one.

Note that the authors of this package are not affiliated in any kind with syslink GmbH (the copyright holders of elements).

Installation

Install this package in a dedicated python environment via

python -m venv venv
source venv/bin/activate
pip install elements-http-upload

To use this in a development setup, clone the source code from gitlab, start the development server and make your changes::

git clone https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload
cd elements-http-upload
python -m venv venv
source venv/bin/activate
make dev-install

More detailed installation instructions my be found in the docs.

Command-line usage

To upload a file, run

elements-http-upload -t <api-token> -H https://<elements-host> <local-file>:<remote-folder>/<remote-file>

An API token can be retrieved from the MAMS web interface by clicking your profile in the upper right corner and selecting the API tab. For further instructions, please have a look into the usage docs.

API usage

To use it from within python, see the following example and the usage docs for more

from elements_http_upload import upload

upload_info = {
    "source": "<local-file>",
    "target": "<remote-folder>/<remote-file>",
}

upload(
    upload_info,
    host="https://<elements-host>",
    api_token="<api-token>",
)

Technical note

This package has been generated from the template https://codebase.helmholtz.cloud/hcdc/software-templates/python-cli-package-template.git.

See the template repository for instructions on how to update the skeleton for this package.

License information

Copyright © 2025 Helmholtz-Zentrum hereon GmbH

Code files in this repository are licensed under the Apache-2.0, if not stated otherwise in the file.

Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.

Supplementary and configuration files in this repository are licensed under CC0-1.0, if not stated otherwise in the file.

Please check the header of the individual files for more detailed information.

License management

License management is handled with reuse. If you have any questions on this, please have a look into the contributing guide or contact the maintainers of elements-http-upload.