mercury-proxy 2.0.0__tar.gz

mercury_proxy-2.0.0/CHANGELOG.md

@@ -0,0 +1,75 @@
+# История изменений
+
+Все заметные изменения этого проекта собраны в этом файле.
+
+Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/),
+проект следует [семантическому версионированию](https://semver.org/lang/ru/).
+
+## [2.0.0] - 2026-11-16
+
+Полная переработка под `mercury-base` 2.0 и `simple-socket-server` 2.2: приложение стало
+сервисом с конфигурацией, прокси переехал на новую версию сервера, а вместо веб-сокетов появился
+REST API над командами драйвера.
+
+### Добавлено
+
+- `Service` — жизненный цикл приложения: подключает счётчики, поднимает прокси и API, закрывает
+  всё в обратном порядке. Счётчик, которого не было при старте, не мешает запуску: его подключение
+  повторяется каждые `service.reconnect_interval` секунд, поэтому поздно подключённый USB-переходник
+  не требует перезапуска.
+- Конфигурация в YAML (`mercury_proxy/config.py`): счётчики с адресами, портами и параметрами
+  транспорта, включение прокси и API, адреса и порты, уровень и файл лога, интервал
+  переподключения. Значения проверяются при загрузке, неизвестные и повторяющиеся ключи — ошибка с
+  именем параметра, а не молчаливое игнорирование.
+- `mercury_proxy/log.py`: лог в `var/log/mercury-proxy.log` с прокруткой по размеру, необязательная
+  копия в stderr, уровень из конфигурации. Каталог создаётся при старте; если файл открыть не
+  удалось, сервис не запускается.
+- `MeterHub` (`mercury_proxy/meters.py`): набор счётчиков с блокировкой на каждый счётчик, потому
+  что шина передаёт один кадр за раз, а прокси и API работают в разных потоках. Маршрутизация
+  кадров: кадр на адрес счётчика уходит ему, широковещательный или незнакомый адрес — единственному
+  счётчику.
+- REST API (`mercury_proxy/api.py`) на стандартном `http.server`: `/v1.0`, `/v1.0/health`,
+  `/v1.0/meters`, `/v1.0/meters/{serial}` и `/v1.0/meters/{serial}/{command}` с параметрами в
+  строке запроса или в теле JSON. Ответы — `{"result": ...}`, ошибки — `{"error": "..."}` с кодами
+  400, 404, 502, 504 и 500.
+- Необязательный `api.token`: с ним API принимает только запросы с заголовком
+  `Authorization: Bearer ...` и отвечает `401` на остальные; без токена API открыт и при старте
+  пишет об этом предупреждение, если слушает не петлевой адрес. Ключ короче восьми символов
+  конфигурация не принимает.
+- `SocketProxy` (`mercury_proxy/proxy.py`) на `simple-socket-server` 2.2: кадр проверяется по CRC,
+  пересылается счётчику как есть и возвращается клиенту; HTTP-пробы закрываются; занятый адрес
+  сообщается вызывающему, а не теряется в потоке сервера.
+- Консольный скрипт `mercury-proxy` и `python -m mercury_proxy`: `-c/--config`, сигналы `SIGINT` и
+  `SIGTERM` останавливают сервис, код возврата `2` — конфигурация не прочитана, `1` — сервис не
+  смог работать.
+- `mercury-proxy --print-unit`: печатает готовый юнит systemd для этой установки (шаблон лежит
+  в пакете), поэтому `sudo tee` в `/etc/systemd/system` — единственный шаг, который остаётся
+  установщику.
+- `tests/`: набор pytest с настоящим TCP-сервером, который отвечает кадрами протокола Меркурий как
+  счётчик 206, поэтому `mercury-base` проверяется через сокет, а не через заглушку транспорта.
+- `CHANGELOG.md`, `.gitattributes` с `* text=auto eol=lf` и GitHub Actions: тесты на Python
+  3.9–3.15 и релиз по тегу с публикацией в PyPI.
+
+### Изменено
+
+- Упаковка переехала с `setup.py` на `pyproject.toml` (PEP 621, PEP 639): метаданные, сборка и
+  настройки pytest — в одном файле, `requirements.txt` больше нет. Версия берётся из
+  `mercury_proxy.__version__`.
+- Подсказки типов у каждого публичного имени, явный `__all__`, маркер `py.typed` (PEP 561).
+- Зависимости обновлены до `mercury-base~=2.0` и `simple-socket-server~=2.2`; `gevent`,
+  `Flask`, `Flask-SocketIO` и `waitress` больше не нужны.
+- Документация переписана: конфигурация, прокси, API, логирование, разработка и администрирование —
+  установка как сервис systemd, обновление пакета и юнита, логи и удаление.
+- Комментарии и докстринги, пример `config.yaml` и CI переведены на русский; примеры README
+  сверены с реализацией, в том числе на живом счётчике через старый прокси.
+
+### Удалено
+
+- `app.py` — его роль выполняет `Service` с консольным скриптом.
+- Веб-сокеты и Flask: API стал REST, а фильтрацию кадров по адресу делает прокси.
+
+### Ломающие изменения
+
+- Приложение запускается как сервис с файлом конфигурации; адрес и порт больше не задаются в коде.
+- REST API отвечает под `/v1.0` в формате `{"result": ...}` вместо веб-сокетов.
+- Python 3.9 или новее.

mercury_proxy-2.0.0/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright (c) 2023, webtoucher
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the names of Alexey Kuznetsov or webtoucher nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mercury_proxy-2.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include CHANGELOG.md
+include config.yaml
+include mercury_proxy/mercury-proxy.service