Changeset - bb2d1cca6066
[Not reviewed]
0 2 0
Lance Edgar (lance) - 3 years ago 2021-07-21 18:27:47
lance@edbob.org
Replace "importing" docs overview w/ link to rattail-manual
2 files changed with 8 insertions and 17 deletions:
0 comments (0 inline, 0 general)
docs/conf.py
Show inline comments
 
@@ -47,8 +47,9 @@ extensions = [
 

	
 
intersphinx_mapping = {
 
    'python': ('https://docs.python.org/2.7/', None),
 
    u'sqlalchemy': (u'http://docs.sqlalchemy.org/en/latest/', None),
 
    'pytz': ('http://pytz.sourceforge.net/', None),
 
    'rattail-manual': ('https://rattailproject.org/docs/rattail-manual/', None),
 
    'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None),
 
    }
 

	
 
# Add any paths that contain templates here, relative to this directory.
docs/narr/importers.rst
Show inline comments
 
@@ -4,22 +4,12 @@
 
Data Importers
 
==============
 

	
 
A frequent need when integrating systems is to import (or export, depending on
 
your perspective) data from one system to another.  Rattail provides a
 
framework for this, which offers the following benefits:
 

	
 
 * "dry run" mode to check things out before committing changes
 
 * "warnings" mode which sends email with data diffs, e.g. when you expect no changes
 
 * adjustable "batch size" for grouping changes when submitting to local system
 
 * full command line support for above, plus "max" changes to apply, show progress, etc.
 
 * core code is optimized to run quickly, e.g. by fetching all data up-front
 
 * new importers may be created simply / cleanly / according to existing patterns
 
 * new importers may extend / replace core functionality as needed
 

	
 
The rest of this document aims to explain the concepts and patterns involved
 
with the Rattail importer framework.
 

	
 
See also the API docs for :mod:`rattail.importing` (and sub-modules).
 
Please see :doc:`rattail-manual:data/importing/index` for more
 
complete information about this framework.
 

	
 
.. note::
 
   The remainder of this doc is left in place for now, but content
 
   will eventually be moved to the :doc:`rattail-manual:index`.
 

	
 

	
 
"Importer" vs. "DataSync"
0 comments (0 inline, 0 general)