Skip to content

agavignet/yogit

This branch is 44 commits behind hasboeuf/yogit:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d592995 · Oct 14, 2019
Sep 9, 2019
Jul 13, 2019
Jul 25, 2019
Oct 14, 2019
Jun 25, 2019
Jul 14, 2019
Oct 14, 2019
Oct 13, 2019
Jul 13, 2019
Aug 21, 2019
Oct 14, 2019
Jul 16, 2019
Jul 16, 2019
Aug 20, 2019

Repository files navigation

yogit

Build Status Build Status License PyPI version Downloads

Command line utility for git daily work.

Requirements

  • Python3 and pip3
  • yogit is tested with Python 3.5, 3.6, 3.7
  • yogit is mostly tested on Linux but also works on macOS and Windows (if using Windows Terminal).
  • For now only GitHub API is supported

Continuous integration

Installation

  • pip3 install yogit
  • yogit account setup

yogit internal files are stored in ~/.yogit folder.

Auto completion

yogit supports auto-completion. To activate it, you need to setup your shell.

  • For Bash, edit your .bashrc and add eval "$(_YOGIT_COMPLETE=source yogit)"
  • For Zsh, edit your .zshrc and add eval "$(_YOGIT_COMPLETE=source_zsh yogit)"

Principle

yogit is able to:

  • Show pull requests
  • Show pull request reviews
  • Show branches
  • Show contributions
  • Show organization's information
  • Help in writing a daily scrum report

See documentation below for more details.

Documentation

Usage

yogit --help

Account

yogit account setup: Setup yogit

yogit account usage: Account API usage

Pull request

yogit pr list [--orga TEXT]: List your opened pull requests. If --orga is provided, results will be expanded to this specific organization.

Review

yogit review list: List your reviews on opened pull requests

yogit review requested [--missed]: List pull requests where your review is requested. If --missed is set, only closed pull requests will be listed.

Branch

yogit branch list [--dangling]: List your branches. If --dangling is set, only branches without associated pull request will be listed.

Contributions

yogit contrib list [--from TEXT] [--to TEXT]: List your GitHub contributions within a range of dates.

A contribution is either a pull request or pull request review.

By default this command is listing today's contributions.

yogit contrib stats: Show some GitHub statistics.

Organization

yogit orga list: List organizations you belong to.

yogit orga member list [--orga TEXT]: List members of one organization you belong to.

yogit orga member pickone [--orga TEXT]: Randomly pick one member of one organization you belong to.

SCRUM

yogit scrum report [--date TEXT]: Generate your daily activity report

Template of the report can be changed by editing ~/.yogit/scrum_report.yaml

You might need to install xcopy to fully enjoy this command.

About

Command line tool for GitHub daily work

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.8%
  • Shell 0.2%