Rename executable to bcat

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Try to auto-detect package version if not explicitly specified.
-- Install executable `mpiis-doc-build`.
+- Install executable `bcat`.
 - Short arguments `-p`/`-o` for `--package-dir`/`--output-dir`.
 
 ### Changed

README.md

@@ -34,23 +34,24 @@ Usage
 In the most simple case you can run it like this:
 
 ```
-mpiis-doc-build --package-dir path/to/package --output-dir path/to/output
+bcat --package-dir path/to/package --output-dir path/to/output
 ```
 
-If no package version is specified, `mpiis-doc-build` tries to find it by checking a
+If no package version is specified, `bcat` tries to find it by checking a
 number of files in the package directory.  If no version is found this way, it fails
 with an error.  In this case, you can explicitly specify the version using
 `--package-version`.
 
-`mpiis-doc-build` tries to automatically detect if the package contains Python code and,
+`bcat` tries to automatically detect if the package contains Python code and,
 if yes, adds a Python API section to the documentation.  However, if your package
 contains Python modules that are only generated at build-time (e.g. Python bindings for
 C++ code) you can use `--python-dir` to specify the directory where the Python modules
 are installed to.  This way, the generated modules will be included in the documentation
 as well.
 
-For a complete list of options see `mpiis-doc-build --help`.
+For a complete list of options see `bcat --help`.
 
+Instead of the `bcat` executable, you can also use `python -m breathing_cat`.
 
 
 

breathing_cat/__main__.py

@@ -15,8 +15,8 @@ def AbsolutePath(path):
     parser.add_argument(
         "--version",
         action="version",
-        help="Show version of breathing_cat.",
-        version=f"breathing_cat version {__version__}",
+        help="Show version of breathing-cat.",
+        version=f"breathing-cat version {__version__}",
     )
     parser.add_argument(
         "--output-dir",
@@ -43,7 +43,7 @@ def AbsolutePath(path):
         "--package-version",
         type=str,
         help="""Package version that is shown in the documentation (something like
-            '1.42.0').  If not set, mpiis-doc-build tries to auto-detect it by looking
+            '1.42.0').  If not set, breathing-cat tries to auto-detect it by looking
             for files like package.xml in the package directory.
         """,
     )

pyproject.toml

@@ -29,7 +29,7 @@ dependencies = [
 
 
 [project.scripts]
-mpiis-doc-build = "breathing_cat.__main__:main"
+bcat = "breathing_cat.__main__:main"
 
 [tool.setuptools.package-data]
 breathing_cat = ["resources/**/*.in"]