<commit_before># Gallium - A Micro CLI Framework for Python

**Gallium Framework** is designed to eliminate the need of setting up bootstrap
and allow fast-pace CLI development where it only relies on built-in libraries
such as `ArgumentParser` to let the developers define the argument in the way
commonly known to any Python developers without asking them to learn new things.

So, the user can use run `gallium <sub-command> [...]` where the subcommands are
imported and defined in `cli.json` from the current working directory.

To override the default path of the configuration file, just run as
`GALLIUM_CONF=/path/to/config/anyname.json gallium ...`.

## Configuration

Here is the desired syntax.

```javascript
{
    "paths": [
        /* optional, additional python paths */
    ],
    "services": [
        /* optional, paths to the XML configuration for an Imagination Framework app

            This is the setup with Imagination Framework (https://github.com/shiroyuki/Imagination).
        */
    ],
    "imports": [
        /* optional, fully qualified class names, e.g., "sampleapp.cli.BasicHW"
            where the module name is "sampleapp.cli" and the class name is "BasicHW".

            This is the basic setup.
        */
    ]
}
```

The name of each subcommand is defined by either `ICommand.identifier()` for any
commands via the basic setup or the ID of the command entity defined in the setup<commit_msg>Added the help flag in the doc.<commit_after># Gallium - A Micro CLI Framework for Python

**Gallium Framework** is designed to eliminate the need of setting up bootstrap
and allow fast-pace CLI development where it only relies on built-in libraries
such as `ArgumentParser` to let the developers define the argument in the way
commonly known to any Python developers without asking them to learn new things.

So, the user can use run `gallium <sub-command> [...]` where the subcommands are
imported and defined in `cli.json` from the current working directory.

To override the default path of the configuration file, just run as
`GALLIUM_CONF=/path/to/config/anyname.json gallium ...`.

Please remember that when you are in doubt, use the classic `-h` or `--help` to find out more.

## Configuration

Here is the desired syntax.

```javascript
{
    "paths": [
        /* optional, additional python paths */
    ],
    "services": [
        /* optional, paths to the XML configuration for an Imagination Framework app

            This is the setup with Imagination Framework (https://github.com/shiroyuki/Imagination).
        */
    ],
    "imports": [
        /* optional, fully qualified class names, e.g., "sampleapp.cli.BasicHW"
            where the module name is "sampleapp.cli" and the class name is "BasicHW".

            This is the basic setup.
        */
    ]
}
```

The name of each subcommand is defined by either `ICommand.identifier()` for any
commands via the basic setup or the ID of the command entity defined in the setup
{'fraction_non_alphanumeric': 0.07981220657276995, 'fraction_numerical': 0.0, 'mean_word_length': 3.1258644536652835, 'pattern_counts': {'":': 6, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4752226', 'n_tokens_mistral': 793, 'n_tokens_neox': 760, 'n_words': 381}