openmodule 13.4.0

Libraries for developing the arivo openmodule

OpenModule V2

[TOC]

Quickstart

You can install this library via pip:

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:

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

requirements.txt:

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

Openmodule Test

Bash command:

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

requirements.txt:

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

Openmodule Commands

Bash command:

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

requirements.txt:

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 of Pip for this.

Openmodule

bash command:

pip install -e <path_to_openmodule_root>

Openmodule Test

bash command:

pip install -e <path_to_openmodule_root>/openmodule_test/

Openmodule Commands

bash command:

pip install -e <path_to_openmodule_root>/openmodule_commands/

Changes

• Breaking Changes
• Known Issues

Documentation

Openmodule

• Getting Started
• Coding Standard
• Settings
• RPC
• Health
• Database
• Eventlog
• Package Reader
• Anonymization
• Connection Status Listener
• Settings Provider
• Access Service
• CSV Export
• Translations
• Utils
• Deprecated Features
• Testing
• File Cleanup

Openmodule Commands

• Openmodule Commands