Shiplog

Extract career accomplishments from git repos to generate portfolio content.

Shiplog scans your git history, detects technologies used, and generates markdown summaries of your work — quantified features delivered, bugs fixed, refactors completed, and more.

Installation

pip install -e .

Or install from GitHub:

pip install git+https://github.com/nospi/shiplog.git

Usage

# Scan a repo (uses current branch)
shiplog ~/Projects/my-app

# Scan specific branches
shiplog ~/Projects/my-app -b main -b develop

# Filter by author
shiplog ~/Projects/my-app -a "Jerad"

# Date range
shiplog ~/Projects/my-app --since 2024-01-01 --until 2024-12-31

# Output to specific file
shiplog ~/Projects/my-app -o ~/resume-extract.md

# Print to stdout
shiplog ~/Projects/my-app --stdout

What It Extracts

From Git History

• Conventional commits — Parses feat:, fix:, refactor:, etc.
• Ticket references — Extracts patterns like SMA-123, CLZR-456
• Line changes — Insertions, deletions, files modified
• Merge commits — Approximates PR count

Tech Stack Detection

• Languages — From file extensions
• Frameworks — From .csproj, package.json, go.mod, etc.
• Patterns — MVVM, DI, REST API, etc.

Generated Output

# Resume Extract: my-app

## Technical Skills Demonstrated
**Languages:** C#, TypeScript, SQL
**Frameworks:** .NET MAUI, Vue.js, SQLite

## Delivery Achievements
- Delivered 47 new features
- Resolved 23 bugs improving system stability
- Completed 15 refactoring initiatives

## Problem Domains
- Mobile Application Development
- API Integration
- Data Synchronisation

Batch Scanning

Scan all repos in a directory:

mkdir -p ~/shiplog-extracts
for repo in ~/Projects/*/; do
  [ -d "$repo/.git" ] || continue
  name=$(basename "$repo")
  shiplog "$repo" -a "Your Name" -o ~/shiplog-extracts/"$name".md
done

Requirements

• Python 3.10+
• Git (repos must be cloned locally)

License

MIT