Skip to main content

Базовый модуль для коннекторов платформы Пересвет

Project description

Лицензия Apache 2.0 Python 3.12+ Coverage Status PyPI

prs-connector-core

Базовый модуль для создания коннекторов платформы Пересвет.

Коннектор - программа, которая может собирать данные с какого-либо источника и отправлять их в платформу. Также коннектор может отсеивать лишние данные и проводить обработку полученных данных с помощью языка JSONata.

Описание проекта

prs-connector-core — это Python-модуль, реализующий общую функциональность для коннекторов платформы Пересвет. Модуль предоставляет базовые классы, на основе которых можно создавать коннекторы для конкретных источников данных (OPC, Modbus, базы данных и др.).

Базовая функциональность и основные возможности:

  • Установление связи с платформой Пересвет по протоколу MQTT
  • Получение от платформы конфигурации:
    • настройка связи с источником данных,
    • параметры логирования,
    • список тегов, по которым необходимо получать данные
  • Поддержка защищённого канала связи с SSL/TLS
  • Преобразование данных через JSONata
  • Отсеивание лишних данных
  • Локальное кэширование конфигурации при потере связи с платформой
  • Буферизация данных при потере связи с платформой
  • Ротация логов

Работа с проектом

[!WARNING] Работа тестировалась на операционной системе Ubuntu.

Требования

  • Python 3.12 или новее
  • pip 21.3+
  • pipenv
  • pyenv

Работа над исходным кодом

Клонируйте репозиторий и выполните команды в консоли:

git clone git@github.com:mp-co-ru/prs-connector-core.git
cd prs-connector-core
pipenv install

Запуск тестов

$ pytest

Сборка пакета

$ python -m build

Версионирование

Версия пакета не хранится в коде вручную, а вычисляется при сборке из имени git-тега с помощью setuptools-scm.

  • В репозитории создаются теги вида v0.9.0, v1.0.0 и т.п. При сборке (python -m build) setuptools-scm по текущему коммиту и тегам определяет версию и генерирует файл prs_connector_core/_version.py (он в .gitignore и не коммитится).
  • В коде версия доступна как prs_connector_core.__version__: она берётся из сгенерированного _version.py, при его отсутствии — из метаданных установленного пакета, иначе используется "0.0.0.dev0" (например, при разработке без тега).
  • Релизы: при публикации Release в GitHub с тегом (например v0.9.0) workflow собирает пакет с этой версией и публикует его в PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prs_connector_core-0.11.0.tar.gz (124.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prs_connector_core-0.11.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file prs_connector_core-0.11.0.tar.gz.

File metadata

  • Download URL: prs_connector_core-0.11.0.tar.gz
  • Upload date:
  • Size: 124.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for prs_connector_core-0.11.0.tar.gz
Algorithm Hash digest
SHA256 f5e4bff05f8b8ed1aeaff516c0899bfb4c0862ca9bd36581a9095133e9682be6
MD5 7c26cef59c0c800223ff21643131e0f5
BLAKE2b-256 098a626630a40a5062e6886ad6b5b427687e4f75f4d3204cec30e8b11deb6c42

See more details on using hashes here.

Provenance

The following attestation bundles were made for prs_connector_core-0.11.0.tar.gz:

Publisher: release.yml on mp-co-ru/prs-connector-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file prs_connector_core-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for prs_connector_core-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d03afb97a926e32d74cb782dea838cbaccfb261c78cce8bce0d92d05e87cae4
MD5 959cdf9e96aa701fadfdc7c7c2e2768a
BLAKE2b-256 dcdd504a82ce42349fa883443df8ac0076cbefb6a24c66e904ab169153a8e18a

See more details on using hashes here.

Provenance

The following attestation bundles were made for prs_connector_core-0.11.0-py3-none-any.whl:

Publisher: release.yml on mp-co-ru/prs-connector-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page