Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Collects Contributor License Agreement signatures in the pull request and
# records them in this repository. The signature file lives on its own branch
# so that the bot never has to push to a protected branch.
name: CLA

on:
issue_comment:
types: [created]
pull_request_target:
types: [opened, closed, synchronize]

permissions:
actions: write
contents: write
pull-requests: write
statuses: write

jobs:
cla:
runs-on: ubuntu-latest
steps:
- name: CLA Assistant
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
uses: contributor-assistant/github-action@v2.6.1

Check failure on line 24 in .github/workflows/cla.yml

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Use full commit SHA hash for this dependency.

See more on https://sonarcloud.io/project/issues?id=structured-world_coordinode-python&issues=AaBxyDU8y_01LXV_Rx8s&open=AaBxyDU8y_01LXV_Rx8s&pullRequest=91
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
path-to-signatures: 'signatures/v1/cla.json'
path-to-document: 'https://github.com/structured-world/coordinode-python/blob/main/CLA.md'
branch: 'cla-signatures'
# The copyright holder and the project's own automation do not sign.
allowlist: 'polaz,sw-release-bot[bot],dependabot[bot],bot*'
custom-notsigned-prcomment: 'Thank you for the contribution. Before it can be merged, please read the [Contributor License Agreement](https://github.com/structured-world/coordinode-python/blob/main/CLA.md) and, if you agree, reply to this comment with the sentence below.'
custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA'
custom-allsigned-prcomment: 'All contributors have signed the CLA.'
104 changes: 104 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# coordinode-python Contributor License Agreement

Version 1.0, 2026-09-05

Thank you for your interest in coordinode-python (the "Project"). This
agreement records the terms on which you contribute to it. Its purpose is to
let the Project be distributed under its licence, and under any other terms
the copyright holder may need for the CoordiNode product family, while you
keep every right in what you wrote.

Please read it in full before signing. You sign by replying to the CLA bot in
your pull request with the sentence it asks for; the signature is stored in
this repository under `signatures/`.

## 1. Definitions

"You" means the individual who submits a Contribution, or, where the
Contribution is made in the course of employment or on behalf of an entity,
that entity, in which case the person signing confirms they are authorised to
bind it.

"Contribution" means any original work of authorship, including source code,
documentation, tests, configuration and other material, that You intentionally
submit to the Project for inclusion in it, in any form, including through a
pull request. It excludes anything You mark conspicuously as "Not a
Contribution" at the time of submission.

"Copyright Holder" means Dmitry Prudnikov, the copyright holder in the Project
at the date of this agreement, and any person or entity to whom the copyright
in the Project is later assigned. A grant made to the Copyright Holder under
this agreement passes to such a successor without any further act by You.

## 2. Grant of copyright licence

Subject to the terms of this agreement, You grant to the Copyright Holder, and
to recipients of software distributed by the Copyright Holder, a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright
licence to reproduce, prepare derivative works of, publicly display, publicly
perform, sublicense and distribute Your Contributions and such derivative
works, under any licence terms the Copyright Holder chooses.

## 3. Grant of patent licence

Subject to the terms of this agreement, You grant to the Copyright Holder, and
to recipients of software distributed by the Copyright Holder, a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as
stated in this section) patent licence to make, have made, use, offer to sell,
sell, import and otherwise transfer the Project, where such licence applies
only to those patent claims licensable by You that are necessarily infringed
by Your Contribution alone or by combination of Your Contribution with the
Project to which it was submitted. If any entity institutes patent litigation
against You or any other entity alleging that Your Contribution, or the Project
to which You have contributed, constitutes direct or contributory patent
infringement, then any patent licences granted to that entity under this
agreement for that Contribution or Project terminate as of the date such
litigation is filed.

## 4. What You keep

You retain all right, title and interest in Your Contributions. Nothing in
this agreement transfers copyright to the Copyright Holder or restricts You
from using, licensing or distributing Your Contributions, alone or as part of
other work, on any terms You choose.

## 5. What the Copyright Holder promises

(a) Every Contribution accepted into the Project is and remains available
under the Apache License, Version 2.0, as part of the Project. The Copyright
Holder will not remove an accepted Contribution from the open-source Project
in order to offer it only under other terms.

(b) If the copyright in the Project is assigned to a successor, the successor
takes it subject to this section.

## 6. Your representations

You represent that:

(a) You are legally entitled to grant the licences above. If Your employer or
another person has rights in intellectual property You create that include
Your Contributions, You represent that they have waived those rights for the
Contribution, or that they have authorised You to make the Contribution on
their behalf, or that they have signed this agreement themselves.

(b) Each of Your Contributions is Your original creation. Where a
Contribution includes material that is not Your original creation, You
identify it as such in the submission, together with its source and licence,
and You have the right to submit it under this agreement.

(c) You will notify the Project if You become aware of any fact that would make
these representations inaccurate.

## 7. No warranty, no obligation to use

Except for the representations in section 6, You provide Your Contributions
"as is", without warranty of any kind. The Copyright Holder is under no
obligation to accept, use or distribute any Contribution.

## 8. Miscellaneous

This agreement is governed by the laws of Romania. It is the entire agreement
between You and the Copyright Holder concerning Your Contributions and
supersedes any earlier arrangement on the same subject. If any provision is
held unenforceable, the remainder stays in force.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing to coordinode-python

Contributions of every kind are welcome: bug reports, features, documentation,
examples.

## Development setup

```bash
git clone --recurse-submodules https://github.com/structured-world/coordinode-python.git
cd coordinode-python
uv sync
make test
```

`make test` regenerates the protobuf stubs and runs the unit suite. Integration
tests need a running CoordiNode server; see `docker-compose.yml`.

## Pull request process

1. Fork the repository and create a branch (`feat/description` or `fix/description`).
2. Make the change, with tests.
3. Make sure `ruff check`, `ruff format --check` and `make test` pass.
4. Write commit messages in the [Conventional Commits](https://www.conventionalcommits.org/) form.
5. Open a pull request describing what changed and why.

## Contributor License Agreement (CLA)

Before a first pull request can be merged, you sign the
[Contributor License Agreement](CLA.md). Signing happens in the pull request:
a bot posts the request, you reply with the sentence it asks for, and the
signature is recorded in `signatures/` in this repository. It is a one-time
step per GitHub account.

In short, the CLA says that you keep the copyright in your contribution, that
you grant the project's copyright holder (and any successor the copyright is
assigned to) a perpetual, worldwide, royalty-free, irrevocable licence to use,
modify, distribute and sublicense it under any terms, and that you are entitled
to make that grant. The project promises in return that your contribution stays
available under Apache-2.0 and that you remain free to do anything with your
own work.

If your employer owns what you write, ask them to confirm they permit the
contribution before you sign.

## Questions

Open an issue, or write to oss@sw.foundation.
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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 [yyyy] [name of copyright owner]

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.
Loading
Loading