# {py:mod}`nexusLIMS.exporters.destinations.elabftw`

```{py:module} nexusLIMS.exporters.destinations.elabftw
```

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

## Module Contents

### Classes

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

* - {py:obj}`ExtraFieldsGroup <nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup>`
  - ```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ExtraField <nexusLIMS.exporters.destinations.elabftw.ExtraField>`
  - ```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ELabFTWConfig <nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig>`
  - ```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ExtraFieldsMetadata <nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata>`
  - ```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`ELabFTWDestination <nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination>`
  - ```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} ExtraFieldsGroup(/, **data: typing.Any)
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup
:parser: autodoc2_docstrings_parser
```

````{py:attribute} id
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup.id

**Type:** int

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup.id
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} name
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup.name

**Type:** str

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup.name
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ExtraField(/, **data: typing.Any)
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField
:parser: autodoc2_docstrings_parser
```

````{py:attribute} type
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.type

**Type:** typing.Literal[text, date, datetime-local, email, number, select, radio, checkbox, url, time]

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.type
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} value
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.value

**Type:** str | int | float | bool

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.value
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} description
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.description

**Type:** str | None

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.description
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} position
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.position

**Type:** int | None

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.position
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} group_id
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.group_id

**Type:** int | None

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.group_id
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} required
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.required

**Type:** bool | None

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.required
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} blank_value_on_duplicate
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.blank_value_on_duplicate

**Type:** bool | None

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.blank_value_on_duplicate
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} model_config
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraField.model_config

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraField.model_config
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ELabFTWConfig(/, **data: typing.Any)
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig
:parser: autodoc2_docstrings_parser
```

````{py:attribute} display_main_text
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig.display_main_text

**Type:** bool

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig.display_main_text
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} extra_fields_groups
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig.extra_fields_groups

**Type:** list[nexusLIMS.exporters.destinations.elabftw.ExtraFieldsGroup]

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig.extra_fields_groups
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ExtraFieldsMetadata(/, **data: typing.Any)
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata

Bases: {py:obj}`pydantic.BaseModel`

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata
:parser: autodoc2_docstrings_parser
```

````{py:attribute} extra_fields
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata.extra_fields

**Type:** dict[str, nexusLIMS.exporters.destinations.elabftw.ExtraField]

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata.extra_fields
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} elabftw
:canonical: nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata.elabftw

**Type:** nexusLIMS.exporters.destinations.elabftw.ELabFTWConfig

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ExtraFieldsMetadata.elabftw
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} ELabFTWDestination
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination
:parser: autodoc2_docstrings_parser
```

````{py:attribute} name
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.name
:value: >
   'elabftw'

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.name
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} priority
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.priority
:value: >
   85

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.priority
:parser: autodoc2_docstrings_parser
```

````

````{py:property} enabled
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.enabled
:type: bool

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.enabled
:parser: autodoc2_docstrings_parser
```

````

````{py:method} validate_config() -> tuple[bool, str | None]
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.validate_config

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.validate_config
:parser: autodoc2_docstrings_parser
```

````

````{py:method} export(context: nexusLIMS.exporters.base.ExportContext) -> nexusLIMS.exporters.base.ExportResult
:canonical: nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.export

```{autodoc2-docstring} nexusLIMS.exporters.destinations.elabftw.ELabFTWDestination.export
:parser: autodoc2_docstrings_parser
```

````

`````