steersync 0.2.0__tar.gz

steersync-0.2.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

steersync-0.2.0/CHANGELOG.md

@@ -0,0 +1,122 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+Keep a Changelog and the project uses semantic versioning.
+
+## [Unreleased]
+
+## [0.2.0] - 2026-10-12
+
+### Added
+
+- Collections: the whole `.kiro/` layout is synced, not only steering. The packaged defaults
+  define `steering`, `specs`, `skills` (with execute bits preserved on scripts), `agents`,
+  `hooks` and `settings` (`lsp.json`, `mcp.json`); each maps a workspace directory, an
+  optional global directory and a central directory, with include and exclude globs, an
+  optional depth limit, a lint profile and a per collection size limit. Collections are
+  configured in YAML, can be disabled, and new ones need no code.
+- `--collection NAME` (repeatable) on `pull`, `push`, `status` and `lint`, and
+  `steersync config collections` to list the resolved directories. The MCP tools accept a
+  `collections` list.
+- Lint profiles: `markdown`, `skill` (`SKILL.md` must carry `name` and `description`, name
+  should match its directory), `agent`, `hooks` (schema and trigger names), `json` and
+  `generic` (binary assets allowed, secrets still scanned), next to the existing `steering`
+  rules. `steersync lint` validates every collection with its profile; `--profile` applies one
+  to explicit paths.
+- `docs/central-layout.md` describes a full `.kiro/` tree in the central repository.
+
+### Changed
+
+- **Central repository layout.** Each collection lives in its own directory:
+  `global/steering/`, `projects/<slug>/steering/`, `projects/<slug>/specs/` and so on.
+  Repositories created with 0.1 must move their files into `steering/`; `pull` and `status`
+  warn while files are still found directly under `global/` or `projects/<slug>/`.
+- Lock files are version 2 and record hashes per collection. Version 1 files are read as the
+  steering collection and upgraded on the next pull. Pulling a subset of collections keeps the
+  lock entries of the others.
+- `paths.workspace_steering` and `paths.global_steering` are deprecated in favour of
+  `collections.steering.workspace_path` and `collections.steering.global_path`; the old keys
+  still load with a warning.
+- `steersync init` excludes every synced workspace directory from the project repository
+  unless a collection sets `git_exclude: false`.
+- Push plans, JSON output and the MCP results are keyed by collection; push plan paths carry
+  the central directory prefix (`steering/api.md`). One push proposes every selected
+  collection in a single branch and commit.
+- File discovery returns paths sorted by relative path, independent of directory walk order.
+
+- Releases publish to PyPI through trusted publishing with PEP 740 attestations. The
+  release jobs now live in `ci.yml`, the workflow the PyPI publisher is registered for, and
+  run after the normal CI jobs on `main` when the package version has no release yet; the
+  separate `Release` workflow is gone. PyPI rejects attestations produced from a reusable
+  workflow, which is why the earlier split between `release.yml` and `ci.yml` could not
+  publish. The GitHub release attests and attaches the very files that went to PyPI
+  instead of building a second time. The `PUBLISH_TO_PYPI` variable is gone.
+
+### Fixed
+
+- A server that rejects push options also closes the connection, which the retry logic
+  treated as a network fault; each proposal to such a server ran two needless retries with
+  backoff before the push without options. The rejection is now recognised as permanent.
+
+## [0.1.0] - 2026-10-10
+
+### Added
+
+- `steersync pull` applies global and per project steering from a central git repository,
+  keeps locally modified files unless `--force` is given, prunes files removed centrally and
+  records what it wrote in a lock file so later pulls can tell local edits from stale copies.
+- `steersync push` proposes workspace or global steering as a content hashed branch with
+  GitLab merge request push options, dedupes identical proposals and falls back to a plain
+  push when the server does not accept push options.
+- `steersync status`, `lint`, `doctor`, `config show|validate|default`.
+- `steersync init` writes `.git/info/exclude` entries and an optional configuration file,
+  and `steersync install-hook` installs a chaining pre-push hook without touching
+  `core.hooksPath`.
+- `.pre-commit-hooks.yaml` exposing `steersync-push` (pre-push) and `steersync-lint`.
+- `steersync kiro-hook` renders Kiro CLI 2.x `agentSpawn` and V3 `SessionStart` hooks and
+  `steersync mcp-config` renders an `mcp.json` fragment.
+- Optional MCP stdio server (`steersync[mcp]`) exposing `pull_steering`, `push_steering`,
+  `diff_steering` and `lint_steering`.
+- Lint rules for Kiro front matter, file size, UTF-8, level one headings, `#[[file:]]` and
+  `#[[folder:]]` references, secret patterns and pymarkdown style checks.
+- Layered YAML configuration with environment overrides and strict pydantic validation.
+- CI pipeline with ruff, mypy strict, pytest with coverage gate, bandit, pip-audit, CodeQL,
+  wheel smoke test, Dependabot and a tag driven release workflow with build provenance and
+  PyPI trusted publishing.
+- GitHub releases carry the wheel, the sdist and a `SHA256SUMS` file with build provenance
+  attestations. Releases run the full CI gate first and no longer depend on PyPI being set
+  up; publishing to PyPI is enabled with the `PUBLISH_TO_PYPI` repository variable.
+- Releases are driven by `__version__`: merging a version bump to `main`, or running the
+  `Release` workflow manually, creates the annotated tag and the release, so nobody needs
+  permission to push tags.
+- CI lints every workflow with actionlint and shellcheck.
+- `pull --best-effort` warns and exits 0 on failure; the generated Kiro hooks use it.
+- Repository description, homepage and topics are kept in `.github/repository.yml` and
+  applied by a workflow when a `REPO_ADMIN_TOKEN` secret is configured.
+
+### Security
+
+- Symlinks in central repository content are never followed, so a link such as
+  `global/x.md -> ~/.ssh/id_rsa` cannot copy local secrets into steering or back upstream.
+- Git hooks never run inside the cache clone, for any operation.
+- The cache directory is created with mode 0700.
+- Lock files never store credentials from the remote URL, and a remote URL with an embedded
+  password triggers a warning.
+- git subprocesses never inherit standard input, which protects the MCP stdio protocol stream.
+- Every GitHub Action and pre-commit hook is pinned to a commit SHA, and CodeQL also analyses
+  the workflows. Pull requests can run dependency review once the Dependency graph is enabled
+  and the `DEPENDENCY_REVIEW` repository variable is set.
+
+### Reliability
+
+- An exclusive lock serialises processes that share a cache clone (`sync.lock_timeout_seconds`).
+- Network operations retry transient failures with exponential backoff and jitter
+  (`git.retries`, `git.retry_backoff_seconds`, `git.retry_max_backoff_seconds`).
+- A corrupt or half written cache clone, or a stale `index.lock`, is repaired automatically.
+- A failed push always returns the cache clone to a clean default branch.
+- Pre-push hook runs use a bounded git timeout (`hook.timeout_seconds`) and never block the
+  push on any unexpected error unless strict mode is enabled.
+- Central and local content is checked against `sync.max_files` and `sync.max_total_bytes`.
+- Synced files are written with mode 0644 instead of 0600.
+- The console entry point turns unexpected errors into a one line message and exit code.
+- Tests run on Linux and macOS.

steersync-0.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 SCGIS Wales and the steersync contributors
+
+   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.