# 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)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/arivo-public/device-python/openmodule.git",
"name": "openmodule",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "arivo openmodule",
"author": "ARIVO",
"author_email": "support@arivo.co",
"download_url": "https://files.pythonhosted.org/packages/ae/77/5358bcee610ec2980c5a1f1cda3cb6db644f5a95777945b1b1843b0b3e0b/openmodule-13.5.0.tar.gz",
"platform": null,
"description": "# OpenModule V2\n\n[TOC]\n\n## Quickstart\n\nYou can install this library via pip:\n```bash\npip install openmodule\n```\n\n#### Development with Feature Branches\n\nDuring development it might be necessary to install a version of openmodule, where no pip package exists.\nBelow you can find how to install a certain openmodule branch for your application with pip.\n\n##### Openmodule\n\nBash command:\n```bash\npip install \"git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule\"\n```\n\nrequirements.txt:\n```text\ngit+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule\n```\n\n##### Openmodule Test\n\nBash command:\n```bash\npip install \"git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-test&subdirectory=openmodule_test\"\n```\n\nrequirements.txt:\n```text\ngit+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-test&subdirectory=openmodule_test\n```\n\n##### Openmodule Commands\n\nBash command:\n```bash\npip install \"git+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-commands&subdirectory=openmodule_commands\n```\n\nrequirements.txt:\n```text\ngit+https://gitlab.com/arivo-public/device-python/openmodule@<branch>#egg=openmodule-commands&subdirectory=openmodule_commands\n```\n\n#### Local Development\n\nSometimes you want to test local changes of the Openmodule library in device services and therefore you can do a local\ninstallation of the library. We use the\n[editable installs](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs) of Pip for this.\n\n##### Openmodule\n\nbash command:\n```bash\npip install -e <path_to_openmodule_root>\n```\n\n##### Openmodule Test\n\nbash command:\n```bash\npip install -e <path_to_openmodule_root>/openmodule_test/\n```\n\n##### Openmodule Commands\n\nbash command:\n```bash\npip install -e <path_to_openmodule_root>/openmodule_commands/\n```\n\n## Changes\n\n- [Breaking Changes](docs/migrations.md)\n- [Known Issues](docs/known_issues.md)\n\n## Documentation\n\n### Openmodule\n\n- [Getting Started](docs/getting_started.md)\n- [Coding Standard](docs/coding_standard.md)\n- [Settings](docs/settings.md)\n- [RPC](docs/rpc.md)\n- [Health](docs/health.md)\n- [Database](docs/database.md)\n- [Eventlog](docs/event_sending.md)\n- [Package Reader](docs/package_reader.md)\n- [Anonymization](docs/anonymization.md)\n- [Connection Status Listener](docs/connection_status_listener.md)\n- [Settings Provider](docs/settings_provider.md)\n- [Access Service](docs/access_service.md)\n- [CSV Export](docs/csv_export.md)\n- [Translations](docs/translation.md)\n- [Utils](docs/utils.md)\n- [Deprecated Features](docs/deprecated.md)\n- [Testing](docs/testing.md)\n- [File Cleanup](docs/cleanup.md)\n\n### Openmodule Commands\n\n- [Openmodule Commands](docs/commands.md)\n\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v2 (GPLv2)",
"summary": "Libraries for developing the arivo openmodule",
"version": "13.5.0",
"project_urls": {
"Homepage": "https://gitlab.com/arivo-public/device-python/openmodule.git"
},
"split_keywords": [
"arivo",
"openmodule"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41c66f55136e43ffcbd874f3fb71980f8d138d40d4ef59e2c8d1319e0dc5f37b",
"md5": "1d3d6c8fe684f51cd231b4505e2b56cf",
"sha256": "1823d05b1c98359f4c53b7353123883a1b623526a8bcb02b2ed63f4a3d4cd48d"
},
"downloads": -1,
"filename": "openmodule-13.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d3d6c8fe684f51cd231b4505e2b56cf",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 86468,
"upload_time": "2024-06-06T08:34:38",
"upload_time_iso_8601": "2024-06-06T08:34:38.747296Z",
"url": "https://files.pythonhosted.org/packages/41/c6/6f55136e43ffcbd874f3fb71980f8d138d40d4ef59e2c8d1319e0dc5f37b/openmodule-13.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae775358bcee610ec2980c5a1f1cda3cb6db644f5a95777945b1b1843b0b3e0b",
"md5": "ecfb61d0a2d131d621a7817e59bf693e",
"sha256": "59e87cd26ad9aa86ce7c204772cbf38f7237b68a70f1d9283d755c134c7792b7"
},
"downloads": -1,
"filename": "openmodule-13.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ecfb61d0a2d131d621a7817e59bf693e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 240993,
"upload_time": "2024-06-06T08:34:42",
"upload_time_iso_8601": "2024-06-06T08:34:42.266459Z",
"url": "https://files.pythonhosted.org/packages/ae/77/5358bcee610ec2980c5a1f1cda3cb6db644f5a95777945b1b1843b0b3e0b/openmodule-13.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 08:34:42",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "arivo-public",
"gitlab_project": "device-python",
"lcname": "openmodule"
}
JSON