index

Author: jph00

README.md

@@ -12,29 +12,53 @@ Either `pip install ghtop` or `conda install -c fastai ghtop`.
 
 ## How to use
 
-Run `ghtop -h` to view the help. There are 4 views you can choose:
+Run `ghtop -h` to view the help:
 
-### `ghtop simple`
+```bash
+$ ghtop -h
+usage: ghtop [-h] [--include_bots] [--types TYPES] [--filt {user,repo,org}] [--filtval FILTVAL]
+             {tail,quad,users,simple}
+
+positional arguments:
+  {tail,quad,users,simple}  Operation mode to run
+
+optional arguments:
+  -h, --help                show this help message and exit
+  --include_bots            Include bots (there is a lot of them!) (default: False)
+  --types TYPES             Comma-separated types of event to include (e.g PushEvent)
+  --filt {user,repo,org}    Filtering method
+  --filtval FILTVAL         Value to filter by (for `repo` use format `owner/repo`)
+```
+
+There are 4 views you can choose: `ghtop simple`, `ghtop tail`, `ghtop quad`, or `ghtop users`. Each are shown and described below. All views have the following options:
+
+- `--include_bots`: By default events that appear to be from bots are excluded. Add this flag to include them
+- `--types TYPES`: Optional comma-separated list of event types to include (defaults to all types). For a full list of types, see the GitHub [event types docs](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/github-event-types)
+- `--filt` and `--filtval`: Optionally filter events to just those from one of: `user`, `repo`, or `org`, depending on `filt`. `filtval` is the value to filter by. See the [GitHub docs](https://docs.github.com/en/free-pro-team@latest/rest/reference/activity#list-public-events) for details on the public event API calls used.
+
+**Important note**: while running, `ghtop` will make about 5 API calls per second. GitHub has a quota of 5000 calls per hour. When there are 1000 calls left, `ghtop` will show a warning on every call.
+
+### ghtop simple
 
 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">
 
-### `ghtop tail`
+### 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.
 
 <img src="https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png" width="700" style="max-width: 700px">
 
-### `ghtop quad`
+### 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.
 
 <img src="https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png" width="900" style="max-width: 900px">
 
-### `ghtop users`
+### ghtop users
 
-A summary of activity for the most active current users, including bots.
+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">
 

nbs/index.ipynb

@@ -43,10 +43,44 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Run `ghtop -h` to view the help. There are 4 views you can choose:\n",
+    "Run `ghtop -h` to view the help:\n",
     "\n",
-    "### `ghtop simple`\n",
+    "```bash\n",
+    "$ ghtop -h\n",
+    "usage: ghtop [-h] [--include_bots] [--types TYPES] [--filt {user,repo,org}] [--filtval FILTVAL]\n",
+    "             {tail,quad,users,simple}\n",
     "\n",
+    "positional arguments:\n",
+    "  {tail,quad,users,simple}  Operation mode to run\n",
+    "\n",
+    "optional arguments:\n",
+    "  -h, --help                show this help message and exit\n",
+    "  --include_bots            Include bots (there is a lot of them!) (default: False)\n",
+    "  --types TYPES             Comma-separated types of event to include (e.g PushEvent)\n",
+    "  --filt {user,repo,org}    Filtering method\n",
+    "  --filtval FILTVAL         Value to filter by (for `repo` use format `owner/repo`)\n",
+    "```\n",
+    "\n",
+    "There are 4 views you can choose: `ghtop simple`, `ghtop tail`, `ghtop quad`, or `ghtop users`. Each are shown and described below. All views have the following options:\n",
+    "\n",
+    "- `--include_bots`: By default events that appear to be from bots are excluded. Add this flag to include them\n",
+    "- `--types TYPES`: Optional comma-separated list of event types to include (defaults to all types). For a full list of types, see the GitHub [event types docs](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/github-event-types)\n",
+    "- `--filt` and `--filtval`: Optionally filter events to just those from one of: `user`, `repo`, or `org`, depending on `filt`. `filtval` is the value to filter by. See the [GitHub docs](https://docs.github.com/en/free-pro-team@latest/rest/reference/activity#list-public-events) for details on the public event API calls used.\n",
+    "\n",
+    "**Important note**: while running, `ghtop` will make about 5 API calls per second. GitHub has a quota of 5000 calls per hour. When there are 1000 calls left, `ghtop` will show a warning on every call."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### ghtop simple"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
     "A simple dump to your console of all events as they happen.\n",
     "\n",
     "<img src=\"https://user-images.githubusercontent.com/346999/101861674-79e7df80-3b25-11eb-92d3-f888843f4aa2.png\" width=\"500\" align=\"left\">"
@@ -56,8 +90,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### `ghtop tail`\n",
-    "\n",
+    "### ghtop tail"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
     "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.\n",
     "\n",
     "<img src=\"https://user-images.githubusercontent.com/346999/101861658-69376980-3b25-11eb-96ef-9d68f075abf7.png\" width=\"700\" align=\"left\">"
@@ -67,8 +106,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### `ghtop quad`\n",
-    "\n",
+    "### ghtop quad"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
     "The same information as `tail`, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.\n",
     "\n",
     "<img src=\"https://user-images.githubusercontent.com/346999/101861560-2ecdcc80-3b25-11eb-9fba-25382b2df65f.png\" width=\"900\" align=\"left\">"
@@ -78,9 +122,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### `ghtop users`\n",
-    "\n",
-    "A summary of activity for the most active current users, including bots.\n",
+    "### ghtop users"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "A summary of activity for the most active current users.\n",
     "\n",
     "<img src=\"https://user-images.githubusercontent.com/346999/101861612-4b6a0480-3b25-11eb-8124-19bb2434c27e.png\" width=\"500\" align=\"left\">\n",
     "\n",

settings.ini

@@ -12,7 +12,7 @@ audience = Developers
 language = English
 license = apache2
 status = 2
-requirements = emoji enlighten py-dashing fastcore ghapi>0.1.7
+requirements = emoji enlighten py-dashing fastcore ghapi>0.1.9
 console_scripts = ghtop=ghtop.ghtop:main
 branch = master
 custom_sidebar = False