# {py:mod}`nexusLIMS.utils.elabftw`

```{py:module} nexusLIMS.utils.elabftw
```

```{autodoc2-docstring} nexusLIMS.utils.elabftw
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ContentType <nexusLIMS.utils.elabftw.ContentType>`
  - ```{autodoc2-docstring} nexusLIMS.utils.elabftw.ContentType
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`State <nexusLIMS.utils.elabftw.State>`
  - ```{autodoc2-docstring} nexusLIMS.utils.elabftw.State
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ELabFTWClient <nexusLIMS.utils.elabftw.ELabFTWClient>`
  - ```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`get_elabftw_client <nexusLIMS.utils.elabftw.get_elabftw_client>`
  - ```{autodoc2-docstring} nexusLIMS.utils.elabftw.get_elabftw_client
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:exception} ELabFTWError()
:canonical: nexusLIMS.utils.elabftw.ELabFTWError

Bases: {py:obj}`Exception`

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWError
:parser: autodoc2_docstrings_parser
```

````

````{py:exception} ELabFTWAuthenticationError()
:canonical: nexusLIMS.utils.elabftw.ELabFTWAuthenticationError

Bases: {py:obj}`nexusLIMS.utils.elabftw.ELabFTWError`

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWAuthenticationError
:parser: autodoc2_docstrings_parser
```

````

````{py:exception} ELabFTWNotFoundError()
:canonical: nexusLIMS.utils.elabftw.ELabFTWNotFoundError

Bases: {py:obj}`nexusLIMS.utils.elabftw.ELabFTWError`

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWNotFoundError
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} ContentType()
:canonical: nexusLIMS.utils.elabftw.ContentType

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ContentType
:parser: autodoc2_docstrings_parser
```

````{py:attribute} HTML
:canonical: nexusLIMS.utils.elabftw.ContentType.HTML
:value: >
   1

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ContentType.HTML
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} MARKDOWN
:canonical: nexusLIMS.utils.elabftw.ContentType.MARKDOWN
:value: >
   2

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ContentType.MARKDOWN
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} State()
:canonical: nexusLIMS.utils.elabftw.State

Bases: {py:obj}`enum.IntEnum`

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State
:parser: autodoc2_docstrings_parser
```

````{py:attribute} Normal
:canonical: nexusLIMS.utils.elabftw.State.Normal
:value: >
   1

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Normal
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} Archived
:canonical: nexusLIMS.utils.elabftw.State.Archived
:value: >
   2

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Archived
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} Deleted
:canonical: nexusLIMS.utils.elabftw.State.Deleted
:value: >
   3

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Deleted
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} Pending
:canonical: nexusLIMS.utils.elabftw.State.Pending
:value: >
   4

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Pending
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} Processing
:canonical: nexusLIMS.utils.elabftw.State.Processing
:value: >
   5

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Processing
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} Error
:canonical: nexusLIMS.utils.elabftw.State.Error
:value: >
   6

```{autodoc2-docstring} nexusLIMS.utils.elabftw.State.Error
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ELabFTWClient(base_url: str, api_key: str)
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient
:parser: autodoc2_docstrings_parser
```

````{py:method} create_experiment(title: str, body: str | None = None, tags: list[str] | None = None, metadata: dict[str, typing.Any] | None = None, category: int | None = None, status: int | None = None, content_type: nexusLIMS.utils.elabftw.ContentType | None = None) -> dict[str, typing.Any]
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.create_experiment

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.create_experiment
:parser: autodoc2_docstrings_parser
```

````

````{py:method} get_experiment(experiment_id: int) -> dict[str, typing.Any]
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.get_experiment

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.get_experiment
:parser: autodoc2_docstrings_parser
```

````

````{py:method} list_experiments(limit: int = 15, offset: int = 0, query: str | None = None) -> list[dict[str, typing.Any]]
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.list_experiments

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.list_experiments
:parser: autodoc2_docstrings_parser
```

````

````{py:method} update_experiment(experiment_id: int, title: str | None = None, body: str | None = None, tags: list[str] | None = None, metadata: dict[str, typing.Any] | None = None, category: int | None = None, status: int | None = None) -> dict[str, typing.Any]
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.update_experiment

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.update_experiment
:parser: autodoc2_docstrings_parser
```

````

````{py:method} delete_experiment(experiment_id: int) -> None
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.delete_experiment

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.delete_experiment
:parser: autodoc2_docstrings_parser
```

````

````{py:method} upload_file_to_experiment(experiment_id: int, file_path: pathlib.Path | str, comment: str | None = None) -> dict[str, typing.Any]
:canonical: nexusLIMS.utils.elabftw.ELabFTWClient.upload_file_to_experiment

```{autodoc2-docstring} nexusLIMS.utils.elabftw.ELabFTWClient.upload_file_to_experiment
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:function} get_elabftw_client() -> nexusLIMS.utils.elabftw.ELabFTWClient
:canonical: nexusLIMS.utils.elabftw.get_elabftw_client

```{autodoc2-docstring} nexusLIMS.utils.elabftw.get_elabftw_client
:parser: autodoc2_docstrings_parser
```
````