mmrelay 1.2.6__py3-none-any.whl

mmrelay-1.2.6.dist-info/METADATA

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: mmrelay
+Version: 1.2.6
+Summary: Bridge between Meshtastic mesh networks and Matrix chat rooms
+Home-page: https://github.com/jeremiah-k/meshtastic-matrix-relay
+Author: Geoff Whittington, Jeremiah K., and contributors
+Author-email: jeremiahk@gmx.com
+Project-URL: Bug Tracker, https://github.com/jeremiah-k/meshtastic-matrix-relay/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Communications
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: meshtastic>=2.7.4
+Requires-Dist: Pillow==12.0.0
+Requires-Dist: matrix-nio==0.25.2
+Requires-Dist: matplotlib==3.10.7
+Requires-Dist: requests==2.32.5
+Requires-Dist: markdown==3.10
+Requires-Dist: bleach==6.3.0
+Requires-Dist: haversine==2.9.0
+Requires-Dist: schedule==1.2.2
+Requires-Dist: platformdirs==4.5.0
+Requires-Dist: py-staticmaps>=0.4.0
+Requires-Dist: psutil>=5.8.0
+Requires-Dist: rich==14.2.0
+Requires-Dist: setuptools>=80.9.0
+Provides-Extra: e2e
+Requires-Dist: matrix-nio[e2e]==0.25.2; extra == "e2e"
+Requires-Dist: python-olm; extra == "e2e"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# MMRelay
+
+## (Meshtastic <=> Matrix Relay)
+
+A powerful and easy-to-use relay between Meshtastic devices and Matrix chat rooms, allowing seamless communication across platforms. This opens the door for bridging Meshtastic devices to [many other platforms](https://matrix.org/bridges/).
+
+## Features
+
+- Bidirectional message relay between Meshtastic devices and Matrix chat rooms, capable of supporting multiple meshnets
+- Supports serial, network, and **_BLE (now too!)_** connections for Meshtastic devices
+- Custom fields are embedded in Matrix messages for relaying messages between multiple meshnets
+- Truncates long messages to fit within Meshtastic's payload size
+- SQLite database to store node information for improved functionality
+- Customizable logging level for easy debugging
+- Configurable through a simple YAML file
+- Supports mapping multiple rooms and channels 1:1
+- Relays messages to/from an MQTT broker, if configured in the Meshtastic firmware
+- ✨️ _Bidirectional replies and reactions support_ ✨️
+- ✨️ _Native Docker support_ ✨️
+- 🔐 **Matrix End-to-End Encryption (E2EE) support** 🔐 **NEW in v1.2!**
+
+**MMRelay v1.2** introduces **Matrix End-to-End Encryption** support for secure communication in encrypted rooms. Messages are automatically encrypted/decrypted when communicating with encrypted Matrix rooms, with simple setup using `mmrelay auth login` or automatic credentials creation from config.yaml.
+
+## Documentation
+
+MMRelay supports multiple deployment methods including Docker, pip installation, and standalone executables. For complete setup instructions and all deployment options, see:
+
+- [Installation Instructions](docs/INSTRUCTIONS.md) - Setup and configuration guide
+- [Docker Guide](docs/DOCKER.md) - Docker deployment methods
+- [What's New in v1.2](docs/WHATS_NEW_1.2.md) - New features and improvements
+- [E2EE Setup Guide](docs/E2EE.md) - Matrix End-to-End Encryption configuration
+
+---
+
+## Plugins
+
+MMRelay supports plugins for extending its functionality, enabling customization and enhancement of the relay to suit specific needs.
+
+### Core Plugins
+
+Generate a map of your nodes:
+
+![Map Plugin Screenshot](https://user-images.githubusercontent.com/1770544/235247915-47750b4f-d505-4792-a458-54a5f24c1523.png)
+
+Produce high-level details about your mesh:
+
+![Mesh Details Screenshot](https://user-images.githubusercontent.com/1770544/235245873-1ddc773b-a4cd-4c67-b0a5-b55a29504b73.png)
+
+See the full list of [core plugins](https://github.com/jeremiah-k/meshtastic-matrix-relay/wiki/Core-Plugins).
+
+### Community & Custom Plugins
+
+MMRelay's plugin system allows you to extend functionality in two ways:
+
+- **Custom Plugins**: Create personal plugins for your own use, stored in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Share your creations with others or use plugins developed by the community
+
+Check the [Community Plugins Development Guide](https://github.com/jeremiah-k/meshtastic-matrix-relay/wiki/Community-Plugin-Development-Guide) in our wiki to get started.
+
+✨️ Visit the [Community Plugins List](https://github.com/jeremiah-k/meshtastic-matrix-relay/wiki/Community-Plugin-List)!
+
+#### Install a Community Plugin
+
+Add the repository under the `community-plugins` section in `config.yaml`:
+
+```yaml
+community-plugins:
+  example-plugin:
+    active: true
+    repository: https://github.com/jeremiah-k/mmr-plugin-template.git
+    tag: main
+```
+
+### Plugin System
+
+Plugins make it easy to extend functionality without modifying the core program. MMRelay features a powerful plugin system with standardized locations:
+
+- **Core Plugins**: Pre-installed with the package
+- **Custom Plugins**: Your own plugins in `~/.mmrelay/plugins/custom/`
+- **Community Plugins**: Third-party plugins in `~/.mmrelay/plugins/community/`
+
+---
+
+## Getting Started with Matrix
+
+See our Wiki page [Getting Started With Matrix & MMRelay](https://github.com/jeremiah-k/meshtastic-matrix-relay/wiki/Getting-Started-With-Matrix-&-MM-Relay).
+
+---
+
+## Already on Matrix?
+
+Join us!
+
+- Our project's room: [#mmrelay:matrix.org](https://matrix.to/#/#mmrelay:matrix.org)
+- Part of the Meshnet Club Matrix space: [#meshnetclub:matrix.org](https://matrix.to/#/#meshnetclub:matrix.org)
+- Public Relay Room: [#mmrelay-relay-room:matrix.org](https://matrix.to/#/#mmrelay-relay-room:matrix.org) - Where we bridge multiple meshnets. Feel free to join us, with or without a relay!

mmrelay-1.2.6.dist-info/RECORD

@@ -0,0 +1,50 @@
+mmrelay/__init__.py,sha256=sBCmkS54Hk1DwEo9TgF9D8e8tAsnvTxl0iu30-GpR8Q,120
+mmrelay/__main__.py,sha256=Z839i5jxZmhdoPvR1-reWoQL4Xpmty81p8TsTKsJLC8,814
+mmrelay/cli.py,sha256=T4apzc8aS7smXh0bpqoMSDHpHOOxcjls9-vSB-ue5Nk,79543
+mmrelay/cli_utils.py,sha256=h0JKhU_sToO2_Orf9ddO8x07_L1k201V61yXydfU2es,28887
+mmrelay/config.py,sha256=H93dRHAsZOtPQmeO5RZd-S7qx5zsoAn7bt1GgXdOPqw,38285
+mmrelay/db_runtime.py,sha256=UkoVQNTF9ZGtwZbcBPPFRfF1CuUx343JjQuJVl6N_j4,12004
+mmrelay/db_utils.py,sha256=1KI4OfXgYES48ZxmMEtgx3Snu9y6GeBQWR6FKRdhXds,37136
+mmrelay/e2ee_utils.py,sha256=7cSb3F-FYqFcibSmb7eJzQJoRdq4Xk0_L5oppza3PHE,16914
+mmrelay/log_utils.py,sha256=CGTsHkeviCUKbe_SArYqOjPE5xRTslikMwzrag9LSFE,10290
+mmrelay/main.py,sha256=EFxFGG-_ba_9Z_GUshAft2E6kzxMaGd3ebT5ESh_l-4,17321
+mmrelay/matrix_utils.py,sha256=za9tc2yUNcBJe6_HAjOwHMnEG_DwXMrU0LE3Y-RA7kA,134422
+mmrelay/meshtastic_utils.py,sha256=iOFzMyYszhmR0eUVyITh0lKMHmtR0QaMt1pwmWz0CEk,50478
+mmrelay/message_queue.py,sha256=jyoaMDj0im7qNkk4XYK5Bn8Mz1ZGMaEblj_1tnlnewM,29181
+mmrelay/plugin_loader.py,sha256=SVDQOOPyfN-h57-KI_q-GqdRaptGjQZHuWj2_GSaNQs,79656
+mmrelay/runtime_utils.py,sha256=u8DtpfI-U7Ip3SAwjn214WfMTzc-xr5wffjN0i7WBZc,1261
+mmrelay/setup_utils.py,sha256=SCFGx9e1wHZt87u2JMAhPUYOy-Ui4eV3irmzy0Zh9lE,32727
+mmrelay/windows_utils.py,sha256=pgQh2_Uoy9o9X1GxlVtjQG0fvYdokqEb6-0kr8-NC1g,13032
+mmrelay/constants/__init__.py,sha256=zG8hYacc6Ggr_8f4H8Qp3aKwjycWUBRaZL_9vK8R_II,1863
+mmrelay/constants/app.py,sha256=iNKqQMp5WZSfzsuRXYZ00znVm_ZyfwqiWMQgAblG6rY,725
+mmrelay/constants/config.py,sha256=B1A_OZLLNXHM9rHOwc01ZaJBvFugR2eXlhYYl4nUxlY,2479
+mmrelay/constants/database.py,sha256=4cHfYfBePDUUtVSflrWyStcxKSQv7VE-jSrb1IzAjls,646
+mmrelay/constants/formats.py,sha256=cjbrfNNFCKoGSFsFHR1QQDEQudiGquA9MUapfm0_ZNI,494
+mmrelay/constants/messages.py,sha256=Reu_-6gZGGZQVP6BuqBm01QBhVTFjHVRQSPTUcQJG2Q,1531
+mmrelay/constants/network.py,sha256=Y9BWd4p-xdaKBwSzpHRKgLG4m_loHrvNah4-jjyiwlk,1285
+mmrelay/constants/plugins.py,sha256=0309Dv8W3Pwms5L29n0hr-qRZT1kBbzOoL6gCnoKRAY,1016
+mmrelay/constants/queue.py,sha256=cNK0cLsgBfQ6nVJm9_Scxj-ICv4RU6DU_PYsUwNyU_E,675
+mmrelay/plugins/__init__.py,sha256=KVMQIXRhe0wlGj4O3IZ0vOIQRKFkfPYejHXhJL17qrc,51
+mmrelay/plugins/base_plugin.py,sha256=hOGG6aHL21JS-TJf0HFcRsmKRJdtDmqt7Vru4vO968k,25931
+mmrelay/plugins/debug_plugin.py,sha256=adX0cRJHUEDLldajybPfiRDDlvytkZe5aN_dSgNKP2Y,870
+mmrelay/plugins/drop_plugin.py,sha256=x4S-e0Muun2Dy1H2qwRMTBB1ptLmy7ZZJhgPu-KefGs,5394
+mmrelay/plugins/health_plugin.py,sha256=svV_GfpAVL0QhiVzi3PVZ1mNpsOL1NHSmkRF-Mn_ExE,2250
+mmrelay/plugins/help_plugin.py,sha256=S7nBhsANK46Zv9wPHOVegPGcuYGMErBsxAnrRlSSCwg,2149
+mmrelay/plugins/map_plugin.py,sha256=eHV_t3TFcypBD4xT_OQx0hD6_iGkLJOADjwYVny0PvE,11292
+mmrelay/plugins/mesh_relay_plugin.py,sha256=OE07Kz5NvmyjXH3hneK5_eTPQ41mriJGZgsPcg-gpOQ,8428
+mmrelay/plugins/nodes_plugin.py,sha256=RDabzyG5hKG5aYWecsRUcLSjMCCv6Pngmq2Qpld1A1U,2903
+mmrelay/plugins/ping_plugin.py,sha256=o36pnmyfwOI4A2ZWPt2BYQVANaSgB7zLSfln5tXiOv4,4580
+mmrelay/plugins/telemetry_plugin.py,sha256=8SxWv4BLXMUTbiVaD3MjlMMdQyS7S_1OfLlVNAUMSO0,6306
+mmrelay/plugins/weather_plugin.py,sha256=ZmTNlkEjeCvZWHlO7VMend3vnj4h2qWeeU4RUQJY2vM,14183
+mmrelay/tools/__init__.py,sha256=udBuTe_y7K_B4-YSrPn6oW3ka8QUZme2w1uWQTGBBjo,867
+mmrelay/tools/mmrelay.service,sha256=6_TAskmTh9pXQSDRDeh0EXl2BfsUgm9Q3W9ob5tWCS8,600
+mmrelay/tools/sample-docker-compose-prebuilt.yaml,sha256=ytQRW882VAecbWO1LsRsU6UbudybNhC-iv2w0Fta1Ls,1368
+mmrelay/tools/sample-docker-compose.yaml,sha256=1UqZFvnJuhVwfNJ92C0qQ5KSdNRVjk8YbRNZgD8yF_M,1350
+mmrelay/tools/sample.env,sha256=RP-o3rX3jnEIrVG2rqCZq31O1yRXou4HcGrXWLVbKKw,311
+mmrelay/tools/sample_config.yaml,sha256=X8Gh2J6dkDurJ5KFsa4mm-Q2w8WfoyTTiHMw-cZz1Ow,6603
+mmrelay-1.2.6.dist-info/licenses/LICENSE,sha256=aB_07MhnK-bL5WLI1ucXLUSdW_yBVoepPRYB0kaAOl8,35204
+mmrelay-1.2.6.dist-info/METADATA,sha256=VK-mEZ5XFh91Mav4CfPgeRIhPXFaTBiPoP2k0RwzEmU,6119
+mmrelay-1.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mmrelay-1.2.6.dist-info/entry_points.txt,sha256=SJZwGUOEpQ-qx4H8UL4xKFnKeInGUaZNW1I0ddjK7Ws,45
+mmrelay-1.2.6.dist-info/top_level.txt,sha256=B_ZLCRm7NYAmI3PipRUyHGymP-C-q16LSeMGzmqJfo4,8
+mmrelay-1.2.6.dist-info/RECORD,,

mmrelay-1.2.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mmrelay-1.2.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mmrelay = mmrelay.cli:main