feat: initial release

just the basics in place for an ad-hoc CSV -> Wutta import.  framework
API only at this point, no CLI yet

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     = .
+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/api/wuttasync.importing.base.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing.base``
+============================
+
+.. automodule:: wuttasync.importing.base
+   :members:

docs/api/wuttasync.importing.csv.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing.csv``
+===========================
+
+.. automodule:: wuttasync.importing.csv
+   :members:

docs/api/wuttasync.importing.handlers.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing.handlers``
+================================
+
+.. automodule:: wuttasync.importing.handlers
+   :members:

docs/api/wuttasync.importing.model.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing.model``
+=============================
+
+.. automodule:: wuttasync.importing.model
+   :members:

docs/api/wuttasync.importing.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing``
+=======================
+
+.. automodule:: wuttasync.importing
+   :members:

docs/api/wuttasync.importing.wutta.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.importing.wutta``
+=============================
+
+.. automodule:: wuttasync.importing.wutta
+   :members:

docs/api/wuttasync.rst

@@ -0,0 +1,6 @@
+
+``wuttasync``
+=============
+
+.. automodule:: wuttasync
+   :members:

docs/api/wuttasync.util.rst

@@ -0,0 +1,6 @@
+
+``wuttasync.util``
+==================
+
+.. automodule:: wuttasync.util
+   :members:

docs/conf.py

@@ -0,0 +1,40 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+from importlib.metadata import version as get_version
+
+project = 'WuttaSync'
+copyright = '2024, Lance Edgar'
+author = 'Lance Edgar'
+release = get_version('WuttaSync')
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.todo',
+    'enum_tools.autoenum',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None),
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,29 @@
+
+WuttaSync
+=========
+
+This package adds data import/export and real-time sync utilities for
+the `Wutta Framework <https://wuttaproject.org>`_.
+
+While it of course supports import/export to/from the Wutta :term:`app
+database`, it may be used for any "source → target" data flow.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Documentation
+
+   narr/install
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API
+
+   api/wuttasync
+   api/wuttasync.importing
+   api/wuttasync.importing.base
+   api/wuttasync.importing.csv
+   api/wuttasync.importing.handlers
+   api/wuttasync.importing.model
+   api/wuttasync.importing.wutta
+   api/wuttasync.util

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=.
+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/narr/install.rst

@@ -0,0 +1,12 @@
+
+Installation
+============
+
+This assumes you already have a :doc:`WuttJamaican app+database
+<wuttjamaican:narr/install/index>` setup and working.
+
+Install the WuttaSync package to your virtual environment:
+
+.. code-block:: sh
+
+   pip install WuttaSync