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.2.tar.gz (10.7 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.2-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jps_code_repository_utils-0.3.2.tar.gz
Algorithm Hash digest
SHA256 9b02e46e7dd3f9673dc6aa5dc08d9e99cddf122044f7ef82ae754cbd8a0d6eab
MD5 4829abe0293ba1484409493acd8d76f9
BLAKE2b-256 b9a53674d72b5e601331f42461bba1f1a4268731267558c0c52a910243403631

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jps_code_repository_utils-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7ba438a9c28753f88b6582d738913b392d1413227c93f7840f1bedf93d262fcb
MD5 985e1149576c51ea61fcb3949a82c966
BLAKE2b-256 f3f41900014d1ed50818f05971a94439de764832bfaa751b1d13121b590d1e31

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