<!--
SPDX-FileCopyrightText: 2025 Helmholtz-Zentrum hereon GmbH

SPDX-License-Identifier: CC-BY-4.0
-->

<!--
elements-http-upload documentation master file
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-->

# Welcome to elements-http-upload's documentation!

[![CI](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload/badges/main/pipeline.svg)](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload/-/pipelines?page=1&scope=all&ref=main)
[![Code coverage](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload/badges/main/coverage.svg)](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload/-/graphs/main/charts)
<!-- TODO: uncomment the following line when the package is registered at https://readthedocs.org -->
<!-- [![Docs](https://readthedocs.org/projects/elements-http-upload/badge/?version=latest)](https://elements-http-upload.readthedocs.io/en/latest/) -->
[![Latest Release](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload/-/badges/release.svg)](https://codebase.helmholtz.cloud/hcdc/elements/elements-http-upload)
<!-- TODO: uncomment the following line when the package is published at https://pypi.org -->
<!-- [![PyPI version](https://img.shields.io/pypi/v/elements-http-upload.svg)](https://pypi.python.org/pypi/elements-http-upload/) -->
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
<!-- TODO: uncomment the following line when the package is registered at https://api.reuse.software -->
<!-- [![REUSE status](https://api.reuse.software/badge/codebase.helmholtz.cloud/hcdc/elements/elements-http-upload)](https://api.reuse.software/info/codebase.helmholtz.cloud/hcdc/elements/elements-http-upload) -->

**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](https://elements.tv/) 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.

```{warning}

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

```{toctree}
---
maxdepth: 2
caption: "Contents:"
---
installation
usage
api
cli
contributing
```

## How to cite this software

```{eval-rst}
.. card:: Please do cite this software!

   .. tab-set::

      .. tab-item:: APA

         .. citation-info::
            :format: apalike

      .. tab-item:: BibTex

         .. citation-info::
            :format: bibtex

      .. tab-item:: RIS

         .. citation-info::
            :format: ris

      .. tab-item:: Endnote

         .. citation-info::
            :format: endnote

      .. tab-item:: CFF

         .. citation-info::
            :format: cff
```

# License information

Copyright © 2025 Helmholtz-Zentrum hereon GmbH

The source code of elements-http-upload is licensed under Apache-2.0.

If not stated otherwise, the contents of this documentation is licensed
under CC-BY-4.0.

## Indices and tables

-   {ref}`genindex`
-   {ref}`modindex`
-   {ref}`search`