rope-protocol 0.1.1__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 (43) hide show
  1. rope_protocol-0.1.1/LICENSE +201 -0
  2. rope_protocol-0.1.1/NOTICE +4 -0
  3. rope_protocol-0.1.1/PKG-INFO +171 -0
  4. rope_protocol-0.1.1/README.md +148 -0
  5. rope_protocol-0.1.1/pyproject.toml +41 -0
  6. rope_protocol-0.1.1/setup.cfg +4 -0
  7. rope_protocol-0.1.1/src/rope_protocol/__init__.py +17 -0
  8. rope_protocol-0.1.1/src/rope_protocol/channel.py +146 -0
  9. rope_protocol-0.1.1/src/rope_protocol/consumer.py +97 -0
  10. rope_protocol-0.1.1/src/rope_protocol/frames.py +340 -0
  11. rope_protocol-0.1.1/src/rope_protocol/hub.py +524 -0
  12. rope_protocol-0.1.1/src/rope_protocol/linksim.py +289 -0
  13. rope_protocol-0.1.1/src/rope_protocol/media.py +431 -0
  14. rope_protocol-0.1.1/src/rope_protocol/messages.py +313 -0
  15. rope_protocol-0.1.1/src/rope_protocol/participant.py +325 -0
  16. rope_protocol-0.1.1/src/rope_protocol/receiver.py +70 -0
  17. rope_protocol-0.1.1/src/rope_protocol/recipient.py +23 -0
  18. rope_protocol-0.1.1/src/rope_protocol/roster.py +88 -0
  19. rope_protocol-0.1.1/src/rope_protocol/sender.py +228 -0
  20. rope_protocol-0.1.1/src/rope_protocol/source.py +220 -0
  21. rope_protocol-0.1.1/src/rope_protocol/status.py +87 -0
  22. rope_protocol-0.1.1/src/rope_protocol/store.py +273 -0
  23. rope_protocol-0.1.1/src/rope_protocol.egg-info/PKG-INFO +171 -0
  24. rope_protocol-0.1.1/src/rope_protocol.egg-info/SOURCES.txt +41 -0
  25. rope_protocol-0.1.1/src/rope_protocol.egg-info/dependency_links.txt +1 -0
  26. rope_protocol-0.1.1/src/rope_protocol.egg-info/top_level.txt +1 -0
  27. rope_protocol-0.1.1/tests/test_channel.py +53 -0
  28. rope_protocol-0.1.1/tests/test_delivery.py +158 -0
  29. rope_protocol-0.1.1/tests/test_faults.py +272 -0
  30. rope_protocol-0.1.1/tests/test_frames.py +247 -0
  31. rope_protocol-0.1.1/tests/test_kill.py +90 -0
  32. rope_protocol-0.1.1/tests/test_linksim.py +213 -0
  33. rope_protocol-0.1.1/tests/test_media.py +351 -0
  34. rope_protocol-0.1.1/tests/test_media_repair.py +152 -0
  35. rope_protocol-0.1.1/tests/test_messages.py +251 -0
  36. rope_protocol-0.1.1/tests/test_package.py +35 -0
  37. rope_protocol-0.1.1/tests/test_relay.py +212 -0
  38. rope_protocol-0.1.1/tests/test_repair.py +127 -0
  39. rope_protocol-0.1.1/tests/test_roster.py +226 -0
  40. rope_protocol-0.1.1/tests/test_soak.py +32 -0
  41. rope_protocol-0.1.1/tests/test_status.py +42 -0
  42. rope_protocol-0.1.1/tests/test_store.py +109 -0
  43. rope_protocol-0.1.1/tests/test_transfer.py +290 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ ROPE – Resumable Offline Protocol for Emergencies
2
+ Copyright 2026 Daniel Fankhauser
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (see LICENSE).
@@ -0,0 +1,171 @@
1
+ Metadata-Version: 2.4
2
+ Name: rope-protocol
3
+ Version: 0.1.1
4
+ Summary: ROPE - Resumable Offline Protocol for Emergencies
5
+ Author: Daniel Fankhauser
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/d-fankhauser/rope
8
+ Project-URL: Specification, https://github.com/d-fankhauser/rope/blob/main/docs/spec.md
9
+ Project-URL: Changelog, https://github.com/d-fankhauser/rope/blob/main/CHANGELOG.md
10
+ Project-URL: Issues, https://github.com/d-fankhauser/rope/issues
11
+ Keywords: resumable,transfer,offline,custody,radio,store-and-forward
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Operating System :: Microsoft :: Windows
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Topic :: System :: Networking
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ License-File: NOTICE
22
+ Dynamic: license-file
23
+
24
+ <h1>
25
+ <picture>
26
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/d-fankhauser/rope/main/docs/images/rope-logo-dark.svg">
27
+ <img alt="ROPE" src="https://raw.githubusercontent.com/d-fankhauser/rope/main/docs/images/rope-logo.svg" height="72">
28
+ </picture>
29
+ </h1>
30
+
31
+ **Resumable Offline Protocol for Emergencies**
32
+
33
+ [![Tests](https://github.com/d-fankhauser/rope/actions/workflows/tests.yml/badge.svg)](https://github.com/d-fankhauser/rope/actions/workflows/tests.yml)
34
+ [![PyPI](https://img.shields.io/pypi/v/rope-protocol.svg)](https://pypi.org/project/rope-protocol/)
35
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/d-fankhauser/rope/blob/main/LICENSE)
36
+ ![Python 3.11+](https://img.shields.io/badge/Python-3.11%2B-blue.svg)
37
+ ![Status: early development](https://img.shields.io/badge/status-early_development-orange.svg)
38
+
39
+ ROPE transfers growing files and small messages between a small, closed group of devices over unreliable local
40
+ networks – radio links, Wi-Fi, no internet. Like a rescue line it holds the connection even when it is pulled:
41
+ an interruption costs time, never data.
42
+
43
+ > **Status:** early development. The [specification](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md) is draft 1 with a proposed wire format. Streams
44
+ > from sources via the hub to consumers work, including resume after disconnects and restarts and block repair, and
45
+ > so do messages with custody and offline media (e.g. a USB stick) as a second path. Interfaces will change.
46
+
47
+ ## Why
48
+
49
+ Field teams record large files (for example sonar recordings) on one device and want to evaluate them somewhere else
50
+ while they are still being recorded. The link in between drops out regularly, and there is no internet. Plain TCP does
51
+ not resume across connections and acknowledges data before it is safely stored; UDP loses data during outages. ROPE
52
+ adds the missing pieces on top of TCP, borrowing ideas – not code – from space communication (CFDP class 2, DTN custody
53
+ transfer).
54
+
55
+ ## Key properties
56
+
57
+ - **Resumable** – after any interruption, transfer continues from the last durably stored byte, never from zero.
58
+ - **Custody** – a receiver acknowledges only after the data is on disk (flush + fsync). The sender of a message
59
+ learns which recipients have it.
60
+ - **End-to-end verified** – checksums per segment and per complete file; bit-for-bit identical results. If bytes
61
+ changed after they were sent (e.g. a header updated at the end of a recording), only the differing blocks travel
62
+ again.
63
+ - **Never blocks the producer** – separate process, read-only file access without locks, bounded memory.
64
+ - **Offline** – no internet, no cloud, no external services.
65
+ - **Small groups** – star topology with a hub and a closed participant list: source, consumer and recipient roles,
66
+ names for the operator, and per consumer a choice of which streams it receives.
67
+ - **Application-agnostic core** – the core knows nothing about the data; applications define streams and messages.
68
+ - **Standard library only** – no third-party runtime dependencies.
69
+ - **Two paths** – the same segments and messages can also travel on removable media and mix with the network.
70
+
71
+ ROPE has **no encryption** by design and is meant for closed networks – see
72
+ [Security considerations](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md#11-security-considerations).
73
+
74
+ ## How it works (in short)
75
+
76
+ ```
77
+ source ──TCP──▶ hub ──TCP──▶ consumer(s)
78
+ │
79
+ └──TCP──▶ recipient(s) (messages only)
80
+ ```
81
+
82
+ 1. Every participant connects to the hub and greets it (identifier, role, protocol version). The hub checks its
83
+ participant list and tells everybody the names and roles of the group.
84
+ 2. The hub reports how far it has stored each stream (*committed offset*).
85
+ 3. The source sends segments from there; the hub writes, syncs, then acknowledges.
86
+ 4. When a stream is complete, a final checksum confirms the whole file; on a difference, only the differing blocks
87
+ are resent.
88
+ 5. On any disconnect: reconnect, greet, continue from the committed offset.
89
+ 6. Without a network, a participant and the hub exchange the same frames as bundles on removable media
90
+ (`export_media`, `import_media`); network and media mix freely.
91
+
92
+ Details: [docs/spec.md](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md).
93
+
94
+ ## Requirements
95
+
96
+ - Python 3.11 or newer, on Windows or Linux
97
+ - Nothing else at runtime
98
+
99
+ ## Installation
100
+
101
+ ```
102
+ python -m pip install rope-protocol
103
+ ```
104
+
105
+ The package is named `rope-protocol` (import `rope_protocol`), because the name `rope` on PyPI belongs to a
106
+ well-known refactoring library. Versions and changes: [CHANGELOG.md](https://github.com/d-fankhauser/rope/blob/main/CHANGELOG.md). While ROPE is in early
107
+ development, pin the version you tested with (e.g. `rope-protocol==0.1.1`).
108
+
109
+ For development:
110
+
111
+ ```
112
+ git clone https://github.com/d-fankhauser/rope.git
113
+ cd rope
114
+ python -m pip install pytest pyflakes
115
+ python -m pytest
116
+ ```
117
+
118
+ ### Simulating an unreliable link
119
+
120
+ No radio link at hand? The link simulator sits between two programs and adds bandwidth limits, latency, blackouts
121
+ and disconnects:
122
+
123
+ ```
124
+ python -m rope_protocol.linksim --listen 127.0.0.1:47311 --target 127.0.0.1:47310 --profile radio
125
+ ```
126
+
127
+ Profiles are `lan`, `wifi`, `radio` and `radio-bad`; `--seed` makes the fault schedule reproducible. All profile
128
+ values are assumptions until measured on real links (see spec §13).
129
+
130
+ ROPE's default port is **47310**; applications can override it.
131
+
132
+ ## Repository layout
133
+
134
+ | Path | Content |
135
+ |---|---|
136
+ | `docs/spec.md` | Protocol specification (draft) |
137
+ | `docs/decisions.md` | Decisions with date and reason |
138
+ | `docs/ideas.md` | Ideas not yet planned |
139
+ | `docs/images/` | Logo and symbol (SVG; light and dark variant) |
140
+ | `TASKS.md` | Task board |
141
+ | `CHANGELOG.md` | Changes per version |
142
+ | `src/rope_protocol/` | Package: frame codec (`frames.py`), link simulator (`linksim.py`), durable store (`store.py`), sending and receiving side of streams (`sender.py`, `receiver.py`), messages (`messages.py`), offline media (`media.py`), participant list (`roster.py`), participants (`hub.py`, `source.py`, `consumer.py`, `recipient.py`, base `participant.py`) |
143
+ | `tests/` | Unit tests and the fault-injection test bench (`framefault.py`, `test_faults.py`) |
144
+ | `AGENTS.md` | Guidelines for contributors and coding agents |
145
+
146
+ ## Testing
147
+
148
+ Every change runs `pyflakes` and `pytest` on Windows and Linux (Python 3.11–3.13). The test bench injects faults – a
149
+ simulated radio link with blackouts and disconnects, restarts, and one fault at every step of the procedure (connection
150
+ cut before or in the middle of a frame, frame duplicated or damaged, participant or hub restarted) – and checks that every file arrives bit-for-bit
151
+ identical and every message exactly once. The full set of faults at every step runs with:
152
+
153
+ ```
154
+ ROPE_SOAK=1 python -m pytest tests/test_faults.py
155
+ ```
156
+
157
+ ## Limitations
158
+
159
+ - Early development: streams, messages and offline media work. Interfaces and the wire format may still change.
160
+ - Not a general file synchronisation tool and not meant for the internet.
161
+ - No encryption, no authentication beyond a participant list.
162
+ - Not compatible with CFDP or DTN software; only the ideas are borrowed.
163
+
164
+ ## Contributing
165
+
166
+ Contributions are welcome – please read [CONTRIBUTING.md](https://github.com/d-fankhauser/rope/blob/main/CONTRIBUTING.md). Questions and ideas: open an issue.
167
+
168
+ ## License
169
+
170
+ Copyright 2026 Daniel Fankhauser. Licensed under the [Apache License, Version 2.0](https://github.com/d-fankhauser/rope/blob/main/LICENSE); see also [NOTICE](https://github.com/d-fankhauser/rope/blob/main/NOTICE).
171
+ The name "ROPE" in connection with this protocol is not covered by the licence (Apache-2.0, section 6).
@@ -0,0 +1,148 @@
1
+ <h1>
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/d-fankhauser/rope/main/docs/images/rope-logo-dark.svg">
4
+ <img alt="ROPE" src="https://raw.githubusercontent.com/d-fankhauser/rope/main/docs/images/rope-logo.svg" height="72">
5
+ </picture>
6
+ </h1>
7
+
8
+ **Resumable Offline Protocol for Emergencies**
9
+
10
+ [![Tests](https://github.com/d-fankhauser/rope/actions/workflows/tests.yml/badge.svg)](https://github.com/d-fankhauser/rope/actions/workflows/tests.yml)
11
+ [![PyPI](https://img.shields.io/pypi/v/rope-protocol.svg)](https://pypi.org/project/rope-protocol/)
12
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/d-fankhauser/rope/blob/main/LICENSE)
13
+ ![Python 3.11+](https://img.shields.io/badge/Python-3.11%2B-blue.svg)
14
+ ![Status: early development](https://img.shields.io/badge/status-early_development-orange.svg)
15
+
16
+ ROPE transfers growing files and small messages between a small, closed group of devices over unreliable local
17
+ networks – radio links, Wi-Fi, no internet. Like a rescue line it holds the connection even when it is pulled:
18
+ an interruption costs time, never data.
19
+
20
+ > **Status:** early development. The [specification](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md) is draft 1 with a proposed wire format. Streams
21
+ > from sources via the hub to consumers work, including resume after disconnects and restarts and block repair, and
22
+ > so do messages with custody and offline media (e.g. a USB stick) as a second path. Interfaces will change.
23
+
24
+ ## Why
25
+
26
+ Field teams record large files (for example sonar recordings) on one device and want to evaluate them somewhere else
27
+ while they are still being recorded. The link in between drops out regularly, and there is no internet. Plain TCP does
28
+ not resume across connections and acknowledges data before it is safely stored; UDP loses data during outages. ROPE
29
+ adds the missing pieces on top of TCP, borrowing ideas – not code – from space communication (CFDP class 2, DTN custody
30
+ transfer).
31
+
32
+ ## Key properties
33
+
34
+ - **Resumable** – after any interruption, transfer continues from the last durably stored byte, never from zero.
35
+ - **Custody** – a receiver acknowledges only after the data is on disk (flush + fsync). The sender of a message
36
+ learns which recipients have it.
37
+ - **End-to-end verified** – checksums per segment and per complete file; bit-for-bit identical results. If bytes
38
+ changed after they were sent (e.g. a header updated at the end of a recording), only the differing blocks travel
39
+ again.
40
+ - **Never blocks the producer** – separate process, read-only file access without locks, bounded memory.
41
+ - **Offline** – no internet, no cloud, no external services.
42
+ - **Small groups** – star topology with a hub and a closed participant list: source, consumer and recipient roles,
43
+ names for the operator, and per consumer a choice of which streams it receives.
44
+ - **Application-agnostic core** – the core knows nothing about the data; applications define streams and messages.
45
+ - **Standard library only** – no third-party runtime dependencies.
46
+ - **Two paths** – the same segments and messages can also travel on removable media and mix with the network.
47
+
48
+ ROPE has **no encryption** by design and is meant for closed networks – see
49
+ [Security considerations](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md#11-security-considerations).
50
+
51
+ ## How it works (in short)
52
+
53
+ ```
54
+ source ──TCP──▶ hub ──TCP──▶ consumer(s)
55
+ │
56
+ └──TCP──▶ recipient(s) (messages only)
57
+ ```
58
+
59
+ 1. Every participant connects to the hub and greets it (identifier, role, protocol version). The hub checks its
60
+ participant list and tells everybody the names and roles of the group.
61
+ 2. The hub reports how far it has stored each stream (*committed offset*).
62
+ 3. The source sends segments from there; the hub writes, syncs, then acknowledges.
63
+ 4. When a stream is complete, a final checksum confirms the whole file; on a difference, only the differing blocks
64
+ are resent.
65
+ 5. On any disconnect: reconnect, greet, continue from the committed offset.
66
+ 6. Without a network, a participant and the hub exchange the same frames as bundles on removable media
67
+ (`export_media`, `import_media`); network and media mix freely.
68
+
69
+ Details: [docs/spec.md](https://github.com/d-fankhauser/rope/blob/main/docs/spec.md).
70
+
71
+ ## Requirements
72
+
73
+ - Python 3.11 or newer, on Windows or Linux
74
+ - Nothing else at runtime
75
+
76
+ ## Installation
77
+
78
+ ```
79
+ python -m pip install rope-protocol
80
+ ```
81
+
82
+ The package is named `rope-protocol` (import `rope_protocol`), because the name `rope` on PyPI belongs to a
83
+ well-known refactoring library. Versions and changes: [CHANGELOG.md](https://github.com/d-fankhauser/rope/blob/main/CHANGELOG.md). While ROPE is in early
84
+ development, pin the version you tested with (e.g. `rope-protocol==0.1.1`).
85
+
86
+ For development:
87
+
88
+ ```
89
+ git clone https://github.com/d-fankhauser/rope.git
90
+ cd rope
91
+ python -m pip install pytest pyflakes
92
+ python -m pytest
93
+ ```
94
+
95
+ ### Simulating an unreliable link
96
+
97
+ No radio link at hand? The link simulator sits between two programs and adds bandwidth limits, latency, blackouts
98
+ and disconnects:
99
+
100
+ ```
101
+ python -m rope_protocol.linksim --listen 127.0.0.1:47311 --target 127.0.0.1:47310 --profile radio
102
+ ```
103
+
104
+ Profiles are `lan`, `wifi`, `radio` and `radio-bad`; `--seed` makes the fault schedule reproducible. All profile
105
+ values are assumptions until measured on real links (see spec §13).
106
+
107
+ ROPE's default port is **47310**; applications can override it.
108
+
109
+ ## Repository layout
110
+
111
+ | Path | Content |
112
+ |---|---|
113
+ | `docs/spec.md` | Protocol specification (draft) |
114
+ | `docs/decisions.md` | Decisions with date and reason |
115
+ | `docs/ideas.md` | Ideas not yet planned |
116
+ | `docs/images/` | Logo and symbol (SVG; light and dark variant) |
117
+ | `TASKS.md` | Task board |
118
+ | `CHANGELOG.md` | Changes per version |
119
+ | `src/rope_protocol/` | Package: frame codec (`frames.py`), link simulator (`linksim.py`), durable store (`store.py`), sending and receiving side of streams (`sender.py`, `receiver.py`), messages (`messages.py`), offline media (`media.py`), participant list (`roster.py`), participants (`hub.py`, `source.py`, `consumer.py`, `recipient.py`, base `participant.py`) |
120
+ | `tests/` | Unit tests and the fault-injection test bench (`framefault.py`, `test_faults.py`) |
121
+ | `AGENTS.md` | Guidelines for contributors and coding agents |
122
+
123
+ ## Testing
124
+
125
+ Every change runs `pyflakes` and `pytest` on Windows and Linux (Python 3.11–3.13). The test bench injects faults – a
126
+ simulated radio link with blackouts and disconnects, restarts, and one fault at every step of the procedure (connection
127
+ cut before or in the middle of a frame, frame duplicated or damaged, participant or hub restarted) – and checks that every file arrives bit-for-bit
128
+ identical and every message exactly once. The full set of faults at every step runs with:
129
+
130
+ ```
131
+ ROPE_SOAK=1 python -m pytest tests/test_faults.py
132
+ ```
133
+
134
+ ## Limitations
135
+
136
+ - Early development: streams, messages and offline media work. Interfaces and the wire format may still change.
137
+ - Not a general file synchronisation tool and not meant for the internet.
138
+ - No encryption, no authentication beyond a participant list.
139
+ - Not compatible with CFDP or DTN software; only the ideas are borrowed.
140
+
141
+ ## Contributing
142
+
143
+ Contributions are welcome – please read [CONTRIBUTING.md](https://github.com/d-fankhauser/rope/blob/main/CONTRIBUTING.md). Questions and ideas: open an issue.
144
+
145
+ ## License
146
+
147
+ Copyright 2026 Daniel Fankhauser. Licensed under the [Apache License, Version 2.0](https://github.com/d-fankhauser/rope/blob/main/LICENSE); see also [NOTICE](https://github.com/d-fankhauser/rope/blob/main/NOTICE).
148
+ The name "ROPE" in connection with this protocol is not covered by the licence (Apache-2.0, section 6).
@@ -0,0 +1,41 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "rope-protocol"
7
+ dynamic = ["version"]
8
+ description = "ROPE - Resumable Offline Protocol for Emergencies"
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ license-files = ["LICENSE", "NOTICE"]
12
+ authors = [{ name = "Daniel Fankhauser" }]
13
+ keywords = ["resumable", "transfer", "offline", "custody", "radio", "store-and-forward"]
14
+ requires-python = ">=3.11"
15
+ dependencies = []
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Developers",
19
+ "Operating System :: Microsoft :: Windows",
20
+ "Operating System :: POSIX :: Linux",
21
+ "Programming Language :: Python :: 3",
22
+ "Topic :: System :: Networking",
23
+ ]
24
+
25
+ [project.urls]
26
+ Homepage = "https://github.com/d-fankhauser/rope"
27
+ Specification = "https://github.com/d-fankhauser/rope/blob/main/docs/spec.md"
28
+ Changelog = "https://github.com/d-fankhauser/rope/blob/main/CHANGELOG.md"
29
+ Issues = "https://github.com/d-fankhauser/rope/issues"
30
+
31
+ [tool.setuptools.dynamic]
32
+ version = { attr = "rope_protocol.__version__" }
33
+
34
+ [tool.setuptools.packages.find]
35
+ where = ["src"]
36
+
37
+ [tool.pytest.ini_options]
38
+ pythonpath = ["src"]
39
+ testpaths = ["tests"]
40
+ # network tests: print every thread's stack instead of hanging silently
41
+ faulthandler_timeout = 120
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,17 @@
1
+ """ROPE - Resumable Offline Protocol for Emergencies.
2
+
3
+ Specification: docs/spec.md. Implemented so far: the frame codec of the wire format (``rope_protocol.frames``), the
4
+ link simulator for tests (``rope_protocol.linksim``) and streams from sources via a hub to consumers
5
+ (``rope_protocol.source``, ``rope_protocol.hub``, ``rope_protocol.consumer``; shared parts in ``sender``,
6
+ ``receiver``, ``participant``, ``store``), messages with custody (``rope_protocol.messages``,
7
+ ``rope_protocol.recipient``), offline media as a second path (``rope_protocol.media``) and the participant list
8
+ with names and a stream selection per consumer (``rope_protocol.roster``).
9
+ """
10
+
11
+ __version__ = "0.1.1"
12
+
13
+ #: Protocol version announced in the greeting (spec 14.5). Increase on incompatible changes.
14
+ PROTOCOL_VERSION = 1
15
+
16
+ #: Default TCP port of the hub (spec 14.1). Applications must allow overriding it.
17
+ DEFAULT_PORT = 47310