Command line utility for GitHub daily work.
Project description
yogit
Command line utility for git daily work.
Requirements
Python3
andpip3
yogit
is tested with Python3.5
,3.6
,3.7
yogit
is mostly tested onLinux
but also works onmacOS
andWindows
(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.
Principle
yogit
is able to:
- List pull requests
- List reviews
- List branches
- Get your daily activity report
See below for more details.
Usage
yogit --help
Account
yogit account setup
: Setup yogit
yogit account usage
: Account API usage
Pull request
yogit pr list
: List your opened pull requests
Options:
--orga TEXT
: Expand results to a specific organization
Review
yogit rv list
: List your reviews on opened pull requests
yogit rv requested
: List pull requests where your review is requested
Branch
yogit br list
: List your branches
Contributions
yogit ct 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 ct stats
: Show some GitHub statistics.
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.
Changelog
1.7.1
- Fix
yogit
upgrade from1.6.0
1.7.0
- Add
yogit ct stats
command
1.6.0
- Add
yogit ct list
command - Add
--date
arg toyogit scrum report
command - Add indentation ability to
yogit scrum report
- Print pretty bullet points in generated scrum report
- Improve documentation
1.5.1
- Replace
yaspin
byHalo
dep to handle spinner: better handling of pipes and redirects
1.5.0
- Tried
yogit
on Windows Terminal and workaround a spinner issue - Print count little by little if request is big
1.4.1
- Fix missing
packaging
dependency
1.4.0
- See if pull requests are conflicted in
yogit pr list
- Improve
yogit scrum report
UX and make it robust to network access failure - Shorten PR titles in tabulated results (max 50 chars)
1.3.0
- Add update available check
1.2.1
- Improve help
1.2.0
- Add ability to list your current reviews and see outdated ones with
yogit rv list
- Dedicated wording when there is no result
- Add "Count: X" statement right after result list
- Show a spinner during request time
- Use bold and emojis to make outputs fancier
1.1.1
- Reinforce
scrum report
command (better error handling)
1.1.0
- Add abilitiy to list pull requests of an organization
yogit pr list --orga TEXT
1.0.4
- Fix typo in scrum report, thx @genygilles
1.0.3
- Fix unauthorized error due to too old PyYAML version
1.0.2
- Support pagination for branch listing (fix request timeout)
1.0.1
- Be more specific on GitHub required scopes
- Improve code regarding account setup flow
- Fix sort of pull request list
1.0.0
- Project bootstrap
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.