From f781f2f1bb1fb6a9015fb07f938b0ce5e8cd2a7d Mon Sep 17 00:00:00 2001 From: Damien Goutte-Gattat Date: Wed, 18 Jan 2023 19:56:41 +0000 Subject: [PATCH] Rename executable script to `grainyhead`. `grh` is short and nice, but is already used out there, and GrainyHead is not the kind of tools that someone would use often enough to warrant a 3-letters name. So we call the executable `grainyhead` from now on. --- README.md | 16 ++++++++-------- docs/configuration.rst | 6 +++--- docs/install.rst | 2 +- docs/metrics.rst | 12 ++++++------ docs/old-issues.rst | 4 ++-- docs/quickstart.rst | 10 +++++----- setup.py | 4 ++-- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 6f7c794..f56e9f7 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,13 @@ repository URL and your access token when you first invoke the program. Usage ----- -Invoke `grh` with the `--help` option to get the list of available -commands. Invoke a command with that same option to get a detailled help -message for the command. +Invoke `grainyhead` with the `--help` option to get the list of +available commands. Invoke a command with that same option to get a +detailled help message for the command. -If called without any command, `grh` will enter into an interactive -shell mode, from which commands can be entered repeatedly without -leaving the program. +If called without any command, `grainyhead` will enter into an +interactive shell mode, from which commands can be entered repeatedly +without leaving the program. ### Listing old issues in a repository @@ -60,7 +60,7 @@ Use the `issues` command to list open issues that have not been updated for a while (365 days by default): ``` -$ grh issues +$ grainyhead issues ``` The output is a Markdown-style table containing, for each issue, its @@ -89,7 +89,7 @@ The `metrics` command will list some statistics about the repository over a given period of time: ``` -$ grh metrics +$ grainyhead metrics From 2021-09-02 to 2021-12-01 | Event | Total | Internal | Inte (%) | External | Exte (%) | diff --git a/docs/configuration.rst b/docs/configuration.rst index 6259a12..b00b154 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -84,6 +84,6 @@ Here is a sample configuration file for GrainyHead: repository: gouttegd/biopython token: ghp_YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY -With such a file, calling ``grh -s bio`` will make any subcommand work on the -*Biopython* repository. Calling simply ``grh`` will make the subcommands work on -the *GrainyHead* repository. +With such a file, calling ``grainyheadh -s bio`` will make any subcommand work +on the *Biopython* repository. Calling simply ``grh`` will make the subcommands +work on the *GrainyHead* repository. diff --git a/docs/install.rst b/docs/install.rst index 3b10572..f7c299c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -61,7 +61,7 @@ Testing the installation ======================== Once installed, GrainyHead may be invoked from the command line by calling the -``grh`` program. You can check whether it has been installed correctly by +``grainyhead`` program. You can check whether it has been installed correctly by running the following command: .. code-block:: console diff --git a/docs/metrics.rst b/docs/metrics.rst index 7d82fbf..abdaaa2 100644 --- a/docs/metrics.rst +++ b/docs/metrics.rst @@ -45,7 +45,7 @@ Here is an example of a default report: .. code-block:: console - $ grh metrics + $ grainyhead metrics From 2021-09-02 to 2021-12-01 | Event | Total | Internal | Inte (%) | External | Exte (%) | @@ -153,7 +153,7 @@ Here is an example of a custom report request: .. code-block:: console - $ grh metrics \ + $ grainyhead metrics \ --selector 'all = Total' \ --selector '!team:elite = Others' \ --selector 'label:bugfix = Bugs' @@ -200,7 +200,7 @@ Here is an example of the effect of the ``= NAME`` syntax: .. code-block:: console - $ grh metrics \ + $ grainyhead metrics \ --selector '!team:elite = Others' \ --selector 'label:bugfix' From 2021-11-09 to 2022-05-08 @@ -223,7 +223,7 @@ events corresponding to the selector relatively to all events: .. code-block:: console - $ grh metrics \ + $ grainyhead metrics \ --selector 'all = Total' \ --selector '!team:elite = Others' From 2021-11-09 to 2022-05-08 @@ -316,7 +316,7 @@ Here is an example of CSV output: .. code-block:: console - $ grh metrics --format csv \ + $ grainyhead metrics --format csv \ --selector 'all = Total' \ --selector '!team:elite = Others' \ --selector 'label:bugfix = Bugs' @@ -371,7 +371,7 @@ in quarterly periods: .. code-block:: console - $ grh metrics --format csv --from 1y --period 3m + $ grainyhead metrics --format csv --from 1y --period 3m Date,Selector,Selector name,Issues opened,Issues closed,Pull requests opened,Pull requests closed,Pull requests merged,Comments,Commits,Releases,Contributors 2021-08-08,all,Total,90,509,88,84,62,927,200,4,26 2021-11-08,all,Total,60,56,63,70,57,401,185,2,28 diff --git a/docs/old-issues.rst b/docs/old-issues.rst index 21038d2..643dd3f 100644 --- a/docs/old-issues.rst +++ b/docs/old-issues.rst @@ -39,7 +39,7 @@ The following example will list issues that have not been updated in the past .. code-block:: console - grh issues --older-than 6m --team elite + $ grainyhead issues --older-than 6m --team elite .. _closing-old-issues: @@ -71,5 +71,5 @@ updated in the past 3 years: .. code-block:: console - grh close --older-than 3y --limit 30 \ + $ grainyhead close --older-than 3y --limit 30 \ --comment "This issue has been closed automatically." diff --git a/docs/quickstart.rst b/docs/quickstart.rst index f024ac1..49a669b 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -18,7 +18,7 @@ access token* to authenticate on GitHub: .. code-block:: console - $ grh + $ grainyhead Repository name or URL: https://github.com/gouttegd/grainyhead Visit https://github.com/settings/tokens to create a personal access token Token: @@ -33,10 +33,10 @@ GrainyHead commands =================== Each GrainyHead command can be invoked directly from the command line (with -``grh ``), in which case GrainyHead will perform the corresponding -task then quit. Otherwise, if no command is specified, you enter into an -interactive shell from which you can repeatedly run commands without quiting -GrainyHead. +``grainyhead ``), in which case GrainyHead will perform the +corresponding task then quit. Otherwise, if no command is specified, you enter +into an interactive shell from which you can repeatedly run commands without +quitting GrainyHead. Use the ``help`` command to get the list of available commands. diff --git a/setup.py b/setup.py index 260ad44..4acdfa8 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,5 @@ # grainyhead - Helper tools for GitHub -# Copyright © 2021,2022 Damien Goutte-Gattat +# Copyright © 2021,2022,2023 Damien Goutte-Gattat # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -38,7 +38,7 @@ install_requires=['click_shell >= 2.1', 'ghapi', 'python-dateutil'], extras_require={'IPython': ['ipython']}, packages=['incenp', 'incenp.grainyhead'], - entry_points={'console_scripts': ['grh = incenp.grainyhead.main:grh']}, + entry_points={'console_scripts': ['grainyhead = incenp.grainyhead.main:grh']}, command_options={ 'build_sphinx': { 'project': ('setup.py', 'GrainyHead'),