changes-roller 0.1.0__py3-none-any.whl

changes_roller-0.1.0.dist-info/METADATA

@@ -0,0 +1,331 @@
+Metadata-Version: 2.4
+Name: changes-roller
+Version: 0.1.0
+Summary: A command-line tool for creating and managing coordinated patch series across multiple Git repositories
+Project-URL: Homepage, https://github.com/k-pavlo/changes-roller
+Project-URL: Repository, https://github.com/k-pavlo/changes-roller
+Project-URL: Issues, https://github.com/k-pavlo/changes-roller/issues
+Project-URL: Documentation, https://changes-roller.readthedocs.io
+Author-email: Pavlo Kostianov <pkostian@redhat.com>
+License: MIT
+License-File: LICENSE
+Keywords: automation,batch-operations,cli,code-review,gerrit,git,multi-repo,patch,repository
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: System :: Software Distribution
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.0
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7.10; extra == 'dev'
+Requires-Dist: mypy>=1.13.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2023.0.0; extra == 'docs'
+Requires-Dist: linkify-it-py>=2.0.0; extra == 'docs'
+Requires-Dist: myst-parser>=2.0.0; extra == 'docs'
+Requires-Dist: sphinx-autoapi>=3.0.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx-design>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.12.0; extra == 'test'
+Requires-Dist: pytest>=8.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# changes-roller
+
+[![PyPI version](https://badge.fury.io/py/changes-roller.svg)](https://badge.fury.io/py/changes-roller)
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Documentation](https://readthedocs.org/projects/changes-roller/badge/?version=latest)](https://changes-roller.readthedocs.io/en/latest/?badge=latest)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![CI](https://github.com/k-pavlo/changes-roller/workflows/CI/badge.svg)](https://github.com/k-pavlo/changes-roller/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/k-pavlo/changes-roller/branch/main/graph/badge.svg)](https://codecov.io/gh/k-pavlo/changes-roller)
+[![Security](https://github.com/k-pavlo/changes-roller/workflows/Security/badge.svg)](https://github.com/k-pavlo/changes-roller/actions/workflows/security.yml)
+
+**Stop manually patching dozens of repositories. Automate it.**
+
+**Changes-Roller** is a command-line tool for creating and managing coordinated
+patch series across multiple Git repositories simultaneously.
+
+## Why changes-roller?
+
+It's Tuesday morning, and you've just discovered a critical security vulnerability affecting 47 of your repositories. You know what comes next: hours of manual cloning, editing, committing, and reviewing. Your afternoon vanishes into mechanical `git clone`, `git commit`, `git review` while your actual development work waits.
+
+changes-roller transforms this soul-crushing routine into a five-minute automation. Write your patch script once, then watch as it executes across all repositories in parallel. What used to consume your entire afternoon now runs while you grab coffee—with consistent changes, uniform commit messages, and organized code reviews.
+
+**Perfect for:**
+
+- Security updates across multiple microservices
+- Dependency upgrades throughout your service ecosystem
+- API migrations affecting client libraries
+- License header updates for compliance
+- Configuration file standardization
+- Any scenario requiring identical changes across multiple repositories
+
+## Project Status
+
+This project maintains high quality standards through automated testing and continuous integration:
+
+- **128 tests** with >90% code coverage
+- **Multi-platform testing** across Python 3.10-3.13 on Linux, macOS, and Windows
+- **Automated quality checks** including strict type checking (MyPy), linting (Ruff), and security scanning (Bandit)
+- **Pre-commit hooks** enforce code quality before commits
+- **Continuous security monitoring** with pip-audit and dependency review
+
+All pull requests undergo comprehensive automated testing to ensure reliability and maintainability.
+
+## How It Works
+
+Configure once, execute everywhere. You provide the repositories to update and a script containing your changes. changes-roller handles everything else—cloning, patching, testing, committing, and submitting for review. Parallel execution means 50 repositories finish almost as quickly as one. Built-in error handling ensures you get clear feedback about any issues, while successful repositories continue processing.
+
+## Features
+
+- Apply patches to multiple Git repositories in parallel
+- Custom patch scripts with full repository access
+- Automated Git operations (clone, commit, stage)
+- **Git branch switching** - Apply changes to specific branches (e.g., stable branches)
+- **Custom command execution** - Run commands before/after applying changes
+- **Dry-run mode** - Preview operations without executing them
+- Automatic commit sign-off (Signed-off-by line)
+- Automatic git-review setup for Gerrit integration
+- Commit message templating with variables
+- Gerrit code review integration with topic grouping
+- Optional test execution before committing (e.g., `tox -e pep8`)
+- Clear progress reporting and error handling
+
+## Installation
+
+```bash
+# Install in development mode
+pip install -e .
+
+# Or install from source
+pip install .
+```
+
+## Requirements
+
+- Python 3.10 or higher
+- Git command-line client
+- git-review (optional, for Gerrit integration)
+
+## Quick Start
+
+1. Generate a configuration file:
+
+```bash
+roller init --output my-series.ini
+```
+
+2. Create a patch script (`my_patch.sh`):
+
+```bash
+#!/bin/bash
+# Example: Update a dependency version
+sed -i 's/old-library==1.0/old-library==2.0/' requirements.txt
+chmod +x my_patch.sh
+```
+
+3. Edit the configuration file to specify your repositories and patch script:
+
+```bash
+nano my-series.ini
+# Update the 'projects' list and 'commands' path
+```
+
+4. Run the patch series:
+
+```bash
+roller create --config-file my-series.ini
+```
+
+## Configuration
+
+### [SERIE] Section
+
+**Basic Options:**
+
+- `projects` (required): Comma-separated list of Git repository URLs
+- `commands` (required): Path to executable patch script
+- `commit_msg` (required): Commit message template (supports `{{ project_name }}`)
+- `topic` (optional): Code review topic name
+- `commit` (optional): Enable automatic commits (default: true)
+- `review` (optional): Enable Gerrit review submission (default: false)
+
+**Branch Switching Options:**
+
+- `branch` (optional): Target branch to switch to before applying changes
+- `create_branch` (optional): Create branch if it doesn't exist (default: false)
+- `stay_on_branch` (optional): Don't return to original branch after completion (default: false)
+
+**Command Execution Options:**
+
+- `pre_commands` (optional): Commands to run before applying changes (one per line)
+- `post_commands` (optional): Commands to run after committing (one per line)
+- `continue_on_error` (optional): Continue if commands fail (default: false)
+- `dry_run` (optional): Preview operations without executing (default: false)
+
+### [TESTS] Section
+
+- `run` (optional): Enable test execution (default: false)
+- `blocking` (optional): Fail if tests fail (default: false)
+- `command` (optional): Test command to run (default: tox)
+
+Example: `command = tox -e pep8` runs PEP8 checks before committing
+
+## Command-Line Options
+
+### roller init
+
+Generate a template configuration file.
+
+```bash
+roller init [options]
+
+Options:
+  -o, --output PATH    Output file path (default: series.ini)
+  -f, --force          Overwrite existing file
+  --help               Show help message
+```
+
+### roller create
+
+Create a new patch series across multiple repositories.
+
+```bash
+roller create --config-file <path> [options]
+
+Options:
+  --config-file PATH        Path to configuration file (required)
+  --config-dir PATH         Additional directory for config files
+  -e, --exit-on-error       Exit immediately on first failure
+  -v, --verbose             Enable verbose output
+
+  # Branch switching
+  --branch NAME             Target branch to switch to before applying changes
+  --create-branch           Create branch if it doesn't exist (requires --branch)
+  --stay-on-branch          Don't return to original branch after completion
+
+  # Command execution
+  --pre-command CMD         Command to execute before changes (repeatable)
+  --post-command CMD        Command to execute after changes (repeatable)
+  --continue-on-error       Continue if commands fail instead of stopping
+  --dry-run                 Preview operations without executing them
+
+  --help                    Show help message
+```
+
+## Examples
+
+### Basic Usage
+
+```bash
+# Apply patch to multiple repositories
+roller create --config-file my-series.ini
+```
+
+### Branch Switching
+
+```bash
+# Apply changes to a specific branch
+roller create --config-file security-fix.ini --branch stable/2024.2
+
+# Multi-branch backport
+for branch in stable/2024.1 stable/2024.2 stable/2025.1; do
+  roller create --config-file fix.ini --branch $branch
+done
+```
+
+### With Commands
+
+```bash
+# Pull latest before patching, push after committing
+roller create --config-file series.ini \
+  --pre-command "git pull origin main" \
+  --post-command "git push origin main"
+
+# Validate before and after
+roller create --config-file series.ini \
+  --pre-command "pytest tests/" \
+  --post-command "git push"
+```
+
+### Dry Run
+
+```bash
+# Preview what would happen without executing
+roller create --config-file series.ini --dry-run
+```
+
+### With Testing
+
+Configuration file with PEP8 validation:
+
+```ini
+[SERIE]
+projects = https://github.com/org/repo1,
+           https://github.com/org/repo2
+commands = ./my-patch.sh
+commit_msg = Fix styling in {{ project_name }}
+
+[TESTS]
+run = true
+blocking = true
+command = tox -e pep8
+```
+
+### More Examples
+
+See the `examples/` directory for complete examples:
+
+- `examples/dependency-update/` - Update a dependency across repos
+- `examples/license-headers/` - Add license headers to source files
+- `examples/config-migration/` - Migrate configuration files
+
+## Development
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+ruff format .
+
+# Linting
+ruff check .
+
+# Type checking
+mypy roller/
+```
+
+## Contributing
+
+We welcome contributions! Please see our contributing guidelines and community standards:
+
+- **[Contributing Guide](CONTRIBUTING.md)** - Development setup, code standards, and PR process
+- **[Code of Conduct](CODE_OF_CONDUCT.md)** - Community standards and expectations
+- **[Changelog](CHANGELOG.md)** - Release history and version changes
+- **[Security Policy](SECURITY.md)** - Reporting issues and safe usage guidelines
+
+## License
+
+See LICENSE file for details.

changes_roller-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+roller/__init__.py,sha256=1pI3BNXfLONRMrAg9uZRVYIEW7C5V43hhbipCS2NBfI,139
+roller/cli.py,sha256=A55mDukS6YnZTqyEsWooxsiB-udkLHPliLsU0apv5A8,8214
+roller/config.py,sha256=Pn7koWMUUFFNHkCCNYS8uo_QTiVUznWcIVbuClP94po,4228
+roller/executor.py,sha256=iu2-AtwOsJbbz34cu9miT62dh4zPQEYV9JcBsC6A05M,13505
+roller/reporter.py,sha256=OeAiW7E3XT30A7qNXzFnW7aPGWRGukybJ10LRmYedjA,1959
+roller/repository.py,sha256=CEyTQRILpU5apFzPL10s0vEsvVaJx6lP6GnhSDW9hpo,8994
+roller/workspace.py,sha256=r_G7J_gXGKmKoP-cJ4TXP7zwgXe7LI68dfJQ4xisXUU,1149
+changes_roller-0.1.0.dist-info/METADATA,sha256=KqNWKKKFpR86uPTVB_PbDSb7OtMBiwfwnChig3Pn_xk,11719
+changes_roller-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+changes_roller-0.1.0.dist-info/entry_points.txt,sha256=O0AyYhrqa61XvBri6b-Ypwh-_EYEB0p8S-MaE_w9Nuo,42
+changes_roller-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+changes_roller-0.1.0.dist-info/RECORD,,

changes_roller-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

changes_roller-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+roller = roller.cli:cli

changes_roller-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

roller/__init__.py

@@ -0,0 +1,6 @@
+"""
+changes-roller: A tool for creating and managing coordinated patch series
+across multiple Git repositories.
+"""
+
+__version__ = "0.1.0"