steersync 0.2.0__py3-none-any.whl

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,342 @@
1
+ Metadata-Version: 2.5
2
+ Name: steersync
3
+ Version: 0.2.0
4
+ Summary: Sync Kiro steering documents between developer machines and a central git repository.
5
+ Project-URL: Homepage, https://github.com/SCGIS-Wales/steersync
6
+ Project-URL: Repository, https://github.com/SCGIS-Wales/steersync
7
+ Project-URL: Issues, https://github.com/SCGIS-Wales/steersync/issues
8
+ Project-URL: Changelog, https://github.com/SCGIS-Wales/steersync/blob/main/CHANGELOG.md
9
+ Author-email: Dejan Gregor <dejan.gregor@gmail.com>
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: developer-experience,git,kiro,mcp,pre-push,steering
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Environment :: Console
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Topic :: Software Development :: Version Control :: Git
21
+ Classifier: Typing :: Typed
22
+ Requires-Python: >=3.14
23
+ Requires-Dist: click<9,>=8.5
24
+ Requires-Dist: pydantic<3,>=2.14
25
+ Requires-Dist: pymarkdownlnt<1,>=0.9.40
26
+ Requires-Dist: python-frontmatter<2,>=1.3
27
+ Requires-Dist: pyyaml<7,>=6.0.3
28
+ Provides-Extra: mcp
29
+ Requires-Dist: mcp<3,>=2.3; extra == 'mcp'
30
+ Description-Content-Type: text/markdown
31
+
32
+ # steersync
33
+
34
+ Sync the whole [Kiro](https://kiro.dev) `.kiro/` configuration, steering, specs, skills,
35
+ agents, hooks and settings, between developer machines and a central git repository. A plain
36
+ Python CLI runs from a git pre-push hook and shells out to the `git` binary, so your existing
37
+ SSH agent or credential helper does the authentication. An MCP server and Kiro session hooks
38
+ are optional layers on top of the same core.
39
+
40
+ Kiro CLI has no built in command to import or sync its configuration from a remote
41
+ repository; its guidance is to copy files from a central repository into `~/.kiro/` and
42
+ `.kiro/`. steersync automates that in both directions for every *collection* it is
43
+ configured with:
44
+
45
+ | Direction | Command | What happens |
46
+ |---|---|---|
47
+ | Central to local | `steersync pull` | Shallow clones or refreshes the central repository, writes `global/<collection>/` to `~/.kiro/<dir>/` and `projects/<slug>/<collection>/` to `<repo>/.kiro/<dir>/`, prunes files removed centrally, keeps files you edited locally. |
48
+ | Local to central | `steersync push` | Lints every collection with its own profile, pushes them together to one branch named after the project, user and content hash, and sends GitLab push options so a merge request is opened for review. |
49
+
50
+ ## Collections
51
+
52
+ A collection is one kind of Kiro content. The packaged defaults cover the full `.kiro/`
53
+ layout; each one is configurable and new ones are added with a single YAML block.
54
+
55
+ | Collection | Workspace | Global (`~/.kiro`) | Central directory | Files | Lint profile |
56
+ |---|---|---|---|---|---|
57
+ | `steering` | `.kiro/steering` | `steering` | `steering/` | `**/*.md` | `steering`: Kiro front matter, references, secrets, markdown |
58
+ | `specs` | `.kiro/specs` | none | `specs/` | `**/*.md` | `markdown`: secrets and markdown style |
59
+ | `skills` | `.kiro/skills` | `skills` | `skills/` | everything (`SKILL.md`, `scripts/`, `references/`, `assets/`) | `skill`: `SKILL.md` needs `name` and `description`, secrets in scripts |
60
+ | `agents` | `.kiro/agents` | `agents` | `agents/` | `**/*.json`, `**/*.md` | `agent`: valid JSON with a `name`, flags deprecated `toolsSettings` |
61
+ | `hooks` | `.kiro/hooks` | `hooks` | `hooks/` | `**/*.json` | `hooks`: `version`, `hooks[]` with `name`, `trigger`, `action` |
62
+ | `settings` | `.kiro/settings` | none | `settings/` | `lsp.json`, `mcp.json` | `json`: valid JSON and secrets |
63
+
64
+ Execute bits on skill scripts survive the round trip, hidden files are never synced, and
65
+ files a collection's patterns do not select are never touched on either side. Limit any
66
+ command to some collections with `--collection NAME` (repeatable), list them with
67
+ `steersync config collections`, and see [docs/central-layout.md](docs/central-layout.md) for
68
+ a worked example of a full `.kiro/` tree in the central repository.
69
+
70
+ ## Install
71
+
72
+ Requires Python 3.14 or newer and git 2.18 or newer. Every
73
+ [GitHub release](https://github.com/SCGIS-Wales/steersync/releases) carries the wheel, the
74
+ sdist and a `SHA256SUMS` file, with signed build provenance.
75
+
76
+ ```bash
77
+ VERSION=0.2.0
78
+ uv tool install "https://github.com/SCGIS-Wales/steersync/releases/download/v${VERSION}/steersync-${VERSION}-py3-none-any.whl"
79
+ # with the MCP server
80
+ uv tool install "steersync[mcp] @ https://github.com/SCGIS-Wales/steersync/releases/download/v${VERSION}/steersync-${VERSION}-py3-none-any.whl"
81
+ # verify where the wheel came from
82
+ gh attestation verify "steersync-${VERSION}-py3-none-any.whl" --repo SCGIS-Wales/steersync
83
+ ```
84
+
85
+ Every release is also published to [PyPI](https://pypi.org/project/steersync/) through
86
+ trusted publishing, so `uv tool install steersync` (or `steersync[mcp]`) installs the same
87
+ files that the GitHub release carries.
88
+
89
+ ## Quick start
90
+
91
+ 1. Point steersync at the central repository, once per machine:
92
+
93
+ ```bash
94
+ mkdir -p ~/.config/steersync
95
+ cat > ~/.config/steersync/config.yaml <<'YAML'
96
+ remote:
97
+ url: git@gitlab.example.com:platform/kiro-steering.git
98
+ allowed_hosts: [gitlab.example.com]
99
+ YAML
100
+ steersync config validate
101
+ ```
102
+
103
+ 2. Prepare a project. This adds every synced directory (`.kiro/steering/`, `.kiro/specs/`,
104
+ `.kiro/skills/`, ...) and the lock file to `.git/info/exclude` (so centrally managed
105
+ content is never committed to the project by accident; set `git_exclude: false` on a
106
+ collection to keep committing it) and installs a chaining pre-push hook:
107
+
108
+ ```bash
109
+ cd ~/code/my-service
110
+ steersync init --hook
111
+ steersync pull
112
+ ```
113
+
114
+ 3. Edit anything under `.kiro/`. On your next `git push`, or on demand with
115
+ `steersync push`, every collection is proposed to the central repository as one merge
116
+ request.
117
+
118
+ Run `steersync doctor` at any time to see what steersync has resolved.
119
+
120
+ ## Central repository layout
121
+
122
+ ```text
123
+ kiro-config/
124
+ ├── global/ # applied to every machine (~/.kiro)
125
+ │ ├── steering/engineering-rules.md
126
+ │ ├── skills/release-checklist/SKILL.md
127
+ │ └── hooks/steersync.json
128
+ └── projects/
129
+ └── acme/platform/api/ # derived from the project's origin URL
130
+ ├── steering/product.md
131
+ ├── specs/tls-cert-staged-rotation/tasks.md
132
+ ├── skills/venafi-tpp-websdk/SKILL.md
133
+ ├── agents/entra-app-registration.json
134
+ ├── hooks/tests-on-stop.json
135
+ └── settings/lsp.json
136
+ ```
137
+
138
+ The project slug is the remote path with the host and `.git` removed and unsafe characters
139
+ replaced, so `ssh://git@gitlab.example.com/acme/platform/api.git` becomes
140
+ `acme/platform/api`. The `global` and `projects` directory names and every collection
141
+ directory are configurable. Repositories created with steersync 0.1, which kept steering
142
+ directly under `global/` and `projects/<slug>/`, need their files moved into a `steering/`
143
+ subdirectory; `pull` and `status` print a warning pointing at them until that is done.
144
+
145
+ ## Commands
146
+
147
+ | Command | Purpose |
148
+ |---|---|
149
+ | `steersync pull [--force] [--dry-run] [--no-global] [--no-workspace] [--strict] [--best-effort] [-c NAME] [--json]` | Apply central collections locally. `--best-effort` warns and exits 0 on failure. |
150
+ | `steersync push [--dry-run] [--scope global] [--no-lint] [-m MSG] [-c NAME] [--json]` | Propose local collections centrally in one branch. `--from-hook` is used by git hooks and never blocks the push unless strict. |
151
+ | `steersync status [-c NAME] [--json]` | Show adds, updates, deletes and local edits per collection in both directions. |
152
+ | `steersync lint [PATHS] [-c NAME] [--profile P] [--json]` | Validate every collection with its profile, or explicit paths. Exit code 4 on errors. |
153
+ | `steersync init [--write-config] [--hook] [--no-exclude]` | Prepare a repository. |
154
+ | `steersync install-hook [--force]` | Install or update the chaining pre-push hook. |
155
+ | `steersync kiro-hook [--engine v2\|v3] [--write]` | Render a Kiro hook that runs `steersync pull --quiet` at session start. |
156
+ | `steersync mcp-config [--remote URL]` | Render an `mcp.json` fragment. |
157
+ | `steersync mcp` | Run the MCP stdio server. |
158
+ | `steersync config show\|validate\|default\|collections` | Inspect configuration and the resolved collection directories. |
159
+ | `steersync doctor` | Report git version, resolved paths, remote and project slug. |
160
+
161
+ Global options: `--config PATH`, `--log-level`, `--log-format text|json`, `--quiet`.
162
+
163
+ ## Configuration
164
+
165
+ Configuration is layered: packaged defaults, then one YAML file, then environment variables.
166
+ The file is found in this order: `--config`, `$STEERSYNC_CONFIG`, `<repo>/.kiro/steersync.yaml`,
167
+ `$XDG_CONFIG_HOME/steersync/config.yaml` (default `~/.config/steersync/config.yaml`). See
168
+ [`steersync.example.yaml`](steersync.example.yaml) for every key and `steersync config default`
169
+ for the packaged defaults.
170
+
171
+ | Variable | Overrides |
172
+ |---|---|
173
+ | `STEERSYNC_REMOTE` | `remote.url` |
174
+ | `STEERSYNC_DEFAULT_BRANCH` | `remote.default_branch` |
175
+ | `STEERSYNC_CACHE_DIR` | `paths.cache_dir` |
176
+ | `STEERSYNC_GIT_BINARY` | `git.binary` |
177
+ | `STEERSYNC_LOG_LEVEL`, `STEERSYNC_LOG_FORMAT` | `logging.*` |
178
+ | `STEERSYNC_STRICT` | `hook.strict` |
179
+ | `KIRO_HOME` | Location of `~/.kiro`, as honoured by kiro-cli |
180
+
181
+ Unknown keys, invalid patterns, unsafe paths and malformed push options are rejected at load
182
+ time with a precise message. The pre 0.2 keys `paths.workspace_steering` and
183
+ `paths.global_steering` still load, with a deprecation warning, as the steering collection's
184
+ `workspace_path` and `global_path`.
185
+
186
+ ### Adding or changing a collection
187
+
188
+ Collections are merged over the packaged defaults, so a project only lists what differs:
189
+
190
+ ```yaml
191
+ collections:
192
+ specs:
193
+ enabled: false # do not sync plans for this project
194
+ settings:
195
+ include: [lsp.json] # keep mcp.json local
196
+ runbooks: # a new collection, central directory runbooks/
197
+ description: Operational runbooks
198
+ workspace_path: docs/runbooks
199
+ include: ["**/*.md"]
200
+ lint: markdown
201
+ git_exclude: false # the project keeps committing these too
202
+ agents-md: # a single file at the repository root
203
+ workspace_path: .
204
+ include: [AGENTS.md]
205
+ max_depth: 1
206
+ lint: markdown
207
+ git_exclude: false
208
+ ```
209
+
210
+ Every key is documented in `steersync config default`. A collection needs a `workspace_path`
211
+ or a `global_path`; `central_dir` defaults to the collection name; enabled collections may not
212
+ share a directory on either side.
213
+
214
+ ## Reliability
215
+
216
+ | Mechanism | Configuration |
217
+ |---|---|
218
+ | Clone, fetch, ls-remote and push retry transient network and server errors with exponential backoff and jitter. Authentication and not found errors fail at once. | `git.retries`, `git.retry_backoff_seconds`, `git.retry_max_backoff_seconds` |
219
+ | An exclusive lock serialises processes sharing a cache clone, such as a Kiro session hook and a git hook. The operating system releases it if a process dies. | `sync.lock_timeout_seconds` |
220
+ | A corrupt or half written cache clone, or a stale `index.lock`, is deleted and cloned again. The cache is never deleted for network errors. | automatic |
221
+ | A failed push always resets the cache clone to a clean default branch. | automatic |
222
+ | From a pre-push hook each git call is capped and retried at most once, and no failure, including an unexpected bug, blocks the push unless strict mode is on. | `hook.timeout_seconds`, `hook.strict` |
223
+ | Central and local content larger than the limits is refused. | `sync.max_files`, `sync.max_total_bytes` |
224
+
225
+ ## How pull decides what to write
226
+
227
+ steersync records the hash of every file it wrote, per collection, in a lock file
228
+ (`.kiro/steersync.lock.json` in the workspace, `~/.kiro/steersync.lock.json` globally).
229
+ Version 1 lock files written by steersync 0.1 are read as the steering collection. On the
230
+ next pull:
231
+
232
+ | Local file | Compared with | Result |
233
+ |---|---|---|
234
+ | Missing | | Added |
235
+ | Equals central | | Unchanged |
236
+ | Equals lock, differs from central | | Updated |
237
+ | Differs from lock and central | | Kept and reported as a conflict (`--force` overwrites) |
238
+ | In lock, removed centrally, unmodified | | Deleted (`sync.prune: false` keeps it) |
239
+ | Never synced | | Left alone and reported as local only |
240
+
241
+ Kiro metadata is never written into steering front matter; all tool state lives in the lock
242
+ file, so documents stay exactly as authored. Pulling a subset of collections leaves the lock
243
+ entries of the others untouched.
244
+
245
+ ## Git hook
246
+
247
+ `steersync install-hook` writes `.git/hooks/pre-push`. An existing hook is preserved as
248
+ `pre-push.local` and run first with the same arguments and stdin. `core.hooksPath` is never
249
+ changed. The hook calls `steersync push --from-hook --remote-url "$2"`, exits 0 on any sync
250
+ failure unless `hook.strict` or `STEERSYNC_STRICT=1` is set, and skips pushes that only delete
251
+ branches.
252
+
253
+ Teams that already use [pre-commit](https://pre-commit.com) can use the published hook instead:
254
+
255
+ ```yaml
256
+ # .pre-commit-config.yaml in the project
257
+ default_install_hook_types: [pre-commit, pre-push]
258
+ repos:
259
+ - repo: https://github.com/SCGIS-Wales/steersync
260
+ rev: v0.2.0
261
+ hooks:
262
+ - id: steersync-push
263
+ - id: steersync-lint
264
+ ```
265
+
266
+ The lint hook receives the changed files under `.kiro/` and lints each with the profile of
267
+ the collection it belongs to.
268
+
269
+ ## GitLab merge requests
270
+
271
+ The default push options create a merge request against the default branch, remove the source
272
+ branch on merge and set a title. Branch names follow `steering/{project}/{user}-{hash}`, where
273
+ the hash covers every file, so two people proposing identical content share one branch and a
274
+ second identical push is reported as `already-proposed`. Servers that do not advertise push
275
+ options (GitHub, plain bare repositories) make git fail, so steersync retries once without them
276
+ and says so. Push options may use `{default_branch}`, `{project}`, `{user}` and `{hash}`.
277
+
278
+ ## Lint rules
279
+
280
+ Each collection runs one lint profile. The `steering` profile applies every rule below.
281
+ `markdown` (specs, prompts, references) applies the encoding, size, secret and markdown rules
282
+ without Kiro front matter checks. `skill` adds `skill-front-matter-required`,
283
+ `skill-requires-metadata` and `skill-name-mismatch` for `SKILL.md`. `json` adds `json-syntax`,
284
+ `hooks` adds `hook-schema`, `hook-trigger` and `hook-action`, `agent` adds `agent-schema`,
285
+ `agent-name` and `agent-deprecated-key`, and `generic` only enforces the size limit and secret
286
+ scanning, allowing binary assets. New profiles are one function in `steersync.lint.PROFILES`.
287
+
288
+ | Rule | Severity | Check |
289
+ |---|---|---|
290
+ | `front-matter-position` | error | Front matter must start on line 1; Kiro ignores it after a blank line. |
291
+ | `front-matter-yaml` | error | Front matter must be valid YAML. |
292
+ | `inclusion-value` | error | `inclusion` is `always`, `fileMatch`, `manual` or `auto`. |
293
+ | `filematch-pattern-required`, `filematch-pattern-type` | error | `fileMatch` needs a string or list of strings. |
294
+ | `auto-requires-metadata` | error | `auto` needs `name` and `description`. |
295
+ | `unknown-key` | warning | Keys Kiro does not know are ignored; `x-steersync` is allowed. |
296
+ | `encoding-utf8`, `max-size` | error | UTF-8 only; default limit 64 KiB because always included bytes cost context. |
297
+ | `require-h1` | warning | A level one heading is expected. |
298
+ | `file-reference-missing`, `file-reference-escape` | warning, error | `#[[file:path]]`, `#[[file:path:line]]`, `#[[file:path:start-end]]` and `#[[folder:path]]` targets must exist inside the workspace. |
299
+ | `forbidden-*` | error | AWS keys, private keys, GitHub, GitLab and Slack tokens, generic credentials. Patterns are configurable. |
300
+ | `markdown-MD*` | configurable | pymarkdown rules with the front matter extension enabled. |
301
+
302
+ ## Kiro integration
303
+
304
+ **Session hook (V3).** `steersync kiro-hook --write` creates `.kiro/hooks/steersync.json` with a
305
+ `SessionStart` trigger that runs `steersync pull --quiet --best-effort`. For CLI 2.x agents paste the output of
306
+ `steersync kiro-hook --engine v2` into the agent's `hooks` block. Field reports say Kiro hooks fire
307
+ only in headless runs or with a custom agent active, so treat them as a convenience and keep the
308
+ git hook as the dependable trigger.
309
+
310
+ **MCP server.** Add the fragment from `steersync mcp-config` to `.kiro/settings/mcp.json`. The
311
+ server exposes `pull_steering`, `push_steering`, `diff_steering` and `lint_steering`. Kiro does
312
+ not pass the shell's `PATH`, `SSH_AUTH_SOCK` or proxy variables to MCP servers, so the rendered
313
+ fragment forwards them explicitly through `env`; use an absolute `--command` if `uvx` is not on
314
+ Kiro's path.
315
+
316
+ **Custom agents.** On Kiro CLI V3 custom agents inherit steering, skills and `AGENTS.md` by
317
+ default, so list only the always on steering files in `resources` and reference skills with
318
+ `skill://.kiro/skills/*/SKILL.md`. A `file://.kiro/steering/**/*.md` glob loads every document
319
+ at startup and defeats the `fileMatch`, `manual` and `auto` inclusion modes. On CLI 2.x list
320
+ the documents you need explicitly.
321
+
322
+ ## Security
323
+
324
+ See [SECURITY.md](SECURITY.md). In short: no credentials of its own, no shell, validated remote
325
+ URLs with an optional host allow list, path containment for every write, central symlinks never
326
+ followed, git hooks disabled in the cache, secret scanning before a push, recursion guards in
327
+ hooks, redacted logs, SHA pinned actions, locked and audited dependencies, signed provenance on
328
+ releases.
329
+
330
+ ## Development
331
+
332
+ ```bash
333
+ uv sync --all-extras --group dev
334
+ uv run pytest --cov
335
+ uv run ruff check . && uv run ruff format --check . && uv run mypy
336
+ ```
337
+
338
+ See [CONTRIBUTING.md](CONTRIBUTING.md) and [docs/architecture.md](docs/architecture.md).
339
+
340
+ ## Licence
341
+
342
+ Apache 2.0. Kiro is a trademark of Amazon Web Services; this project is not affiliated with AWS.
@@ -0,0 +1,20 @@
1
+ steersync/__init__.py,sha256=Np72Y8tdiKOvVGI2yuOAv6hVrRBGRakLbWAwDJZrkeY,127
2
+ steersync/__main__.py,sha256=ZJGm_TexJkz3KC_DFTZOqn7ejFjs9jBQ3doJhFlwIhE,106
3
+ steersync/cli.py,sha256=ttsD6rxK8_e8SDLfJ458jZxP1DhWzZrTIJwexUZhh8w,27947
4
+ steersync/config.py,sha256=ScqU0CLbpDIiKfGupyfWNEEH4M3UFkTkBsIFDVddMV0,20383
5
+ steersync/errors.py,sha256=retrgxKxRt50B8WOIMYG8n0M9shwuKSinO_Y3dRdVOM,1103
6
+ steersync/gitops.py,sha256=2lBWO6Tb6GmKruqKucEHdpCYeXxTP-2eX87r-Zz0RPc,19382
7
+ steersync/hooks.py,sha256=vzvKKfwOoL-NNxPec_dVOy3j_Pw_o1G_jQHXGFWuRkk,4887
8
+ steersync/lint.py,sha256=-S4495knumLWGuAGfC1Ujx_2nbnXvcYYfTFzdOcaj_w,21229
9
+ steersync/locking.py,sha256=elEJKrOxdhfFrfgv3gUj6tNXdjZGJcF-biJ13sY4Bn0,2232
10
+ steersync/logging_utils.py,sha256=zSfPglRDThVvEL35KcczdGFv853a7zAOi3n2PQY4W3E,2006
11
+ steersync/mcp_server.py,sha256=g_af353Z0Ib8Fke7uTNvfR0PbheRag0LCOfq5q6DvRg,6291
12
+ steersync/paths.py,sha256=SxfzWIfgPmu3fjr1dLy1GN8LLAYEwFbXlFdeAcYLmWs,3622
13
+ steersync/steering.py,sha256=tLG8KibKacfkwd94gQx9V5ONjC_7rxpuWm0kdYddWt8,16174
14
+ steersync/sync.py,sha256=zAk1Oo02yvSvt0-rHvHBMvnDcLmuDqXR_9V8QBNwuI0,25422
15
+ steersync/resources/default_config.yaml,sha256=n8fDW64n9z2aAqBTVeFH4mt7qrzwzjoeaJgCxWoHTEs,5507
16
+ steersync-0.2.0.dist-info/METADATA,sha256=XcMFypgxwbjHoXqM6vFVeUqZ_6zPkXypZXeFDOqZu5E,18038
17
+ steersync-0.2.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
18
+ steersync-0.2.0.dist-info/entry_points.txt,sha256=ibMQBakb7MufxLcc0b-qNTFPiZq3naJ73DY8ScQanmU,48
19
+ steersync-0.2.0.dist-info/licenses/LICENSE,sha256=4Hl9Bp9jHMcRxleKG0sPRzT0jGQ0YYhsu82ILO_JDqM,10787
20
+ steersync-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.32.4
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ steersync = steersync.cli:run
@@ -0,0 +1,190 @@
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
+ Copyright 2026 SCGIS Wales and the steersync contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.