Skip to main content

Collection of utility Pythhon scripts to manage code repositories.

Project description

jps-code-repository-utils

Build Publish to PyPI codecov


🧭 Overview

jps-code-repository-utils is a collection of Python-based utility scripts designed to manage and standardize code repositories.
These tools simplify common administrative tasks such as enforcing naming conventions, auditing branch structures, generating repository history reports, and synchronizing version metadata.

✨ Key Features

  • Automated enforcement of branch naming conventions (feature/, bugfix/, hotfix/, release/, etc.)
  • Repository cleanup and archival of inactive branches
  • Consistent versioning and repository metadata management
  • Repository history generation with per-branch summaries and event classification
  • Integration with Jira and CI/CD pipelines for reporting and audit purposes
  • Robust testing framework using pytest with 100% reproducible local runs

🧩 Included Utilities

Script Description
standardize_branches.py Standardizes branch names, prefixes, and folders (feature, bugfix, hotfix, release).
audit_repository.py Audits repository metadata, tags, and release consistency.
repo_history.py Generates detailed repository history reports with per-branch summaries, tag events, and merge timelines.

💻 Example Commands

# Standardize branch naming across a repo
python -m scripts.standardize_branches --repo /path/to/repository

# Generate a full repository history report
python -m scripts.repo_history --global-tags

To explore command options:

jps-code-repository-utils-standardize --help
jps-code-repository-utils-audit --help
jps-code-repository-utils-history --help

⚙️ Installation

make install

🧪 Development Workflow

make fix && make format && make lint
make test

Recent Additions

  • Comprehensive pytest suite for repo_history.py
  • Dummy Git repository fixtures for isolated test execution
  • 6 passing tests and 1 intentionally skipped (network-dependent)

📦 Packaging and Distribution

This project follows semantic versioning and uses GitHub Actions for continuous integration,
PyPI publishing, and test coverage reporting via Codecov.


📜 License

MIT License © Jaideep Sundaram

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

jps_code_repository_utils-0.3.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

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

jps_code_repository_utils-0.3.1-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file jps_code_repository_utils-0.3.1.tar.gz.

File metadata

File hashes

Hashes for jps_code_repository_utils-0.3.1.tar.gz
Algorithm Hash digest
SHA256 b2bce30feceb6f2f1db7d99ab9172a800f3d4750b9d11a67ad569bb3ee2116b4
MD5 8e4846297993c5cd7e4663e97a3e810d
BLAKE2b-256 388f435ffe2c420bc69f82aa516916d0ffc5ed77765503b871ab21a079238b67

See more details on using hashes here.

File details

Details for the file jps_code_repository_utils-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jps_code_repository_utils-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5adfb920ab4486e68e7fdb47bb82a977a4229faa0d03004d1103ff52a151f33c
MD5 ee50bdc7aa144c738ffffa549a5bf949
BLAKE2b-256 d63abb0b4dc19acbac1d1497240f097d98b9d99f33a69733078c1c2759e6fc35

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