Add command documentation.

roentgen/__init__.py

@@ -11,3 +11,4 @@ __url__ = "https://github.com/enzet/Roentgen"
 __doc_url__ = f"{__url__}/blob/main/README.md"
 __author__ = "Sergey Vartanov"
 __email__ = "me@enzet.ru"
+__version__ = "0.1.2"

roentgen/main.py

@@ -20,7 +20,10 @@ def main() -> None:
 
     arguments: argparse.Namespace = parse_options(sys.argv)
 
-    if arguments.command == "render":
+    if not arguments.command:
+        print("No command provided. See --help.")
+
+    elif arguments.command == "render":
         from roentgen import mapper
 
         mapper.ui(arguments)

roentgen/ui.py

@@ -4,6 +4,7 @@ Command-line user interface.
 import argparse
 import sys
 
+from roentgen import __version__
 from roentgen.map_configuration import BuildingMode, DrawingMode, LabelMode
 from roentgen.osm_reader import STAGES_OF_DECAY
 
@@ -19,22 +20,36 @@ def parse_options(args: list[str]) -> argparse.Namespace:
     parser: argparse.ArgumentParser = argparse.ArgumentParser(
         description="Röntgen. OpenStreetMap renderer with custom icon set"
     )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version="Röntgen " + __version__,
+    )
     subparser = parser.add_subparsers(dest="command")
 
-    tile_parser = subparser.add_parser("tile")
-    add_tile_arguments(tile_parser)
-    add_map_arguments(tile_parser)
-
-    render_parser = subparser.add_parser("render")
+    render_parser = subparser.add_parser("render", help="draw SVG map")
     add_render_arguments(render_parser)
     add_map_arguments(render_parser)
 
-    add_server_arguments(subparser.add_parser("server"))
-    add_element_arguments(subparser.add_parser("element"))
-    add_mapcss_arguments(subparser.add_parser("mapcss"))
+    tile_parser = subparser.add_parser(
+        "tile", help="generate PNG tiles for slippy maps"
+    )
+    add_tile_arguments(tile_parser)
+    add_map_arguments(tile_parser)
 
-    subparser.add_parser("icons")
-    subparser.add_parser("taginfo")
+    add_server_arguments(subparser.add_parser("server", help="run tile server"))
+    add_element_arguments(
+        subparser.add_parser(
+            "element", help="draw OSM element: node, way, relation"
+        )
+    )
+    add_mapcss_arguments(
+        subparser.add_parser("mapcss", help="write MapCSS file")
+    )
+
+    subparser.add_parser("icons", help="draw icons")
+    subparser.add_parser("taginfo", help="write Taginfo JSON file")
 
     arguments: argparse.Namespace = parser.parse_args(args[1:])
 

setup.py

@@ -1,15 +1,28 @@
 """
 Röntgen project dynamic metadata.
 """
+from pathlib import Path
+
 from setuptools import setup
+from roentgen import (
+    __author__,
+    __description__,
+    __doc_url__,
+    __email__,
+    __url__,
+    __version__,
+)
+
+with Path("README.md").open() as input_file:
+    long_description: str = input_file.read()
 
 setup(
     name="roentgen-map",
-    version="0.1.2",
+    version=__version__,
     packages=["roentgen"],
-    url="https://github.com/enzet/Roentgen",
+    url=__url__,
     project_urls={
-        "Bug Tracker": "https://github.com/enzet/Roentgen/issues",
+        "Bug Tracker": f"{__url__}/issues",
     },
     classifiers=[
         "Programming Language :: Python :: 3",
@@ -17,12 +30,14 @@ setup(
         "Operating System :: OS Independent",
     ],
     license="MIT",
-    author="Sergey Vartanov",
-    author_email="me@enzet.ru",
-    description="Python renderer for OpenStreetMap with custom icon set",
+    author=__author__,
+    author_email=__email__,
+    description=__description__,
     long_description="Röntgen is a Python OpenStreetMap renderer and tile "
     "generator with a custom set of CC-BY 4.0 icons aimed to display as many "
-    "map features as possible.",
+    "map features as possible.\n\n"
+    f"See [full documentation]({__doc_url__}).",
+    long_description_content_type="text/markdown",
     entry_points={
         "console_scripts": ["roentgen=roentgen.main:main"],
     },