Skip to content

sharyari/prtui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

prtui

A terminal UI for managing your GitHub pull request inbox, built with Textual.

Shows your PRs, PRs you've reviewed, and PRs requested via team assignment. Displays comments, reviews, commits, and CI status inline.

Install

  1. Ensure your Python has sqlite3 support:
python3 -c "import sqlite3"

If this fails, install the dev library and rebuild Python:

# Debian/Ubuntu
sudo apt install libsqlite3-dev

If using pyenv, reinstall the Python version afterwards: pyenv install --force <version>

  1. Create a Python venv and source it:
python3 -m venv .venv
source .venv/bin/activate

NOTE: the prtui wrapper script is assuming the venv name .venv, update it if you want to use something else

  1. Install dependencies:
pip install -r requirements.txt
  1. Create a config file in the project root:
username:<github-username>
team:<org>/<team-slug>
token:<github-personal-access-token>
repos:<owner/repo>,<owner/repo2>
jenkins-user:<jenkins-bot-username>
  1. Add to PATH Assuming zsh, run this when standing in the root of the repo
echo "export PATH=\"\$PATH:$(pwd)\"" >> ~/.zshrc

Usage

cd py && python prtui.py

or if added to PATH:

prtui

Window mode

Launch prtui in a maximized native desktop window, detached from the terminal:

prtui --window

The UI is served on a random port on 127.0.0.1 only, embedded via textual-serve and pywebview. Requires a local graphical desktop (not SSH).

Data

PR data is stored in a SQLite database at /tmp/prtui.db. Delete it to force a full re-fetch.

Configuration

In order to have working quick links to CI and ticketing system, optional regex configurations can be set in the config.

Ticket: the PR title is scanned and matched against regex CI: The latest comment from the CI user is scanned and matched against regex

About

Terminal UI for keeping track of GitHub pull requests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages