Skip to main content

Git + GitHub Actions utilities (clone, branch, commit, retry, remote helpers, gh secrets/variables with SHA256 sidecar) — standalone module from the SciTeX ecosystem

Project description

scitex-git

SciTeX

Git operations and utilities — clone, init, branch, remote, retry decorator.

Full Documentation · pip install scitex-git

PyPI Python Tests Install Test Coverage Docs License: AGPL v3


Installation

pip install scitex-git

Architecture

scitex_git/
├── _clone.py          ← clone_repo, ls_remote, get_remote_url
├── _init.py           ← git_init, init_git_repo, find_parent_git
├── _commit.py         ← git_add_all, git_commit
├── _branch.py         ← checkout_new_branch, branch_rename, setup_branches
├── _remote.py         ← remote-URL helpers, head-hash queries
├── _retry.py          ← @git_retry decorator (transient-error backoff)
├── _validation.py     ← repo-state guards
├── _workflow.py       ← high-level multi-step flows
├── _vendor_sh.py      ← ~70-LOC subprocess wrapper (replaces scitex.sh)
└── _skills/           ← agent-facing skill pages

Pure-stdlib core. _vendor_sh.py is intentionally tiny so the package has no scitex.* runtime dependency. The umbrella scitex.git import resolves through a sys.modules bridge.

1 Interfaces

Python API
import scitex_git as sxg

# Clone / init
sxg.clone_repo(url, dest_dir)
sxg.git_init(repo_path)

# Add / commit
sxg.git_add_all(repo_path)
sxg.git_commit(repo_path, message="…")

# Branch
sxg.git_checkout_new_branch(repo_path, branch_name)
sxg.git_branch_rename(repo_path, old, new)
sxg.setup_branches(repo_path, template_name)

# Repo init / discovery
sxg.init_git_repo(project_dir, git_strategy="parent")
sxg.find_parent_git(project_dir)
sxg.create_child_git(project_dir)
sxg.remove_child_git(project_dir)

# Remote
sxg.get_remote_url(repo_path)
sxg.is_cloned_from(repo_path, url)
sxg.ls_remote(url)
sxg.get_head_hash(repo_path)

# Retry decorator
@sxg.git_retry(max_attempts=3)
def maybe_flaky_operation(): ...

Demo

flowchart LR
    A["scitex_git.clone_repo<br/>(url, dest)"] --> B["@git_retry<br/>(transient errors)"]
    B --> C["repo on disk"]
    C --> D["git_add_all + git_commit"]
    D --> E["checkout_new_branch<br/>+ branch_rename"]
    E --> F["get_remote_url /<br/>get_head_hash"]
>>> import scitex_git as sxg
>>> sxg.clone_repo("https://github.com/foo/bar", "./bar")
>>> sxg.git_add_all("./bar")
>>> sxg.git_commit("./bar", message="initial")

Quick Start

import scitex_git as sxg

sxg.clone_repo("https://github.com/foo/bar", "./bar")
sxg.git_add_all("./bar")
sxg.git_commit("./bar", message="initial")

Status

Standalone fork of scitex.git. scitex.logging.getLogger is replaced by stdlib logging.getLogger; the scitex.sh.sh shell wrapper is replaced by a tiny ~70-LOC _vendor_sh.py that supports just the call-shape used here. The optional scitex.writer.verify_tree_structure validation step in create_child_git is gated behind a try/except so it only runs when scitex-writer is installed.

The umbrella package's scitex.git import path is preserved via a sys.modules-alias bridge so existing code continues to work.

Part of SciTeX

scitex-git is part of SciTeX. Install via the umbrella with pip install scitex[git] to use as scitex.git (Python) or scitex git ... (CLI).

Four Freedoms for Research

  1. The freedom to run your research anywhere — your machine, your terms.
  2. The freedom to study how every step works — from raw data to final manuscript.
  3. The freedom to redistribute your workflows, not just your papers.
  4. The freedom to modify any module and share improvements with the community.

AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

License

AGPL-3.0-only (see LICENSE).


SciTeX

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scitex_git-0.3.0.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scitex_git-0.3.0-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file scitex_git-0.3.0.tar.gz.

File metadata

  • Download URL: scitex_git-0.3.0.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for scitex_git-0.3.0.tar.gz
Algorithm Hash digest
SHA256 736ed90e88facca2ddc41e77fa360cd46fd8629ce3141778171b46232154d63e
MD5 fdb80b9ef7f3adfb144eba4714ef86bd
BLAKE2b-256 f5adf698c94596c6a5037c0625d194e22162f1481e499531c35de80d669c8e47

See more details on using hashes here.

File details

Details for the file scitex_git-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: scitex_git-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for scitex_git-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d18fc8323fb8ec33763b0521aad0f5c1296501e5feeae18481ba4c2fb6579cce
MD5 9f07a6c40baad436bcb4e3a8646a4f17
BLAKE2b-256 37512a36154c2255b93e088ca276792fffa9ab107c57cf3c302c5f9583f847f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page