Skip to content

Commit

Permalink
Rename executable script to grainyhead.
Browse files Browse the repository at this point in the history
`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.
  • Loading branch information
gouttegd committed Jan 18, 2023
1 parent f724c5c commit f781f2f
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 27 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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 (%) |
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 (%) |
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/old-issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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."
10 changes: 5 additions & 5 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: <personal access token>
Expand All @@ -33,10 +33,10 @@ GrainyHead commands
===================

Each GrainyHead command can be invoked directly from the command line (with
``grh <command>``), 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 <command>``), 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.

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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'),
Expand Down

0 comments on commit f781f2f

Please sign in to comment.