sdv-doc-waterloo 0.10.0__tar.gz

sdv_doc_waterloo-0.10.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: sdv_doc_waterloo
+Version: 0.10.0
+Summary: Waterloo - Docstring Format and Tools
+Author: Uwe
+License: BSD-2-Clause
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: jsonschema
+Requires-Dist: jsonpointer
+Requires-Dist: pygments
+Requires-Dist: python-waterloo-lexer
+Requires-Dist: docutils
+Requires-Dist: mcp
+Requires-Dist: tomli; python_version < "3.11"
+Provides-Extra: sphinx
+Requires-Dist: sphinx; extra == "sphinx"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+
+## PRELIMINARY - OFFICIAL START AT 2026-07-01
+
+<p align="center">
+	<img src="img/wtrl_logo_color.svg" alt="Waterloo Logo" width="240">
+</p>
+
+## README
+
+### Install
+
+`package_main` contains the Waterloo Python package and the Sphinx extension.
+The package can be installed from a local checkout of this repository:
+
+```bash
+cd package_main
+pip install .
+```
+
+For development, an editable install is often more convenient:
+
+```bash
+cd package_main
+pip install -e .
+```
+
+If you want to build the documentation with the Sphinx extension, install
+the optional extra that provides the external `sphinx` dependency:
+
+```bash
+cd package_main
+pip install ".[sphinx]"
+```
+
+The package can also be installed directly from Git:
+
+```bash
+pip install "git+https://github.com/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"
+```
+
+SSH works as well for authenticated access:
+
+```bash
+pip install "git+ssh://git@github.com/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"
+```
+
+### Sitemap
+
+#### Branch gh-pages
+
+* Human-readable documentation
+  * ``https://...``
+
+#### Branch ide-plugins
+
+* Additional utilities
+  * Clone directly:
+    * ``git clone --branch ide-plugins --single-branch https://github.com/uwe-at-sdv/sdv_doc_waterloo.git``
+  * Lexer for ``pygments``
+    * ``pygments/python_waterloo_lexer.py``
+  * Extension for ``vscode``
+    * Waterloo syntax highlighting
+    * Context menu commands for docstring generation and validation
+
+#### Branch main
+
+* Machine-readable documentation
+  * ``src/sdv/doc/waterloo/doc-json/docitem.wtrl.*.*.json``
+  * ``src/sdv/doc/waterloo/doc-json/docitem_sphinx.wtrl.*.*.json``
+
+* JSON-Schema
+  * ``src/sdv/doc/waterloo/schema/wtrl-*-json-*.*.*.schema.json``
+
+* Public modules:
+  * ``src/sdv/doc/waterloo/docitem_helper.py``
+  * ``src/sdv/doc/waterloo/docitem_convert.py``
+  * ``src/sdv/doc/waterloo/docitem_sphinx.py``
+
+* Change logs:
+  * ``src/sdv/doc/waterloo/docitem.py`` following the definition of ``__version__``
+  * ``src/sdv/doc/waterloo/waterlint.py`` following the definition of ``__version__``

sdv_doc_waterloo-0.10.0/README.md

@@ -0,0 +1,80 @@
+## PRELIMINARY - OFFICIAL START AT 2026-07-01
+
+<p align="center">
+	<img src="img/wtrl_logo_color.svg" alt="Waterloo Logo" width="240">
+</p>
+
+## README
+
+### Install
+
+`package_main` contains the Waterloo Python package and the Sphinx extension.
+The package can be installed from a local checkout of this repository:
+
+```bash
+cd package_main
+pip install .
+```
+
+For development, an editable install is often more convenient:
+
+```bash
+cd package_main
+pip install -e .
+```
+
+If you want to build the documentation with the Sphinx extension, install
+the optional extra that provides the external `sphinx` dependency:
+
+```bash
+cd package_main
+pip install ".[sphinx]"
+```
+
+The package can also be installed directly from Git:
+
+```bash
+pip install "git+https://github.com/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"
+```
+
+SSH works as well for authenticated access:
+
+```bash
+pip install "git+ssh://git@github.com/uwe-at-sdv/sdv_doc_waterloo.git@main#subdirectory=package_main"
+```
+
+### Sitemap
+
+#### Branch gh-pages
+
+* Human-readable documentation
+  * ``https://...``
+
+#### Branch ide-plugins
+
+* Additional utilities
+  * Clone directly:
+    * ``git clone --branch ide-plugins --single-branch https://github.com/uwe-at-sdv/sdv_doc_waterloo.git``
+  * Lexer for ``pygments``
+    * ``pygments/python_waterloo_lexer.py``
+  * Extension for ``vscode``
+    * Waterloo syntax highlighting
+    * Context menu commands for docstring generation and validation
+
+#### Branch main
+
+* Machine-readable documentation
+  * ``src/sdv/doc/waterloo/doc-json/docitem.wtrl.*.*.json``
+  * ``src/sdv/doc/waterloo/doc-json/docitem_sphinx.wtrl.*.*.json``
+
+* JSON-Schema
+  * ``src/sdv/doc/waterloo/schema/wtrl-*-json-*.*.*.schema.json``
+
+* Public modules:
+  * ``src/sdv/doc/waterloo/docitem_helper.py``
+  * ``src/sdv/doc/waterloo/docitem_convert.py``
+  * ``src/sdv/doc/waterloo/docitem_sphinx.py``
+
+* Change logs:
+  * ``src/sdv/doc/waterloo/docitem.py`` following the definition of ``__version__``
+  * ``src/sdv/doc/waterloo/waterlint.py`` following the definition of ``__version__``

sdv_doc_waterloo-0.10.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=67", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sdv_doc_waterloo"
+description = "Waterloo - Docstring Format and Tools"
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [{ name = "Uwe" }]
+license = { text = "BSD-2-Clause" }
+classifiers = [
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.10",
+	"Operating System :: OS Independent",
+	]
+dynamic = ["version"]
+
+# Runtime dependencies required by waterlint.
+# The Sphinx extension depends on Sphinx, but Sphinx is intentionally
+# not declared here: it is a large, optional dependency that should
+# be installed explicitly by users who need the extension.
+dependencies = [
+	"jsonschema",
+	"jsonpointer",
+	"pygments",
+	"python-waterloo-lexer",
+	"docutils",
+	"mcp",
+	"tomli; python_version < '3.11'"
+	]
+
+# Optional dependencies.
+# The "sphinx" extra installs the dependencies required for the
+# Sphinx extension. It is not installed by default.
+#
+# Install with:
+#   pip install sdv_doc_waterloo[sphinx]
+#
+# This keeps the base installation lightweight while allowing
+# users to explicitly enable Sphinx support when needed.
+[project.optional-dependencies]
+sphinx = ["sphinx"]
+dev = ["pytest"]
+
+# Console script entry points.
+# Installs a command-line executable that invokes the given
+# function inside the package.
+# Syntax: "<command> = package.module:function"
+[project.scripts]
+waterlint = "sdv.doc.waterloo.waterlint:main"
+# MCP server entry point for Waterloo data roots and tool access.
+wtrl_mcp = "sdv.doc.waterloo.mcp.wtrl_server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["sdv*"]
+# Use PEP 420 namespace packages. This ensures that the "sdv"
+# namespace can be shared across multiple independently installed
+# projects without package conflicts.
+namespaces = true
+
+[tool.setuptools.dynamic]
+version = { attr = "sdv.doc.waterloo.docitem.__version__" }
+
+# After installation with pip, these go to site-packages/sdv/doc/waterloo/.
+# Include the PEP 561 marker file. The presence of py.typed tells type
+# checkers (e.g. mypy) that this package provides inline type hints.
+[tool.setuptools.package-data]
+"sdv.doc.waterloo" = [
+	"py.typed",
+	"_static/*.css",
+	"doc-json/*.json",
+	"schema/*.json",
+	"js/*.js",
+	"css/*.css",
+	"etc/*.toml",
+	"mcp/doc-json/*.json",
+	"mcp/tool_about/*.json",
+	"mcp/prompts/*.json"
+	]

sdv_doc_waterloo-0.10.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+