hivemind-websocket-protocol 0.2.2a1__tar.gz → 0.2.2a2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/PKG-INFO +1 -1
  2. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/README.md +22 -10
  3. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol/version.py +1 -1
  4. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/PKG-INFO +1 -1
  5. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/LICENSE.md +0 -0
  6. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol/__init__.py +0 -0
  7. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol/_client_ip.py +0 -0
  8. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/SOURCES.txt +0 -0
  9. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/dependency_links.txt +0 -0
  10. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/entry_points.txt +0 -0
  11. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/requires.txt +0 -0
  12. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/top_level.txt +0 -0
  13. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/pyproject.toml +0 -0
  14. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/setup.cfg +0 -0
  15. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/tests/test_client_ip.py +0 -0
  16. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/tests/test_decode_auth.py +0 -0
  17. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/tests/test_protocol_unit.py +0 -0
  18. {hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/tests/test_trusted_proxy_config.py +0 -0
{hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: hivemind-websocket-protocol
3
- Version: 0.2.2a1
3
+ Version: 0.2.2a2
4
4
  Summary: websocket network protocol for hivemind-core
5
5
  Author-email: jarbasAi <jarbasai@mailfence.com>
6
6
  License-Expression: Apache-2.0
{hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/README.md RENAMED
@@ -2,8 +2,8 @@
2
2
 
3
3
  WebSocket transport plugin for [hivemind-core](https://github.com/JarbasHiveMind/HiveMind-core).
4
4
 
5
- This is the **reference network protocol** for HiveMind. Satellites and clients connect to the hub
6
- over a persistent WebSocket connection (`ws://` or `wss://`). All HiveMessage frames are exchanged
5
+ This is the reference network protocol for HiveMind. Clients connect to `hivemind-core`
6
+ over a persistent WebSocket connection (`ws://` or `wss://`). All HiveMessage frames pass
7
7
  over this connection after an initial authentication handshake.
8
8
 
9
9
  ## Where it fits
@@ -100,11 +100,11 @@ export HIVEMIND_TRUSTED_CLIENT_IP_HEADERS="x-forwarded-for"
100
100
 
101
101
  | Key | Env var | Default | Description |
102
102
  |---|---|---|---|
103
- | `host` | — | `0.0.0.0` | Bind address. Falls back to `identity.default_master`. |
104
- | `port` | — | `5678` | Listen port. Falls back to `identity.default_port`. |
105
- | `ssl` | — | `false` | Enable TLS. |
106
- | `cert_dir` | — | `$XDG_DATA_HOME/hivemind` | Directory for TLS cert and key files. |
107
- | `cert_name` | — | `hivemind` | Base filename; produces `<name>.crt` and `<name>.key`. |
103
+ | `host` | n/a | `0.0.0.0` | Bind address. Falls back to `identity.default_master`. |
104
+ | `port` | n/a | `5678` | Listen port. Falls back to `identity.default_port`. |
105
+ | `ssl` | n/a | `false` | Enable TLS. |
106
+ | `cert_dir` | n/a | `$XDG_DATA_HOME/hivemind` | Directory for TLS cert and key files. |
107
+ | `cert_name` | n/a | `hivemind` | Base filename. It produces `<name>.crt` and `<name>.key`. |
108
108
  | `trusted_proxy_cidrs` | `HIVEMIND_TRUSTED_PROXY_CIDRS` | _(none)_ | Comma-separated CIDRs of trusted proxy addresses. |
109
109
  | `trusted_client_ip_headers` | `HIVEMIND_TRUSTED_CLIENT_IP_HEADERS` | `x-forwarded-for,x-real-ip` | Ordered list of headers to inspect for real client IP. |
110
110
 
@@ -113,6 +113,18 @@ tuple. The feature is disabled unless at least one CIDR is configured.
113
113
 
114
114
  ## Docs
115
115
 
116
- - [docs/architecture.md](docs/architecture.md) — handler lifecycle, authorization flow, IP resolution
117
- - [docs/configuration.md](docs/configuration.md) — full configuration reference
118
- - [docs/operations.md](docs/operations.md) — TLS, reverse proxy, authoring a transport plugin
116
+ - [docs/architecture.md](docs/architecture.md): handler lifecycle, authorization flow, IP resolution
117
+ - [docs/configuration.md](docs/configuration.md): full configuration reference
118
+ - [docs/operations.md](docs/operations.md): TLS, reverse proxy, authoring a transport plugin
119
+
120
+ ## Related projects
121
+
122
+ - [hivemind-core](https://github.com/JarbasHiveMind/HiveMind-core): the server that loads this plugin
123
+ - [hivemind-plugin-manager](https://github.com/JarbasHiveMind/hivemind-plugin-manager): plugin manager and abstract interfaces that define the `NetworkProtocol` base class
124
+ - [hivemind-http-protocol](https://github.com/JarbasHiveMind/hivemind-http-protocol): REST/HTTP alternative transport
125
+ - [hivemind-mqtt-protocol](https://github.com/JarbasHiveMind/hivemind-mqtt-protocol): MQTT broker-mediated alternative transport
126
+ - [hivemind-audio-binary-protocol](https://github.com/JarbasHiveMind/hivemind-audio-binary-protocol): binary audio streaming plugin, layered on top of a network protocol like this one
127
+
128
+ ## License
129
+
130
+ Apache-2.0. See [LICENSE.md](LICENSE.md).
{hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol/version.py RENAMED
@@ -2,7 +2,7 @@
2
2
  VERSION_MAJOR = 0
3
3
  VERSION_MINOR = 2
4
4
  VERSION_BUILD = 2
5
- VERSION_ALPHA = 1
5
+ VERSION_ALPHA = 2
6
6
  # END_VERSION_BLOCK
7
7
 
8
8
  __version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}" + (f"a{VERSION_ALPHA}" if VERSION_ALPHA else "")
{hivemind_websocket_protocol-0.2.2a1 → hivemind_websocket_protocol-0.2.2a2}/hivemind_websocket_protocol.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: hivemind-websocket-protocol
3
- Version: 0.2.2a1
3
+ Version: 0.2.2a2
4
4
  Summary: websocket network protocol for hivemind-core
5
5
  Author-email: jarbasAi <jarbasai@mailfence.com>
6
6
  License-Expression: Apache-2.0