Merge pull request #624 from common-workflow-language/codegen_docs

codegen: document examples, freshen argparse help

Author: mergify[bot]

README.rst

@@ -98,6 +98,27 @@ render as SVG::
 
    $ schema-salad-tool --print-inheritance-dot myschema.yml | dot -Tsvg > myschema.svg
 
+Codegen Examples
+----------------
+
+These are helpful to see how to use the output of `schema-salad-tool --codegen`
+in different languages for loading and/or creating/editing/saving objects,
+using the `CWL v1.2 schema <https://github.com/common-workflow-language/cwl-v1.2/blob/1.2.1_proposed/CommonWorkflowLanguage.yml>`_
+as an example.
+
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Language    | Repository                                              | Serializaton Example                                                                                                                                 | Deserialization Example                                                                                                                                                    |
++=============+=========================================================+======================================================================================================================================================+============================================================================================================================================================================+
+| Python      | https://github.com/common-workflow-language/cwl-utils/  | `create_cwl_from_objects.py <https://github.com/common-workflow-language/cwl-utils/blob/main/create_cwl_from_objects.py>`_                           | `load_document() <https://github.com/common-workflow-language/cwl-utils/blob/main/cwl_utils/parser/__init__.py#L93>`_                                                      |
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Java        | https://github.com/common-workflow-language/cwljava/    | (Not yet implemented)                                                                                                                                | `PackedWorkflowClassTest.java <https://github.com/common-workflow-language/cwljava/blob/cwl-1.2.0/src/test/java/org/w3id/cwl/cwl1_2/utils/PackedWorkflowClassTest.java>`_  |
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| TypeScript  | https://github.com/common-workflow-lab/cwl-ts-auto      | `Creating, editing, and saving CWL docs with TypeScript <https://github.com/common-workflow-lab/cwl-ts-auto#creating-editing-and-saving-documents>`_ | `Loading CWL documents with TypeScript <https://github.com/common-workflow-lab/cwl-ts-auto#loading-documents>`_                                                            |
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| .Net        | https://github.com/common-workflow-lab/CWLDotNet        | `Creating, editing, and saving CWL docs with .Net <https://github.com/common-workflow-lab/CWLDotNet#creating-editing-and-serializing-documents>`_    | `Loading CWL documents with .Net <https://github.com/common-workflow-lab/CWLDotNet#loading-documents>`_                                                                    |
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| C++         | https://github.com/common-workflow-lab/cwl-cpp-auto     | `cwl_output_example.cpp <https://github.com/common-workflow-lab/cwl-cpp-auto/blob/main/cwl_output_example.cpp>`_                                     | (Not yet implemented)                                                                                                                                                      |
++-------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Quick Start
 -----------

schema_salad/main.py

@@ -95,22 +95,22 @@ def arg_parser() -> argparse.ArgumentParser:
         type=str,
         metavar="language",
         help="Generate classes in target language, currently supported: "
-        "python, java, typescript, dotnet",
+        "python, java, typescript, dotnet, cpp",
     )
 
     parser.add_argument(
         "--codegen-target",
         type=str,
         default=None,
-        help="Defaults to sys.stdout for python and ./ for Java",
+        help="Defaults to sys.stdout for Python/C++ and ./ for " "Java/TypeScript/.Net",
     )
 
     parser.add_argument(
         "--codegen-examples",
         type=str,
         metavar="directory",
         default=None,
-        help="Directory of example documents for test case generation (Java only).",
+        help="Directory of example documents for test case generation (Java/TypeScript/.Net only).",
     )
 
     parser.add_argument(
@@ -119,7 +119,7 @@ def arg_parser() -> argparse.ArgumentParser:
         metavar="dotted.package",
         default=None,
         help="Optional override of the package name which is other derived "
-        "from the base URL (Java only).",
+        "from the base URL (Java/TypeScript/.Net only).",
     ),
 
     parser.add_argument(

tox.ini

@@ -78,10 +78,10 @@ skip_install = true
 [testenv:py310-lintreadme]
 description = Lint the README.rst->.md conversion
 commands =
-  make dist
-  twine check dist/*
+  make clean dist
+  twine check dist/schema[-_]salad*
 deps =
     twine
-    wheel
+    build
     readme_renderer[md]
 skip_install = true