Show supported financial institutions in help

Author: rlan

README.md

@@ -1,7 +1,10 @@
 # Beancount Multitool
 
 ![Tests badge](https://github.com/rlan/beancount-multitool/actions/workflows/tests.yml/badge.svg)
-![python version required](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Frlan%2Fbeancount-multitool%2Fmain%2Fpyproject.toml)
+![pypi version](https://img.shields.io/pypi/v/beancount-multitool
+)
+![python version required](https://img.shields.io/pypi/pyversions/beancount-multitool
+)
 ![static coverage badge](https://img.shields.io/badge/Coverage-97%25-blue)
 
 Beancount Multitool is a command-line-interface (CLI) tool that converts financial data from financial institutions to Beancount files.
@@ -25,15 +28,25 @@ What these scripts __can not__ (yet) do:
 
 * Label transactions with different sub-accounts, e.g., `Expenses:JP:Food:Grocery` or `Expenses:JP:Food:Restaurant`.
 
+Installation:
+
+```sh
+pip install beancount-multitool
+```
+
 Usage:
 
+```sh
+bean-mt --help
+```
+
 ```txt
-$ bean-mt --help
 Usage: bean-mt [OPTIONS] NAME CONFIG DATA
 
   Read financial data and output a Beancount file.
 
-  NAME is the name of the financial institution, e.g. RakutenBank.
+  NAME is the name of the financial institution. See Note below for a list of
+  supported names.
 
   CONFIG is a .toml file with run-time configurations, e.g. config.toml.
 
@@ -43,6 +56,9 @@ Options:
   --output PATH  Resulting Beancount file
   --version      Show the version and exit.
   --help         Show this message and exit.
+
+  Note: supported names of financial institutions: ['ja_bank', 'rakuten_bank',
+  'rakuten_card', 'shinsei_bank']
 ```
 
 Example:
@@ -62,12 +78,6 @@ config.toml:
 
 There is a default config.toml per financial institutions. Examples are in the test [data folder](./tests/data/).
 
-## Installation
-
-```sh
-pip install beancount-multitool
-```
-
 ## Requirements
 
 * Python 3.9 or higher.

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+0.2.0
+
+* Show a list of supported financial institutions in --help.
+
 0.1.0
 
 * Initial version.

pyproject.toml

@@ -1,11 +1,25 @@
 [tool.poetry]
 name = "beancount-multitool"
-version = "0.1.0"
+version = "0.2.0"
 description = "A CLI tool that converts financial data to Beancount files"
-authors = ["Rick Lan"]
+authors = ["Rick Lan <[email protected]>"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/rlan/beancount-multitool"
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Framework :: Pytest",
+  "Intended Audience :: Financial and Insurance Industry",
+  "License :: OSI Approved :: MIT License",
+  "Natural Language :: English",
+  "Natural Language :: Japanese",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Topic :: Office/Business :: Financial :: Accounting",
+  "Topic :: Office/Business :: Financial :: Investment",
+  "Topic :: Text Processing :: General",
+  "Topic :: Utilities",
+]
 
 [tool.poetry.dependencies]
 python = "^3.9"

src/beancount_multitool/__version__.py

@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.2.0"

src/beancount_multitool/cli.py

@@ -17,7 +17,7 @@ def validate_name(ctx, param, value):
     else:
         raise click.BadParameter(f"Name must be one of: {__INSTITUTIONS__}")
 
-@click.command()
+@click.command(epilog=f"Note: supported names of financial institutions: {__INSTITUTIONS__}")
 @click.argument('name', type=str, callback=validate_name)
 @click.argument('config', type=click.Path(exists=True))
 @click.argument('data', type=click.Path(exists=True))
@@ -26,16 +26,12 @@ def validate_name(ctx, param, value):
 def main(name: str, config, data, output):
     """Read financial data and output a Beancount file.
 
-    NAME is the name of the financial institution, e.g. RakutenBank.
+    NAME is the name of the financial institution. See Note below for a list of supported names.
 
     CONFIG is a .toml file with run-time configurations, e.g. config.toml.
 
     DATA is the raw financial data downloaded from NAME, e.g. input.csv.
     """
-    #click.echo(name)
-    #click.echo(data)
-    #click.echo(config)
-    #click.echo(output)
     if name == JABank.NAME:
         tool = JABank(config)
     elif name == RakutenBank.NAME: