From 288b26ee078f900d8877d10e9598de6c4ef40f00 Mon Sep 17 00:00:00 2001 From: Elmehdi Aitbrahim Date: Sun, 16 Aug 2026 18:19:10 -0400 Subject: [PATCH] chore(license): add Apache-2.0 and declare it in all six distributions The repo has been public with no LICENSE, which is all-rights-reserved: nobody may legally fork or contribute (#277). Apache-2.0 over AGPL-3.0 and MIT for the patent grant and the warranty disclaimer -- reasoning recorded in CONTRIBUTING.md, and pinned by tests/test_licensing.py so a seventh distribution cannot ship unlicensed. --- CONTRIBUTING.md | 29 +++ LICENSE | 202 ++++++++++++++++++ packages/keel-broker-api/pyproject.toml | 1 + packages/keel-broker-coinbase/pyproject.toml | 1 + packages/keel-broker-fake/pyproject.toml | 1 + packages/keel-broker-robinhood/pyproject.toml | 1 + packages/keel-core/pyproject.toml | 1 + pyproject.toml | 1 + tests/test_licensing.py | 119 +++++++++++ 9 files changed, 356 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 tests/test_licensing.py diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f7c26f18 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to keel + +## Licence: why Apache-2.0 + +keel is licensed under [Apache-2.0](LICENSE). That was a decision, not a default, and the +reasoning is recorded here so it can be challenged in place rather than dug out of a merged +pull request. + +keel moves real money on a public exchange, so two properties of a licence matter more here +than they would for a typical library: + +- **The warranty disclaimer.** Apache-2.0 disclaims warranties and liability in explicit, + business-reviewed language. Software that places live orders needs that sentence to be as + strong as it can be. +- **The patent grant.** Contributors and users get an explicit grant. MIT offers none. + +The alternatives, and why they lost: + +| option | why it lost | +| --- | --- | +| **AGPL-3.0** | Prevents a closed hosted fork, but deters exactly the contributors this project wants — many employers forbid AGPL code on work machines, and keel's audience includes people reading the source at work. | +| **MIT** | Shortest and most familiar, but no patent grant and a thinner warranty disclaimer — both matter more than brevity here. | + +Apache-2.0 permits a closed hosted fork; we accept that. The compliance engine's value is the +audit trail it produces, which a hosted fork cannot hide. + +All six distributions cut from this repo (`keel-trader`, `keel-core`, and the four broker +packages) declare `license = "Apache-2.0"` in their `pyproject.toml`; `tests/test_licensing.py` +fails the build if a seventh distribution appears without it. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..ab908bab --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 CodeGate Software + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/packages/keel-broker-api/pyproject.toml b/packages/keel-broker-api/pyproject.toml index 55748ef2..18f7fa09 100644 --- a/packages/keel-broker-api/pyproject.toml +++ b/packages/keel-broker-api/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-broker-api" version = "0.7.1" description = "Broker port, domain types, capability model, and conformance suite for keel" +license = "Apache-2.0" requires-python = ">=3.14.4" # Pinned `==`: see the note in the root `pyproject.toml`. An unpinned sibling is satisfied by # whatever is already installed, which is how a deployment ends up running mixed versions. diff --git a/packages/keel-broker-coinbase/pyproject.toml b/packages/keel-broker-coinbase/pyproject.toml index 60681792..d5e80f76 100644 --- a/packages/keel-broker-coinbase/pyproject.toml +++ b/packages/keel-broker-coinbase/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-broker-coinbase" version = "0.7.1" description = "Coinbase Advanced Trade adapter for keel" +license = "Apache-2.0" requires-python = ">=3.14.4" # Siblings pinned `==` (see the root `pyproject.toml`); the third-party SDK is not, because it # has its own release cycle and is not cut from this repo. diff --git a/packages/keel-broker-fake/pyproject.toml b/packages/keel-broker-fake/pyproject.toml index 8664802d..a00ba2b1 100644 --- a/packages/keel-broker-fake/pyproject.toml +++ b/packages/keel-broker-fake/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-broker-fake" version = "0.7.1" description = "A deliberately divergent second broker adapter, to keep the port honest" +license = "Apache-2.0" requires-python = ">=3.14.4" # Pinned `==`: see the note in the root `pyproject.toml`. dependencies = ["keel-core==0.7.1", "keel-broker-api==0.7.1"] diff --git a/packages/keel-broker-robinhood/pyproject.toml b/packages/keel-broker-robinhood/pyproject.toml index 3a6d818d..d3d4f2a8 100644 --- a/packages/keel-broker-robinhood/pyproject.toml +++ b/packages/keel-broker-robinhood/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-broker-robinhood" version = "0.7.1" description = "Robinhood Crypto Trading API v2 adapter for keel" +license = "Apache-2.0" requires-python = ">=3.14.4" # `pynacl` is here and nowhere else in the workspace: Robinhood signs every request with an # Ed25519 key, which no other venue keel talks to requires. Keeping it a dependency of this diff --git a/packages/keel-core/pyproject.toml b/packages/keel-core/pyproject.toml index 2ef8b942..4f0113e6 100644 --- a/packages/keel-core/pyproject.toml +++ b/packages/keel-core/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-core" version = "0.7.1" description = "Shared domain types, configuration, and logging for keel" +license = "Apache-2.0" requires-python = ">=3.14.4" dependencies = ["pyyaml>=6.0.3", "python-dotenv>=1.2.2"] diff --git a/pyproject.toml b/pyproject.toml index 6b26ff6b..0e6273ae 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,6 +2,7 @@ name = "keel-trader" version = "0.7.1" description = "Offline-first, broker-agnostic, rule-based spot-trading agent (halal policy by default)" +license = "Apache-2.0" readme = "README.md" authors = [ { name = "CodeGate Software" } diff --git a/tests/test_licensing.py b/tests/test_licensing.py new file mode 100644 index 00000000..6e0e62d2 --- /dev/null +++ b/tests/test_licensing.py @@ -0,0 +1,119 @@ +"""The repo's licence: one grant, stated where people and tools look for it. + +The repository has been public from the start with no `LICENSE` file, which under copyright law +means all rights reserved: nobody may legally fork it, modify it, or contribute to it, and a +contributor who does has no rights to grant back. That blocks every remaining open-source phase +-- not as a matter of politeness but of law -- and it is invisible: the build is green, the repo +is readable, and every right is nonetheless reserved. + +The decision is Apache-2.0, over AGPL-3.0 and MIT, for two reasons that matter for software that +moves money: the explicit patent grant, and a warranty disclaimer written for exactly this case. +The reasoning lives in `CONTRIBUTING.md` rather than only in a merged PR, so the choice is +challengeable in place instead of implicit. + +These tests are a repo-hygiene check like `test_packaging.py`'s: they read the source tree, and +they exist because the failure mode is silent. A licence that drifts (a seventh distribution +added without the field, an appendix left filled with placeholders) produces a repo that looks +open and is not, which is worse than one that admits it is closed. +""" + +from __future__ import annotations + +import re +import tomllib +from pathlib import Path + +import pytest + +_ROOT = Path(__file__).resolve().parents[1] + +#: The canonical Apache-2.0 text opens with this banner, fixed by the licence itself. +_APACHE_BANNER = ( + " Apache License\n" + " Version 2.0, January 2004\n" + " http://www.apache.org/licenses/" +) + +#: Everything above this line is the licence's own text and must never be edited; everything +#: below is the appendix the copyright holder fills in. +_END_OF_TERMS = "END OF TERMS AND CONDITIONS" + + +def _license_text() -> str: + return (_ROOT / "LICENSE").read_text() + + +def _pyprojects() -> dict[str, dict]: + """distribution name -> parsed `pyproject.toml`, for the root and every workspace member.""" + found = {} + for path in [_ROOT / "pyproject.toml", *sorted((_ROOT / "packages").glob("*/pyproject.toml"))]: + data = tomllib.loads(path.read_text()) + found[data["project"]["name"]] = data + return found + + +def test_the_license_file_exists_and_is_canonical_apache_2_0(): + """`LICENSE` at the root must be the real Apache-2.0 text, not a paraphrase of it. + + Only the appendix is ours to fill. The banner and the END OF TERMS marker together bracket + the canonical text, so a different licence pasted in (MIT is the usual accident) fails even + though the file exists. + """ + text = _license_text() + assert text.startswith(_APACHE_BANNER), "LICENSE does not open with the Apache-2.0 banner" + assert _END_OF_TERMS in text, "LICENSE has no 'END OF TERMS AND CONDITIONS' marker" + + +def test_the_appendix_names_the_copyright_holder_and_no_placeholders_survive(): + """The appendix must be filled in. An unfilled one is the classic licence mistake. + + `[yyyy] [name of copyright owner]` left in the file grants nothing to anyone: a year is not + a date and a bracketed placeholder is not a person. GitHub still detects the licence, so + everything looks configured while the legal line is blank. + """ + appendix = _license_text().split(_END_OF_TERMS, 1)[1] + assert re.search(r"Copyright\s+2026\s+CodeGate Software", appendix), ( + "the Apache-2.0 appendix must name the copyright holder and year (2026, CodeGate Software)" + ) + # The appendix's how-to-apply instructions quote brackets legitimately; the failure to catch + # is a copyright line that was never filled in at all. + assert "Copyright [yyyy]" not in appendix, ( + "the appendix still carries the unfilled 'Copyright [yyyy] [name of copyright owner]' " + "template line -- an unfilled appendix grants nothing" + ) + + +@pytest.mark.parametrize("name", sorted(_pyprojects())) +def test_every_distribution_declares_the_same_spdx_licence(name): + """All six distributions must carry `license = "Apache-2.0"` (PEP 639 SPDX form). + + The string form is deliberate: the deprecated table form (`{ text = ... }`) lands in wheel + metadata as a free-text `License:` field, while the SPDX expression becomes + `License-Expression:`, which is what license-scanning tooling reads. A seventh distribution + added without the field ships as all-rights-reserved metadata beside permissively-licensed + siblings -- the same mixed-signal failure the version pins in `test_packaging.py` guard + against, one directory over. + """ + declared = _pyprojects()[name]["project"].get("license") + assert declared == "Apache-2.0", ( + f"{name} declares {declared!r}; every distribution cut from this repo must state " + "`license = \"Apache-2.0\"` (SPDX string, not the deprecated table form)" + ) + + +def test_the_licence_decision_is_recorded_where_it_can_be_challenged(): + """Why Apache-2.0 (and not AGPL-3.0 or MIT) must live in `CONTRIBUTING.md`, not in history. + + A licence chosen implicitly cannot be revisited explicitly: the reasoning that ruled out the + alternatives exists only in a merged PR's discussion, which nobody reading the repo years + later will find. #277's acceptance asks for exactly this -- decision and reasoning recorded, + not left implicit. + """ + contributing = _ROOT / "CONTRIBUTING.md" + assert contributing.is_file(), "no CONTRIBUTING.md; the licence decision is implicit" + text = contributing.read_text() + assert "Apache-2.0" in text + assert "AGPL" in text and "MIT" in text, ( + "the recorded decision must say why Apache-2.0 won over the alternatives (AGPL-3.0, MIT), " + "or it is a conclusion without its reasoning" + )