[ENH] add code and test to help create schemas

.gitignore

@@ -1,3 +1,6 @@
+**/tmp
+Pipfile
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -2,13 +2,19 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.6.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: check-added-large-files
+
 -   repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 24.4.2
     hooks:
     -   id: black
+
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: "v3.12.0"
+    hooks:
+        - id: reorder-python-imports

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "reproschema"
+    ],
+    "autoDocstring.docstringFormat": "sphinx",
+    "esbonio.sphinx.confDir": ""
+}

Makefile

@@ -0,0 +1,38 @@
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+## DOC
+.PHONY: docs
+
+docs: ## generate Sphinx HTML documentation, including API docs
+	rm -f docs/source/reproschema.rst
+	rm -f docs/source/modules.rst
+	sphinx-apidoc -o docs/source reproschema
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	$(BROWSER) docs/build/html/index.html

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/architecture.md

@@ -0,0 +1,20 @@
+# architecture
+
+<!-- https://mermaid-js.github.io/mermaid/#/ -->
+
+```{mermaid}
+    classDiagram
+        SchemaUtils <|-- UI
+        SchemaBase  *--  UI
+        SchemaBase  <|--  Protocol
+        SchemaBase  <|--  Activity
+        SchemaUtils <|-- Message
+        SchemaBase  <|--  Item
+        Item  *--  ResponseOption
+        SchemaUtils <|-- ResponseOption
+        SchemaUtils <|-- AdditionalNoteObj
+        SchemaUtils <|-- unitOption
+        SchemaUtils <|-- Choice
+        SchemaUtils <|-- AdditionalProperty
+        SchemaUtils <|-- SchemaBase
+```

docs/source/conf.py

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# -- Path setup --------------------------------------------------------------
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "reproschema-py"
+copyright = "2022, Repronim developers"
+author = "Repronim developers"
+
+# The full version, including alpha/beta/rc tags
+release = "0.6.2"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.autodoc", "myst_parser", "sphinxcontrib.mermaid"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. reproschema-py documentation master file, created by
+   sphinx-quickstart on Mon Aug 15 22:56:47 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to reproschema-py's documentation!
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   architecture
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+reproschema
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   reproschema

docs/source/reproschema.models.rst

@@ -0,0 +1,69 @@
+reproschema.models package
+==========================
+
+Submodules
+----------
+
+reproschema.models.activity module
+----------------------------------
+
+.. automodule:: reproschema.models.activity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.base module
+------------------------------
+
+.. automodule:: reproschema.models.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.item module
+------------------------------
+
+.. automodule:: reproschema.models.item
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.protocol module
+----------------------------------
+
+.. automodule:: reproschema.models.protocol
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.response\_options module
+-------------------------------------------
+
+.. automodule:: reproschema.models.response_options
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.ui module
+----------------------------
+
+.. automodule:: reproschema.models.ui
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.models.utils module
+-------------------------------
+
+.. automodule:: reproschema.models.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: reproschema.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/reproschema.rst

@@ -0,0 +1,53 @@
+reproschema package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   reproschema.models
+
+Submodules
+----------
+
+reproschema.cli module
+----------------------
+
+.. automodule:: reproschema.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.jsonldutils module
+------------------------------
+
+.. automodule:: reproschema.jsonldutils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.utils module
+------------------------
+
+.. automodule:: reproschema.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+reproschema.validate module
+---------------------------
+
+.. automodule:: reproschema.validate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: reproschema
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.pytest.ini_options]
+minversion = "4.4.0"
+addopts = "-ra -vv"

reproschema/_version.py

@@ -3,12 +3,9 @@
 # feature). Distribution tarballs (built by setup.py sdist) and build
 # directories (produced by setup.py build) will contain a much shorter file
 # that just contains the computed version number.
-
 # This file is released into the public domain. Generated by
 # versioneer-0.18 (https://github.com/warner/python-versioneer)
-
 """Git implementation of _version.py."""
-
 import errno
 import os
 import re

reproschema/cli.py

@@ -1,8 +1,10 @@
 import os
+
 import click
 
-from . import get_logger, set_logger_level
 from . import __version__
+from . import get_logger
+from . import set_logger_level
 
 lgr = get_logger()