Package: git-goggles
git-goggles is a git management utilities that allows you to manage your source code as
it evolves through its development lifecycle.OverviewThis project accomplishes two things:Manage the code review state of your branchesGives a snapshot of the where your local branches are vs origin in terms of being ahead / behind on commitsThere is a nice blog post describing the features along with screenshots athttp://bit.ly/git-gogglesField ReferenceIn the table outputted by git-goggles, each row corresponds to a branch, with the following fields:Status: the current status of your branchnew: this is a branch that has never been through the review processreview: this branch has code that needs to be reviewedmerge: everything has been reviewed, but needs to be merged into parent (same as done for being ahead)done: reviewed and merged (doens’t matter if you’re behind but you can’t be ahead)Branch: the branch nameReview: how many commits have taken place since the last reviewAhead: how many commits are in your local branch that are not in originBehind: how many commits are in origin that are not in your local branchPull & Push: whether your branches need to be pushed or pulled to track origingreen checkbox: you don’t need to pullred cross: you need to pullquestion mark: you either don’t have a checked out copy of this branch or you need to prune your local treeModified: the last time that HEAD was modified (NOT the last time the review happened)InstallationTo install from PyPi you should run one of the following commands. (If you use pip for your package installation, you should take a look!)pip install git-gogglesoreasy_install git-gogglesCheckout the project from githubhttp://github.com/nowells/git-gogglesgit clone git://github.com/nowells/git-goggles.gitRun setup.py as rootcd git-goggles
sudo python setup.py installDocumentation:
WithSphinxdocs deployment: in the docs/ directory, type:make htmlThen opendocs/_build/index.htmlUsageViewing the status of your branches:git gogglesStarting your review process (shows an origin diff):git goggles codereviewComplete your review process (automatically pushes up):git goggles codereview completeConfigurationYou can set a few configuration variables to alter to way git-goggles works out of the box.Disable automatic fetching from all remote servers.git config --global gitgoggles.fetch falseDisable colorized outputgit config --global gitgoggles.colors falseAlter the symbols used to display success, failure, unknown statesgit config --global gitgoggles.icons.success "OK"
git config --global gitgoggles.icons.failure "FAIL"
git config --global gitgoggles.icons.unknown "N/A"Alter the colors of branch states. The available colors are [grey, red, green, yellow, blue, magenta, cyan, white]git config --global gitgoggles.colors.local cyan
git config --global gitgoggles.colors.new red
git config --global gitgoggles.colors.review red
git config --global gitgoggles.colors.merge yellow
git config --global gitgoggles.colors.done greenAlter the width of branch column to turn on wordwrap.git config --global gitgoggles.table.branch-width 15Alter the table cell padding (defaults to 0)git config --global gitgoggles.table.left-padding 1
git config --global gitgoggles.table.right-padding 1Alter the display of horizontal rule between rows of table (default false)git config --global gitgoggles.table.horizontal-rule trueInternalsgit-goggles works by creating and managing special tags called
‘codereview-<branch_name>’ and tracking them against HEAD.The first time a codereview is completed, the tag is created. Subsequent
reviews delete and re-create the tag so that it awlays accurately tracks HEAD.