add rich and update README

Author: hamelsmu

README.md

@@ -4,7 +4,7 @@
 
 `ghtop` provides a number of views of all current public activity from all users across the entire GitHub platform. (Note that GitHub delays all events by five minutes.)
 
-<img width="850" src="https://user-images.githubusercontent.com/56260/101270865-3f033780-3732-11eb-8dcc-97caf7cc58e6.png" style="max-width: 850px">
+<img width="650" src="https://user-images.githubusercontent.com/1483922/105071141-0c3ea580-5a39-11eb-8808-34952c0bf26d.gif" style="max-width: 650px">
 
 ## Install
 
@@ -42,25 +42,25 @@ There are 4 views you can choose: `ghtop simple`, `ghtop tail`, `ghtop quad`, or
 
 A simple dump to your console of all events as they happen.
 
-<img src="https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png" width="500" style="max-width: 500px">
+<img src="https://user-images.githubusercontent.com/1483922/105074536-56298a80-5a3d-11eb-8e8c-32ba33e09405.png" width="650" style="max-width: 650px">
 
 ### ghtop tail
 
-Like `simple`, but removes most bots, and only includes releases, issues and PRs (open, close, and comment events). A summary of the frequency of push events is also shown at the bottom of the screen.
+Like `simple`, but only includes releases, issues and PRs (open, close, and comment events). A summary of the frequency of different kind of events along with sparklines are shown at the top of the screen.
 
-<img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" width="700" style="max-width: 700px">
+<img src="https://user-images.githubusercontent.com/1483922/105074448-398d5280-5a3d-11eb-9603-3def521d87e5.png" width="650" style="max-width: 650px">
 
 ### ghtop quad
 
-The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.
+The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases.
 
-<img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" width="900" style="max-width: 900px">
+<img src="https://user-images.githubusercontent.com/1483922/105074862-cb955b00-5a3d-11eb-99c5-3125bb98910b.png" width="650" style="max-width: 650px">
 
 ### ghtop users
 
 A summary of activity for the most active current users.
 
-<img src="https://user-images.githubusercontent.com/346999/101861612-4b6a0480-3b25-11eb-8124-19bb2434c27e.png" width="500" style="max-width: 500px">
+<img src="https://user-images.githubusercontent.com/1483922/105075363-8887b780-5a3e-11eb-9f7a-627268ac465f.png" width="650" style="max-width: 650px">
 
 ----
 

ghtop/all_rich.py

@@ -0,0 +1,84 @@
+from rich import print as pr
+from rich.align import *
+from rich.bar import *
+from rich.color import *
+from rich.columns import *
+from rich.console import *
+from rich.emoji import *
+from rich.highlighter import *
+from rich.live import *
+from rich.logging import *
+from rich.markdown import *
+from rich.markup import *
+from rich.measure import *
+from rich.padding import *
+from rich.panel import *
+from rich.pretty import *
+from rich.progress_bar import *
+from rich.progress import *
+from rich.prompt import *
+from rich.protocol import *
+from rich.rule import *
+from rich.segment import *
+from rich.spinner import *
+from rich.status import *
+from rich.style import *
+from rich.styled import *
+from rich.syntax import *
+from rich.table import *
+from rich.text import *
+from rich.theme import *
+from rich.traceback import *
+from fastcore.all import *
+
+@delegates(Style)
+def text(s, maxlen=None, **kwargs):
+    "Create a styled `Text` object"
+    if maxlen: s = truncstr(s, maxlen=maxlen)
+    return Text(s, style=Style(**kwargs))
+
+@delegates(Style)
+def segment(s, maxlen=None, space=' ', **kwargs):
+    "Create a styled `Segment` object"
+    if maxlen: s = truncstr(s, maxlen=maxlen, space=space)
+    return Segment(s, style=Style(**kwargs))
+
+class Segments(list):
+    def __init__(self, options): self.w = options.max_width
+    
+    @property
+    def chars(self): return sum(o.cell_length for o in self)
+    def txtlen(self, pct): return min((self.w-self.chars)*pct, 999)
+    
+    @delegates(segment)
+    def add(self, x, maxlen=None, pct=None, **kwargs):
+        if pct: maxlen = math.ceil(self.txtlen(pct))
+        self.append(segment(x, maxlen=maxlen, **kwargs))
+
+@delegates(Table)
+def _grid(box=None, padding=0, collapse_padding=True, pad_edge=False, expand=False, show_header=False, show_edge=False, **kwargs):
+    return Table(padding=padding, pad_edge=pad_edge, expand=expand, collapse_padding=collapse_padding,
+                 box=box, show_header=show_header, show_edge=show_edge, **kwargs)
+
+@delegates(_grid)
+def grid(items, expand=True, no_wrap=True, **kwargs):
+    g = _grid(expand=expand, **kwargs)
+    for c in items[0]: g.add_column(no_wrap=no_wrap, justify='center')
+    for i in items: g.add_row(*i)
+    return g
+
+Color = str_enum('Color', *ANSI_COLOR_NAMES)
+
+class Deque(deque):
+    def __rich__(self): return RenderGroup(*(filter(None, self)))
+
+@delegates()
+class FixedPanel(Panel, GetAttr):
+    _default='renderable'
+    def __init__(self, height, **kwargs):
+        super().__init__(Deque([' ']*height, maxlen=height), **kwargs)
+
+@delegates(Style)
+def add(self, s:str, **kwargs):
+    "Add styled `s` to panel"
+    self.append(text(s, **kwargs))

ghtop/ghtop.py

@@ -1,7 +1,7 @@
 
 
-__all__ = ['term', 'logfile', 'github_auth_device', 'limit_cb', 'api', 'Events', 'print_event', 'tail_events',
-           'watch_users', 'quad_logs', 'simple', 'main']
+__all__ = ['get_sparklines', 'ETYPES', 'term', 'tdim', 'github_auth_device', 'limit_cb', 'Events', 'print_event',
+           'pct_comp', 'tail_events', 'watch_users', 'quad_logs', 'simple', 'main']
 
 
 import sys, signal, shutil, os, json, emoji, enlighten
@@ -14,10 +14,29 @@
 from fastcore.foundation import *
 from fastcore.script import *
 from ghapi.all import *
+from .richext import *
+from .all_rich import (Console, Color, FixedPanel, box, Segments, Live,
+                            grid, ConsoleOptions, Progress, BarColumn, Spinner, Table)
+
+
+
+ETYPES=PushEvent,PullRequestEvent,IssuesEvent,ReleaseEvent
+
+def get_sparklines():
+    s1 = ESpark('Push', 'magenta', [PushEvent], mx=30)
+    s2 = ESpark('PR', 'yellow', [PullRequestEvent, PullRequestReviewCommentEvent, PullRequestReviewEvent], mx=8)
+    s3 = ESpark('Issues', 'green', [IssueCommentEvent,IssuesEvent], mx=6)
+    s4 = ESpark('Releases', 'blue', [ReleaseEvent], mx=0.4)
+    s5 = ESpark('All Events', 'orange', mx=45)
+
+    return Stats([s1,s2,s3,s4,s5], store=5, span=5, spn_lbl='5/s', show_freq=True)
 
 
 term = Terminal()
-logfile = Path("log.txt")
+
+tdim = L(os.popen('stty size', 'r').read().split())
+if not tdim: theight,twidth = 15,15
+else: theight,twidth = tdim.map(lambda x: max(int(x)-3, 15))
 
 
 def github_auth_device(wb='', n_polls=9999):
@@ -46,18 +65,6 @@ def limit_cb(rem,quota):
     if rem < 1000: print(f"{w}\nRemaining calls: {rem} out of {quota}\n{w}", file=sys.stderr)
 
 
-def _get_api():
-    path = Path.home()/".ghtop_token"
-    if path.is_file():
-        try: token = path.read_text().strip()
-        except: _exit("Error reading token")
-    else: token = github_auth_device()
-    path.write_text(token)
-    return GhApi(limit_cb=limit_cb, token=token)
-
-api = _get_api()
-
-
 Events = dict(
     IssuesEvent_closed=('⭐', 'closed', noop),
     IssuesEvent_opened=('📫', 'opened', noop),
@@ -78,79 +85,120 @@ def _to_log(e):
     elif e.type == "ReleaseEvent": return f'🚀 {login} released {e.payload.release.tag_name} of {repo}'
 
 
-def print_event(e, commits_counter):
+def print_event(e, counter):
     res = _to_log(e)
     if res: print(res)
-    elif e.type == "PushEvent": [commits_counter.update() for c in e.payload.commits]
+    elif counter and e.type == "PushEvent": [counter.update() for c in e.payload.commits]
     elif e.type == "SecurityAdvisoryEvent": print(term.blink("SECURITY ADVISORY"))
 
 
-def tail_events(evt):
-    "Print events from `fetch_events` along with a counter of push events"
-    manager = enlighten.get_manager()
-    commits = manager.counter(desc='Commits', unit='commits', color='green')
-    for ev in evt: print_event(ev, commits)
+def pct_comp(api): return int(((5000-int(api.limit_rem)) / 5000) * 100)
 
 
-def _pr_row(*its): print(f"{its[0]: <30} {its[1]: <6} {its[2]: <5} {its[3]: <6} {its[4]: <7}")
-def watch_users(evts):
+def tail_events(evt, api):
+    "Print events from `fetch_events` along with a counter of push events"
+    p = FixedPanel(theight, box=box.HORIZONTALS, title='ghtop')
+    s = get_sparklines()
+    g = grid([[s], [p]])
+    with Live(g):
+        for e in evt:
+            s.add_events(e)
+            s.update_prog(pct_comp(api))
+            p.append(e)
+            g = grid([[s], [p]])
+
+
+def _user_grid():
+    g = Table.grid(expand=True)
+    g.add_column(justify="left")
+    for i in range(4): g.add_column(justify="center")
+    g.add_row("", "", "", "", "")
+    g.add_row("User", "Events", "PRs", "Issues", "Pushes")
+    return g
+
+
+def watch_users(evts, api):
     "Print a table of the users with the most events"
     users,users_events = defaultdict(int),defaultdict(lambda: defaultdict(int))
-    while True:
-        for x in islice(evts, 10):
-            users[x.actor.login] += 1
-            users_events[x.actor.login][x.type] += 1
 
-        print(term.clear())
-        _pr_row("User", "Events", "PRs", "Issues", "Pushes")
-        sorted_users = sorted(users.items(), key=lambda o: (o[1],o[0]), reverse=True)
-        for u in sorted_users[:20]:
-            _pr_row(*u, *itemgetter('PullRequestEvent','IssuesEvent','PushEvent')(users_events[u[0]]))
+    with Live() as live:
+        s = get_sparklines()
+        while True:
+            for x in islice(evts, 10):
+                users[x.actor.login] += 1
+                users_events[x.actor.login][x.type] += 1
+                s.add_events(x)
 
+            ig = _user_grid()
+            sorted_users = sorted(users.items(), key=lambda o: (o[1],o[0]), reverse=True)
+            for u in sorted_users[:theight]:
+                data = (*u, *itemgetter('PullRequestEvent','IssuesEvent','PushEvent')(users_events[u[0]]))
+                ig.add_row(*L(data).map(str))
 
-def _push_to_log(e): return f"{e.actor.login} pushed {len(e.payload.commits)} commits to repo {e.repo.name}"
-def _logwin(title,color): return Log(title=title,border_color=2,color=color)
-
-def quad_logs(evts):
-    "Print 4 panels, showing most recent issues, commits, PRs, and releases"
-    term.enter_fullscreen()
-    ui = HSplit(VSplit(_logwin('Issues',        color=7), _logwin('Commits' , color=3)),
-                VSplit(_logwin('Pull Requests', color=4), _logwin('Releases', color=5)))
+            s.update_prog(pct_comp(api))
+            g = grid([[s], [ig]])
+            live.update(g)
 
-    issues,commits,prs,releases = all_items = ui.items[0].items+ui.items[1].items
-    for o in all_items: o.append(" ")
 
-    d = dict(PushEvent=commits, IssuesEvent=issues, IssueCommentEvent=issues, PullRequestEvent=prs, ReleaseEvent=releases)
-    while True:
-        for x in islice(evts, 10):
-            f = [_to_log,_push_to_log][x.type == 'PushEvent']
-            if x.type in d: d[x.type].append(f(x)[:95])
-        ui.display()
+def _panelDict2Grid(pd):
+    ispush,ispr,isiss,isrel = pd.values()
+    return grid([[ispush,ispr],[isiss,isrel]], width=twidth)
 
 
-def simple(evts):
+def quad_logs(evts, api):
+    "Print 4 panels, showing most recent issues, commits, PRs, and releases"
+    pd = {o:FixedPanel(height=(theight//2),
+                       width=(twidth//2)-1,
+                       box=box.HORIZONTALS,
+                       title=camel2words(remove_suffix(o.__name__,'Event'))) for o in ETYPES}
+    p = _panelDict2Grid(pd)
+    s = get_sparklines()
+    g = grid([[s], [p]])
+    with Live(g):
+        for e in evts:
+            s.add_events(e)
+            s.update_prog(pct_comp(api))
+            typ = type(e)
+            if typ in pd: pd[typ].append(e)
+            p = _panelDict2Grid(pd)
+            g = grid([[s], [p]])
+
+
+def simple(evts, api):
     for ev in evts: print(f"{ev.actor.login} {ev.type} {ev.repo.name}")
 
 
+def _get_token():
+    path = Path.home()/".ghtop_token"
+    if path.is_file():
+        try: return path.read_text().strip()
+        except: _exit("Error reading token")
+    else: token = github_auth_device()
+    path.write_text(token)
+    return token
+
+
 def _signal_handler(sig, frame):
     if sig != signal.SIGINT: return
     print(term.exit_fullscreen(),term.clear(),term.normal)
     sys.exit(0)
 
 _funcs = dict(tail=tail_events, quad=quad_logs, users=watch_users, simple=simple)
-_filts = str_enum('_filts', 'user', 'repo', 'org')
+_filts = str_enum('_filts', 'users', 'repo', 'org')
 _OpModes = str_enum('_OpModes', *_funcs)
 
 @call_parse
 def main(mode:         Param("Operation mode to run", _OpModes),
          include_bots: Param("Include bots (there's a lot of them!)", store_true)=False,
          types:        Param("Comma-separated types of event to include (e.g PushEvent)", str)='',
+         pause:        Param("Number of seconds to pause between requests to the GitHub api", float)=0.4,
          filt:         Param("Filtering method", _filts)=None,
          filtval:      Param("Value to filter by (for `repo` use format `owner/repo`)", str)=None):
     signal.signal(signal.SIGINT, _signal_handler)
     types = types.split(',') if types else None
     if filt and not filtval: _exit("Must pass `filter_value` if passing `filter_type`")
     if filtval and not filt: _exit("Must pass `filter_type` if passing `filter_value`")
     kwargs = {filt:filtval} if filt else {}
-    evts = api.fetch_events(types=types, incl_bot=include_bots, **kwargs)
-    _funcs[mode](evts)
+    api = GhApi(limit_cb=limit_cb, token=_get_token())
+    evts = api.fetch_events(types=types, incl_bot=include_bots, pause=float(pause), **kwargs)
+    _funcs[mode](evts, api)