beman-submodule 0.1.0__tar.gz

beman_submodule-0.1.0/LICENSE

@@ -0,0 +1,219 @@
+
+                                 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.
+
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.

beman_submodule-0.1.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: beman-submodule
+Version: 0.1.0
+Summary: A pseudo-submodule tool for vendoring Git repositories in Beman projects
+Keywords: beman,bemanproject,git,submodule,vendoring,cli tool
+Author-email: The Beman Project <eddiejnolan@gmail.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Version Control :: Git
+License-File: LICENSE
+Project-URL: Homepage, https://github.com/bemanproject/beman-submodule
+Project-URL: Issues, https://github.com/bemanproject/beman-submodule/issues
+Project-URL: Repository, https://github.com/bemanproject/beman-submodule
+
+# beman-submodule
+
+<!-- SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -->
+
+A pseudo-submodule tool for vendoring Git repositories in Beman projects.
+
+## What is beman-submodule?
+
+`beman-submodule` provides some of the features of `git submodule`, adding child git
+repositories to a parent git repository, but unlike with `git submodule`, the entire child
+repo is directly checked in, so only maintainers, not users, need to run this script. The
+command line interface mimics `git submodule`'s.
+
+## Installation
+
+```sh
+pip install beman-submodule
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```sh
+uv tool install beman-submodule
+```
+
+## Usage
+
+### Adding a beman submodule
+
+```sh
+beman-submodule add https://github.com/bemanproject/infra.git
+```
+
+This will clone the repository and create a `.beman_submodule` file tracking the remote and commit.
+
+You can also specify a custom path:
+
+```sh
+beman-submodule add https://github.com/bemanproject/infra.git infra/
+```
+
+### Updating beman submodules
+
+Update all beman submodules to match their `.beman_submodule` configuration:
+
+```sh
+beman-submodule update
+```
+
+Update all beman submodules to the latest from upstream:
+
+```sh
+beman-submodule update --remote
+```
+
+Update only a specific submodule:
+
+```sh
+beman-submodule update --remote infra/
+```
+
+### Checking status
+
+Show the status of all beman submodules:
+
+```sh
+beman-submodule status
+```
+
+A `+` prefix indicates the submodule contents differ from the configured commit.
+
+## How does it work?
+
+Along with the files from the child repository, it creates a dotfile called
+`.beman_submodule`, which looks like this:
+
+```ini
+[beman_submodule]
+remote=https://github.com/bemanproject/infra.git
+commit_hash=9b88395a86c4290794e503e94d8213b6c442ae77
+```
+
+### Updating to a specific commit or changing the remote URL
+
+Edit the corresponding lines in the `.beman_submodule` file and run
+`beman-submodule update` to update the state of the beman submodule to the new
+settings.
+
+### Allow untracked files
+
+If you need to add local files alongside the vendored content, use:
+
+```sh
+beman-submodule add --allow-untracked-files https://github.com/example/repo.git path/
+```
+
+This adds `allow_untracked_files=True` to the `.beman_submodule` config, preserving local
+files during updates.
+
+## CI Integration
+
+Add this job to your CI workflow to ensure beman submodules are in a valid state:
+
+```yaml
+  beman-submodule-test:
+    runs-on: ubuntu-latest
+    name: "Check beman submodules for consistency"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install beman-submodule
+        run: pip install beman-submodule
+      - name: beman submodule consistency check
+        run: |
+          (set -o pipefail; beman-submodule status | grep -qvF '+')
+```
+
+This will fail if the contents of any beman submodule don't match what's specified in the
+`.beman_submodule` file.
+
+## Development
+
+This project uses [uv](https://github.com/astral-sh/uv) for development:
+
+```sh
+# Install dependencies
+uv sync --group dev
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run ruff check .
+
+# Format code
+uv run ruff format .
+```
+
+## License
+
+Apache-2.0 WITH LLVM-exception
+

beman_submodule-0.1.0/README.md

@@ -0,0 +1,141 @@
+# beman-submodule
+
+<!-- SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -->
+
+A pseudo-submodule tool for vendoring Git repositories in Beman projects.
+
+## What is beman-submodule?
+
+`beman-submodule` provides some of the features of `git submodule`, adding child git
+repositories to a parent git repository, but unlike with `git submodule`, the entire child
+repo is directly checked in, so only maintainers, not users, need to run this script. The
+command line interface mimics `git submodule`'s.
+
+## Installation
+
+```sh
+pip install beman-submodule
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```sh
+uv tool install beman-submodule
+```
+
+## Usage
+
+### Adding a beman submodule
+
+```sh
+beman-submodule add https://github.com/bemanproject/infra.git
+```
+
+This will clone the repository and create a `.beman_submodule` file tracking the remote and commit.
+
+You can also specify a custom path:
+
+```sh
+beman-submodule add https://github.com/bemanproject/infra.git infra/
+```
+
+### Updating beman submodules
+
+Update all beman submodules to match their `.beman_submodule` configuration:
+
+```sh
+beman-submodule update
+```
+
+Update all beman submodules to the latest from upstream:
+
+```sh
+beman-submodule update --remote
+```
+
+Update only a specific submodule:
+
+```sh
+beman-submodule update --remote infra/
+```
+
+### Checking status
+
+Show the status of all beman submodules:
+
+```sh
+beman-submodule status
+```
+
+A `+` prefix indicates the submodule contents differ from the configured commit.
+
+## How does it work?
+
+Along with the files from the child repository, it creates a dotfile called
+`.beman_submodule`, which looks like this:
+
+```ini
+[beman_submodule]
+remote=https://github.com/bemanproject/infra.git
+commit_hash=9b88395a86c4290794e503e94d8213b6c442ae77
+```
+
+### Updating to a specific commit or changing the remote URL
+
+Edit the corresponding lines in the `.beman_submodule` file and run
+`beman-submodule update` to update the state of the beman submodule to the new
+settings.
+
+### Allow untracked files
+
+If you need to add local files alongside the vendored content, use:
+
+```sh
+beman-submodule add --allow-untracked-files https://github.com/example/repo.git path/
+```
+
+This adds `allow_untracked_files=True` to the `.beman_submodule` config, preserving local
+files during updates.
+
+## CI Integration
+
+Add this job to your CI workflow to ensure beman submodules are in a valid state:
+
+```yaml
+  beman-submodule-test:
+    runs-on: ubuntu-latest
+    name: "Check beman submodules for consistency"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install beman-submodule
+        run: pip install beman-submodule
+      - name: beman submodule consistency check
+        run: |
+          (set -o pipefail; beman-submodule status | grep -qvF '+')
+```
+
+This will fail if the contents of any beman submodule don't match what's specified in the
+`.beman_submodule` file.
+
+## Development
+
+This project uses [uv](https://github.com/astral-sh/uv) for development:
+
+```sh
+# Install dependencies
+uv sync --group dev
+
+# Run tests
+uv run pytest
+
+# Run linter
+uv run ruff check .
+
+# Format code
+uv run ruff format .
+```
+
+## License
+
+Apache-2.0 WITH LLVM-exception

beman_submodule-0.1.0/beman_submodule/__init__.py

@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+"""A pseudo-submodule tool for vendoring Git repositories in Beman projects."""
+
+__version__ = '0.1.0'

beman_submodule-0.1.0/beman_submodule/cli.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+import argparse
+import sys
+
+from beman_submodule.lib.core import (
+    add_command,
+    check_for_git,
+    status_command,
+    update_command,
+)
+
+
+def get_parser():
+    """Build and return the argument parser."""
+    parser = argparse.ArgumentParser(description='Beman pseudo-submodule tool')
+    subparsers = parser.add_subparsers(dest='command', help='available commands')
+
+    parser_update = subparsers.add_parser('update', help='update beman_submodules')
+    parser_update.add_argument(
+        '--remote',
+        action='store_true',
+        help='update a beman_submodule to its latest from upstream',
+    )
+    parser_update.add_argument(
+        'beman_submodule_path',
+        nargs='?',
+        help='relative path to the beman_submodule to update',
+    )
+
+    parser_add = subparsers.add_parser('add', help='add a new beman_submodule')
+    parser_add.add_argument('repository', help='git repository to add')
+    parser_add.add_argument('path', nargs='?', help='path where the repository will be added')
+    parser_add.add_argument(
+        '--allow-untracked-files',
+        action='store_true',
+        help='the beman_submodule will not occupy the subdirectory exclusively',
+    )
+
+    parser_status = subparsers.add_parser('status', help='show the status of beman_submodules')
+    parser_status.add_argument('paths', nargs='*')
+
+    return parser
+
+
+def parse_args(args):
+    """Parse command line arguments."""
+    return get_parser().parse_args(args)
+
+
+def usage():
+    """Return the help text."""
+    return get_parser().format_help()
+
+
+def run_command(args):
+    """Execute the appropriate command based on parsed arguments."""
+    if args.command == 'update':
+        update_command(args.remote, args.beman_submodule_path)
+    elif args.command == 'add':
+        add_command(args.repository, args.path, args.allow_untracked_files)
+    elif args.command == 'status':
+        status_command(args.paths)
+    else:
+        raise Exception(usage())
+
+
+def main():
+    """Main entry point for the CLI."""
+    try:
+        if not check_for_git(None):
+            raise Exception('git not found in PATH')
+        args = parse_args(sys.argv[1:])
+        run_command(args)
+    except Exception as e:
+        print('Error:', e, file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

beman_submodule-0.1.0/beman_submodule/lib/__init__.py

@@ -0,0 +1 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

beman_submodule-0.1.0/beman_submodule/lib/core.py

@@ -0,0 +1,261 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+import configparser
+import filecmp
+import glob
+import os
+import shutil
+import subprocess
+import tempfile
+from pathlib import Path
+
+
+def directory_compare(
+    reference: str | Path, actual: str | Path, ignore, allow_untracked_files: bool
+):
+    """Compare two directories recursively, optionally ignoring certain files."""
+    reference, actual = Path(reference), Path(actual)
+
+    compared = filecmp.dircmp(reference, actual, ignore=ignore)
+    if (
+        compared.left_only
+        or (compared.right_only and not allow_untracked_files)
+        or compared.diff_files
+    ):
+        return False
+    for common_dir in compared.common_dirs:
+        path1 = reference / common_dir
+        path2 = actual / common_dir
+        if not directory_compare(path1, path2, ignore, allow_untracked_files):
+            return False
+    return True
+
+
+class BemanSubmodule:
+    """Represents a beman submodule configuration."""
+
+    def __init__(
+        self,
+        dirpath: str | Path,
+        remote: str,
+        commit_hash: str,
+        allow_untracked_files: bool,
+    ):
+        self.dirpath = Path(dirpath)
+        self.remote = remote
+        self.commit_hash = commit_hash
+        self.allow_untracked_files = allow_untracked_files
+
+
+def parse_beman_submodule_file(path):
+    """Parse a .beman_submodule configuration file."""
+    config = configparser.ConfigParser()
+    read_result = config.read(path)
+
+    def fail():
+        raise Exception(f'Failed to parse {path} as a .beman_submodule file')
+
+    if not read_result:
+        fail()
+    if 'beman_submodule' not in config:
+        fail()
+    if 'remote' not in config['beman_submodule']:
+        fail()
+    if 'commit_hash' not in config['beman_submodule']:
+        fail()
+    allow_untracked_files = config.getboolean(
+        'beman_submodule', 'allow_untracked_files', fallback=False
+    )
+    return BemanSubmodule(
+        Path(path).resolve().parent,
+        config['beman_submodule']['remote'],
+        config['beman_submodule']['commit_hash'],
+        allow_untracked_files,
+    )
+
+
+def get_beman_submodule(path: str | Path):
+    """Get a BemanSubmodule from a directory path, or None if not found."""
+    beman_submodule_filepath = Path(path) / '.beman_submodule'
+
+    if beman_submodule_filepath.is_file():
+        return parse_beman_submodule_file(beman_submodule_filepath)
+    else:
+        return None
+
+
+def find_beman_submodules_in(path):
+    """Find all beman submodules in a directory tree."""
+    path = Path(path)
+    assert path.is_dir()
+
+    result = []
+    for dirpath, _, filenames in path.walk():
+        if '.beman_submodule' in filenames:
+            result.append(parse_beman_submodule_file(dirpath / '.beman_submodule'))
+    return sorted(result, key=lambda module: module.dirpath)
+
+
+def cwd_git_repository_path():
+    """Get the root path of the current git repository, or None if not in a repo."""
+    process = subprocess.run(
+        ['git', 'rev-parse', '--show-toplevel'],
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    if process.returncode == 0:
+        return process.stdout.strip()
+    elif 'fatal: not a git repository' in process.stderr:
+        return None
+    else:
+        raise Exception('git rev-parse --show-toplevel failed')
+
+
+def clone_beman_submodule_into_tmpdir(beman_submodule, remote):
+    """Clone a beman submodule into a temporary directory."""
+    tmpdir = tempfile.TemporaryDirectory()
+    subprocess.run(
+        ['git', 'clone', beman_submodule.remote, tmpdir.name],
+        capture_output=True,
+        check=True,
+    )
+    if not remote:
+        subprocess.run(
+            ['git', '-C', tmpdir.name, 'reset', '--hard', beman_submodule.commit_hash],
+            capture_output=True,
+            check=True,
+        )
+    return tmpdir
+
+
+def get_paths(beman_submodule):
+    """Get all paths in a beman submodule (excluding .git)."""
+    tmpdir = clone_beman_submodule_into_tmpdir(beman_submodule, False)
+    paths = set(glob.glob('*', root_dir=Path(tmpdir.name), include_hidden=True))
+    paths.remove('.git')
+    return paths
+
+
+def beman_submodule_status(beman_submodule):
+    """Get the status string for a beman submodule."""
+    tmpdir = clone_beman_submodule_into_tmpdir(beman_submodule, False)
+    if directory_compare(
+        tmpdir.name,
+        beman_submodule.dirpath,
+        ['.beman_submodule', '.git'],
+        beman_submodule.allow_untracked_files,
+    ):
+        status_character = ' '
+    else:
+        status_character = '+'
+    parent_repo_path = cwd_git_repository_path()
+    if not parent_repo_path:
+        raise Exception('this is not a git repository')
+    relpath = Path(beman_submodule.dirpath).relative_to(Path(parent_repo_path))
+    return status_character + ' ' + beman_submodule.commit_hash + ' ' + str(relpath)
+
+
+def beman_submodule_update(beman_submodule, remote):
+    """Update a beman submodule to match its configured state."""
+    tmpdir = clone_beman_submodule_into_tmpdir(beman_submodule, remote)
+    tmp_path = Path(tmpdir.name)
+    sha_process = subprocess.run(
+        ['git', 'rev-parse', 'HEAD'],
+        capture_output=True,
+        check=True,
+        text=True,
+        cwd=tmp_path,
+    )
+
+    if beman_submodule.allow_untracked_files:
+        for path in get_paths(beman_submodule):
+            path2 = Path(beman_submodule.dirpath) / path
+            if Path(path2).is_dir():
+                shutil.rmtree(path2)
+            elif Path(path2).is_file():
+                os.remove(path2)
+    else:
+        shutil.rmtree(beman_submodule.dirpath)
+
+    submodule_path = tmp_path / '.beman_submodule'
+    with open(submodule_path, 'w') as f:
+        f.write('[beman_submodule]\n')
+        f.write(f'remote={beman_submodule.remote}\n')
+        f.write(f'commit_hash={sha_process.stdout.strip()}\n')
+        if beman_submodule.allow_untracked_files:
+            f.write('allow_untracked_files=True\n')
+    shutil.rmtree(tmp_path / '.git')
+    shutil.copytree(tmp_path, beman_submodule.dirpath, dirs_exist_ok=True)
+
+
+def update_command(remote, path):
+    """Execute the update command."""
+    if not path:
+        parent_repo_path = cwd_git_repository_path()
+        if not parent_repo_path:
+            raise Exception('this is not a git repository')
+        beman_submodules = find_beman_submodules_in(parent_repo_path)
+    else:
+        beman_submodule = get_beman_submodule(path)
+        if not beman_submodule:
+            raise Exception(f'{path} is not a beman_submodule')
+        beman_submodules = [beman_submodule]
+    for beman_submodule in beman_submodules:
+        beman_submodule_update(beman_submodule, remote)
+
+
+def add_command(repository, path, allow_untracked_files):
+    """Execute the add command."""
+    tmpdir = tempfile.TemporaryDirectory()
+    subprocess.run(['git', 'clone', repository], capture_output=True, check=True, cwd=tmpdir.name)
+    repository_name = os.listdir(tmpdir.name)[0]
+    if not path:
+        path = Path(repository_name)
+    else:
+        path = Path(path)
+    if not allow_untracked_files and path.exists():
+        raise Exception(f'{path} exists')
+    path.mkdir(exist_ok=allow_untracked_files)
+    tmpdir_repo = Path(tmpdir.name) / repository_name
+    sha_process = subprocess.run(
+        ['git', 'rev-parse', 'HEAD'],
+        capture_output=True,
+        check=True,
+        text=True,
+        cwd=tmpdir_repo,
+    )
+    with open(tmpdir_repo / '.beman_submodule', 'w') as f:
+        f.write('[beman_submodule]\n')
+        f.write(f'remote={repository}\n')
+        f.write(f'commit_hash={sha_process.stdout.strip()}\n')
+        if allow_untracked_files:
+            f.write('allow_untracked_files=True\n')
+    shutil.rmtree(tmpdir_repo / '.git')
+    shutil.copytree(tmpdir_repo, path, dirs_exist_ok=True)
+
+
+def status_command(paths):
+    """Execute the status command."""
+    if not paths:
+        parent_repo_path = cwd_git_repository_path()
+        if not parent_repo_path:
+            raise Exception('this is not a git repository')
+        beman_submodules = find_beman_submodules_in(parent_repo_path)
+    else:
+        beman_submodules = []
+        for path in paths:
+            beman_submodule = get_beman_submodule(path)
+            if not beman_submodule:
+                raise Exception(f'{path} is not a beman_submodule')
+            beman_submodules.append(beman_submodule)
+    for beman_submodule in beman_submodules:
+        print(beman_submodule_status(beman_submodule))
+
+
+def check_for_git(path):
+    """Check if git is available in PATH."""
+    env = os.environ.copy()
+    if path is not None:
+        env['PATH'] = path
+    return shutil.which('git', path=env.get('PATH')) is not None

beman_submodule-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "beman-submodule"
+version = "0.1.0"
+description = "A pseudo-submodule tool for vendoring Git repositories in Beman projects"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "The Beman Project", email = "eddiejnolan@gmail.com" }]
+dependencies = []
+keywords = [
+    "beman",
+    "bemanproject",
+    "git",
+    "submodule",
+    "vendoring",
+    "cli tool",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+
+[project.urls]
+Homepage = "https://github.com/bemanproject/beman-submodule"
+Repository = "https://github.com/bemanproject/beman-submodule"
+Issues = "https://github.com/bemanproject/beman-submodule/issues"
+
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[dependency-groups]
+dev = ["pytest>=8.4.0", "ruff>=0.11.13"]
+
+[project.scripts]
+beman-submodule = "beman_submodule.cli:main"
+
+[tool.pytest.ini_options]
+addopts = "-v"
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W"]