gossipmesh 0.1.0__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.
@@ -0,0 +1,24 @@
1
+ # https://editorconfig.org
2
+ root = true
3
+
4
+ [*]
5
+ charset = utf-8
6
+ end_of_line = lf
7
+ insert_final_newline = true
8
+ trim_trailing_whitespace = true
9
+ indent_style = space
10
+ indent_size = 4
11
+
12
+ [*.rs]
13
+ indent_size = 4
14
+ max_line_length = 100
15
+
16
+ [*.{js,ts,json,svelte,css,html,yml,yaml}]
17
+ indent_size = 2
18
+
19
+ [*.md]
20
+ # Markdown uses trailing double-space for hard line breaks.
21
+ trim_trailing_whitespace = false
22
+
23
+ [Makefile]
24
+ indent_style = tab
@@ -0,0 +1,20 @@
1
+ # Normalise line endings to LF everywhere, in the repository *and* in the
2
+ # working tree, on every platform. Without this, Git on Windows defaults to
3
+ # core.autocrlf=true and checks files out with CRLF, which breaks byte-exact
4
+ # test fixtures and shell scripts ("bad interpreter: /bin/sh^M").
5
+ # Modern Windows editors all handle LF, so forcing it costs nothing.
6
+ * text=auto eol=lf
7
+ *.sh text eol=lf
8
+ # batch files are the exception: cmd.exe misreads labels and long lines in
9
+ # LF-only .cmd/.bat files, so they check out with CRLF
10
+ *.cmd text eol=crlf
11
+ *.bat text eol=crlf
12
+
13
+ # Binary assets
14
+ *.png binary
15
+ *.ico binary
16
+ *.icns binary
17
+ *.gif binary
18
+ *.msi binary
19
+ *.exe binary
20
+ *.londopy binary
@@ -0,0 +1,10 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.egg-info/
4
+ dist/
5
+ build/
6
+ .pytest_cache/
7
+ .mypy_cache/
8
+ .ruff_cache/
9
+ .hypothesis/
10
+ *.pem
@@ -0,0 +1,36 @@
1
+ # Changelog
2
+
3
+ All notable changes to gossipmesh are listed here. The format follows
4
+ [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
5
+ [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The section for a version is
6
+ what appears on its GitHub release page. Validated in CI by
7
+ [patchnotes](https://github.com/Londopy/patchnotes).
8
+
9
+ ## [Unreleased]
10
+
11
+ ## [0.1.0] - 2026-11-19
12
+
13
+ ### Added
14
+
15
+ - Protocol version 1: random linear network coding over GF(256) in generations of up to 32
16
+ blocks, with seeded packets from complete stations and vector packets from partial relays.
17
+ The wire format is documented in `docs/protocol.md`.
18
+ - Station logic driven by neighbour rank announcements, with no routes or acknowledgements.
19
+ Status timers carry random jitter, so receivers that heard the same frames don't ask in
20
+ lockstep, which stalled the first bench run.
21
+ - `gossipmesh sim`: a simulator comparing coded gossip with the same protocol uncoded, plain
22
+ flooding and routed forwarding, with Direwolf-like channel access, collisions and hidden
23
+ stations.
24
+ - `gossipmesh node` for KISS TNCs over TCP or serial, tested on a three-station Direwolf bench.
25
+ - Optional Ed25519 message signatures, and `gossipmesh keygen`.
26
+ - Trickle-style beacons from stations holding a complete message, so a station that comes
27
+ on the air late still gets it. `--beacon` sets the interval or turns them off.
28
+ - `gossipmesh node --outbox` sends every file dropped into a folder while the node runs,
29
+ and short text messages are printed when they arrive.
30
+ - Relay controls for unattended nodes: `--log` with `gossipmesh decode`, `--blocklist` and
31
+ `--relay-trusted-only`.
32
+ - `docs/part97.md`: the US amateur rules that apply to unattended relaying, checked against
33
+ the current eCFR text.
34
+
35
+ [Unreleased]: https://github.com/Londopy/gossipmesh/compare/v0.1.0...HEAD
36
+ [0.1.0]: https://github.com/Londopy/gossipmesh/releases/tag/v0.1.0
@@ -0,0 +1,91 @@
1
+ # gossipmesh Contributor License Agreement
2
+
3
+ Thank you for contributing to gossipmesh. This agreement clarifies the rights
4
+ you grant on the material you contribute, so that the project can accept it,
5
+ distribute it, and keep its license. You keep the copyright in your
6
+ contribution; you are not asked to assign it.
7
+
8
+ gossipmesh is released under the Apache License 2.0 (`LICENSE`). This agreement lets the
9
+ project continue to distribute your contribution under that license, and, if
10
+ it ever needs to, under another open-source license approved by the Open
11
+ Source Initiative; it does not let the project take your contribution
12
+ private.
13
+
14
+ By opening a pull request and confirming the agreement in the pull request
15
+ (the CLA check asks you to), you accept the terms below for that
16
+ contribution and every later one you make to this repository.
17
+
18
+ ## 1. Definitions
19
+
20
+ "You" is the person or legal entity accepting this agreement. "Contribution"
21
+ is any original work of authorship, including changes to existing work, that
22
+ you intentionally submit to gossipmesh for inclusion: code, documentation,
23
+ examples, tests, translations. "Submit" means sending it to the project by
24
+ pull request, issue, or another channel the maintainers use. "Londopy" is
25
+ the project's copyright holder and maintainer.
26
+
27
+ ## 2. Copyright license
28
+
29
+ You grant Londopy and every recipient of gossipmesh a perpetual, worldwide,
30
+ non-exclusive, royalty-free, irrevocable copyright license to reproduce your
31
+ Contribution, prepare derivative works of it, display it, perform it,
32
+ sublicense it, and distribute it and the derivative works, under the
33
+ Apache License 2.0 or another OSI-approved open-source license.
34
+
35
+ ## 3. Patent license
36
+
37
+ You grant Londopy and every recipient of gossipmesh a perpetual, worldwide,
38
+ non-exclusive, royalty-free, irrevocable patent license to make, use, sell,
39
+ offer to sell, import, and otherwise transfer your Contribution, alone or
40
+ combined with gossipmesh, for any patent claims you can license that your
41
+ Contribution alone or in that combination necessarily infringes. If anyone
42
+ starts patent litigation claiming that your Contribution or gossipmesh infringes
43
+ a patent, the patent licenses granted to that party under this agreement end
44
+ on the day the litigation is filed.
45
+
46
+ ## 4. What you represent
47
+
48
+ - You are entitled to grant these licenses. If your employer has rights in
49
+ your Contribution, your employer has permitted you to submit it, or has
50
+ waived those rights, or has signed this agreement for you.
51
+ - The Contribution is your original work, except for material you clearly
52
+ identify as someone else's, together with its license and any
53
+ restrictions you know of. Third-party material must be under a license
54
+ compatible with the Apache License 2.0.
55
+ - You will tell the maintainers if you learn that any of the above is no
56
+ longer accurate.
57
+
58
+ ## 5. AI-assisted contributions
59
+
60
+ If you used an AI tool (a code generator, a language model, an assistant of
61
+ any kind) to produce any part of a Contribution, then:
62
+
63
+ - you disclose it in the pull request, in the form the pull request template
64
+ asks for: which tool, and what it did;
65
+ - you have read and understood what the tool produced, and you submit it as
66
+ your own work under this agreement, with the same representations as for
67
+ anything you wrote yourself; the tool is not a party to this agreement and
68
+ is not an author of the Contribution;
69
+ - you have not included output that reproduces someone else's work under a
70
+ license incompatible with the Apache License 2.0, or that you have no right to license.
71
+
72
+ The project accepts AI-assisted contributions on these terms and rejects
73
+ undisclosed ones. Authorship in commits and files names people; a tool is
74
+ not listed as an author or co-author.
75
+
76
+ ## 6. No warranty, no obligation
77
+
78
+ Your Contribution is provided as is, without warranty of any kind, unless
79
+ you say otherwise in writing. You are not required to support it, and the
80
+ project is not required to accept it: the maintainers decide what merges.
81
+
82
+ ## 7. Signing
83
+
84
+ The CLA check on your first pull request asks you to comment with the
85
+ sentence it shows; that comment is your acceptance, recorded with your
86
+ GitHub account on the `cla-signatures` branch of this repository. A company
87
+ contributing on behalf of its employees can instead open an issue naming
88
+ the covered GitHub accounts, or contact the maintainer (Londopy) through
89
+ GitHub.
90
+
91
+ Questions go in an issue.
@@ -0,0 +1,58 @@
1
+ # Contributing to gossipmesh
2
+
3
+ Issues and pull requests are welcome.
4
+
5
+ ## Before you open a pull request
6
+
7
+ - Set up: `python -m venv .venv`, then `pip install -e ".[all,dev]"` inside it.
8
+ - Test: `pytest` (`pytest -m "not slow"` skips the full simulator runs).
9
+ - Lint: `ruff check .`, `ruff format --check .` and `mypy gossipmesh tests`.
10
+ - If you change anything on the wire, update [docs/protocol.md](docs/protocol.md) in the same
11
+ pull request. The spec has to stay public and match the code, because Part 97 requires
12
+ the code to be documented.
13
+ - If you change station behaviour, run `gossipmesh sim --runs 10` before and after, and put
14
+ both tables in the pull request.
15
+ - Add a line under `## [Unreleased]` in [CHANGELOG.md](CHANGELOG.md) if the change is
16
+ something a user would notice. The changelog is checked in CI by
17
+ [patchnotes](https://github.com/Londopy/patchnotes).
18
+ - Fill in the pull request template, including the **AI tools** section.
19
+ - Sign the [CLA](CLA.md) when the check asks (once).
20
+
21
+ ## AI-assisted contributions
22
+
23
+ You may use AI tools to help write a contribution. Three rules, which the
24
+ CLA makes binding:
25
+
26
+ - **Say so in the pull request.** The template has a section for it: which
27
+ tool, and what it did (drafted the change, wrote the tests, explained the
28
+ code, translated the docs, wrote the description). "None" is a fine answer.
29
+ A check on every pull request fails until the section is filled in.
30
+ - **You are the author.** Read and understand everything the tool produced
31
+ before you submit it; you are answerable for it in review exactly as for
32
+ code you typed. A pull request whose author cannot explain a change is
33
+ sent back. Commits and files name people, not tools: an AI tool is never
34
+ listed as an author or co-author, and commits carry no "Generated with"
35
+ footers. The check rejects both.
36
+ - **No laundering.** Do not submit output that reproduces someone else's
37
+ work under a license incompatible with this project's license, or that you
38
+ have no right to license. If a tool hands you a recognizable chunk of
39
+ another project, leave it out.
40
+
41
+ An undisclosed AI-assisted contribution is closed when discovered, whatever
42
+ its quality. Disclosed ones are reviewed like any other, and labeled
43
+ `ai-assisted`: the tests are the bar.
44
+
45
+ The same goes for issues: if an AI tool wrote or summarized a bug report,
46
+ say so in it.
47
+
48
+ ## Contributor License Agreement
49
+
50
+ Your first pull request gets a comment from the CLA check asking you to
51
+ accept [`CLA.md`](CLA.md) by replying with one sentence. You keep the
52
+ copyright in your work; the agreement gives the project a license to
53
+ distribute it under its license (or another OSI-approved license, never a
54
+ proprietary one) and a patent license for what your contribution
55
+ necessarily uses, and it records that the work is yours to give,
56
+ AI-assisted or not. Every author of a commit in the pull request signs once,
57
+ and that covers all their later pull requests. Companies contributing on
58
+ behalf of employees can open an issue naming the covered accounts instead.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ https://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ https://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.