wutta/wuttasync
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: add warnings mode for import/export handlers, commands

Browse source 
can now specify `--warn` for import/export CLI, to get diff email when
changes occur.

this also adds `get_import_handler()` and friends, via app provider.

also declare email settings for the 2 existing importers
This commit is contained in:
Lance Edgar 2025-12-20 15:32:15 -06:00
parent 1e7722de91
commit 19574ea4a0
18 changed files with 1150 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/wuttasync.app.rst Normal file
View file

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

6
docs/api/wuttasync.emails.rst Normal file
View file

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

6
docs/api/wuttasync.testing.rst Normal file
View file

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

20
docs/glossary.rst
View file

@ -6,6 +6,26 @@ Glossary
.. glossary::
:sorted:
import/export key
Unique key representing a particular type of import/export job,
i.e. the source/target and orientation (import vs. export).
For instance "Wutta → CSV export" uses the key:
``export.to_csv.from_wutta``
More than one :term:`import handler` can share a key, e.g. one
may subclass another and inherit the key.
However only one handler is "designated" for a given key; it will
be used by default for running those jobs.
This key is used for lookup in
:meth:`~wuttasync.app.WuttaSyncAppProvider.get_import_handler()`.
See also
:meth:`~wuttasync.importing.handlers.ImportHandler.get_key()`
method on the import/export handler.
import handler
This a type of :term:`handler` which is responsible for a
particular set of data import/export task(s).

5
docs/index.rst
View file

@ -67,13 +67,15 @@ cf. :doc:`rattail-manual:data/sync/index`.
.. toctree::
:maxdepth: 1
:caption: API
:caption: Package API
api/wuttasync
api/wuttasync.app
api/wuttasync.cli
api/wuttasync.cli.base
api/wuttasync.cli.import_csv
api/wuttasync.cli.import_versions
api/wuttasync.emails
api/wuttasync.importing
api/wuttasync.importing.base
api/wuttasync.importing.csv
@ -81,4 +83,5 @@ cf. :doc:`rattail-manual:data/sync/index`.
api/wuttasync.importing.model
api/wuttasync.importing.versions
api/wuttasync.importing.wutta
api/wuttasync.testing
api/wuttasync.util