Metadata-Version: 2.4
Name: openmodule
Version: 16.0.4
Summary: Libraries for developing the arivo openmodule
Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
Author: ARIVO
Author-email: support@arivo.co
License: GNU General Public License v2 (GPLv2)
Keywords: arivo openmodule
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE
Requires-Dist: pydantic~=2.0
Requires-Dist: sentry-sdk~=2.19.0
Requires-Dist: orjson<4,>=3.4.7
Requires-Dist: pyzmq~=26.2
Requires-Dist: pyyaml<7,>=5.0
Requires-Dist: editdistance>=0.8.1
Requires-Dist: sqlalchemy~=2.0.0
Requires-Dist: alembic<2,>=1.5.4
Requires-Dist: requests<3,>=2.22
Requires-Dist: python-dateutil>=2.7.2
Requires-Dist: python-dotenv~=0.15
Requires-Dist: arivo-settings_models<3,>=2.4.5
Provides-Extra: test
Requires-Dist: openmodule_test; extra == "test"
Provides-Extra: commands
Requires-Dist: openmodule_commands; extra == "commands"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

# OpenModule V2

[TOC]

## Quickstart

You can install this library via pip:
```bash
pip install openmodule
```

#### Development with Feature Branches

During development it might be necessary to install a version of openmodule, where no pip package exists.
Below you can find how to install a certain openmodule branch for your application with pip.

##### Openmodule

Bash command:
```bash
pip install "git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule"
```

requirements.txt:
```text
git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule
```

##### Openmodule Test

Bash command:
```bash
pip install "git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-test&subdirectory=openmodule_test"
```

requirements.txt:
```text
git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-test&subdirectory=openmodule_test
```

##### Openmodule Commands

Bash command:
```bash
pip install "git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-commands&subdirectory=openmodule_commands
```

requirements.txt:
```text
git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-commands&subdirectory=openmodule_commands
```

#### Local Development

Sometimes you want to test local changes of the Openmodule library in device services and therefore you can do a local
installation of the library. We use the
[editable installs](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs) of Pip for this.

##### Openmodule

bash command:
```bash
pip install -e <path_to_openmodule_root>
```

##### Openmodule Test

bash command:
```bash
pip install -e <path_to_openmodule_root>/openmodule_test/
```

##### Openmodule Commands

bash command:
```bash
pip install -e <path_to_openmodule_root>/openmodule_commands/
```

## Changes

- [Breaking Changes](docs/migrations.md)
- [Known Issues](docs/known_issues.md)

## Documentation

### Openmodule

- [Getting Started](docs/getting_started.md)
- [Coding Standard](docs/coding_standard.md)
- [Settings](docs/settings.md)
- [RPC](docs/rpc.md)
- [Health](docs/health.md)
- [Database](docs/database.md)
- [Eventlog](docs/event_sending.md)
- [Package Reader](docs/package_reader.md)
- [Anonymization](docs/anonymization.md)
- [Connection Status Listener](docs/connection_status_listener.md)
- [Settings Provider](docs/settings_provider.md)
- [Access Service](docs/access_service.md)
- [CSV Export](docs/csv_export.md)
- [Translations](docs/translation.md)
- [Utils](docs/utils.md)
- [Deprecated Features](docs/deprecated.md)
- [Testing](docs/testing.md)
- [File Cleanup](docs/cleanup.md)

### Openmodule Commands

- [Openmodule Commands](docs/commands.md)

