diff --git a/.gitignore b/.gitignore index 217458c..d46023a 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,6 @@ localsys.egg-info/ # vendor and build files dist/ build/ -docs/sphinx/_build/ +docs/_autoref/ +docs/_autosummary/ +docs/_build/ diff --git a/Makefile b/Makefile index 72d0667..274e59c 100644 --- a/Makefile +++ b/Makefile @@ -4,7 +4,7 @@ BASH=/usr/bin/bash ## ------------------ docs ------------------ ## docs-build: - sphinx-apidoc --module-first -o docs/_autoref/ co4 + sphinx-apidoc --module-first --separate -o docs/_autoref/ co3 make -C docs/ html docs-serve: @@ -12,6 +12,7 @@ docs-serve: docs-clean: make -C docs/ clean + rm -rf docs/_autoref ## ------------------------------------------ ## ## ----------------- tests ------------------ ## diff --git a/co3/accessor.py b/co3/accessor.py index cf08ab2..d3af9cb 100644 --- a/co3/accessor.py +++ b/co3/accessor.py @@ -1,5 +1,5 @@ ''' -Accessor +**Accessor** Provides access to an underlying schema through a supported set of operations. Class methods could be general, high-level SQL wrappers, or convenience functions for common diff --git a/docs/_autoref/co4.accessors.rst b/docs/_autoref/co4.accessors.rst deleted file mode 100644 index f1233e2..0000000 --- a/docs/_autoref/co4.accessors.rst +++ /dev/null @@ -1,34 +0,0 @@ -co4.accessors package -===================== - -.. automodule:: co4.accessors - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -co4.accessors.fts module ------------------------- - -.. automodule:: co4.accessors.fts - :members: - :undoc-members: - :show-inheritance: - -co4.accessors.table module --------------------------- - -.. automodule:: co4.accessors.table - :members: - :undoc-members: - :show-inheritance: - -co4.accessors.vss module ------------------------- - -.. automodule:: co4.accessors.vss - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/co4.collectors.rst b/docs/_autoref/co4.collectors.rst deleted file mode 100644 index 72d7ce2..0000000 --- a/docs/_autoref/co4.collectors.rst +++ /dev/null @@ -1,18 +0,0 @@ -co4.collectors package -====================== - -.. automodule:: co4.collectors - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -co4.collectors.core module --------------------------- - -.. automodule:: co4.collectors.core - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/co4.composers.rst b/docs/_autoref/co4.composers.rst deleted file mode 100644 index 5eb604b..0000000 --- a/docs/_autoref/co4.composers.rst +++ /dev/null @@ -1,26 +0,0 @@ -co4.composers package -===================== - -.. automodule:: co4.composers - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -co4.composers.core module -------------------------- - -.. automodule:: co4.composers.core - :members: - :undoc-members: - :show-inheritance: - -co4.composers.fts module ------------------------- - -.. automodule:: co4.composers.fts - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/co4.databases.rst b/docs/_autoref/co4.databases.rst deleted file mode 100644 index d542e91..0000000 --- a/docs/_autoref/co4.databases.rst +++ /dev/null @@ -1,34 +0,0 @@ -co4.databases package -===================== - -.. automodule:: co4.databases - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -co4.databases.core module -------------------------- - -.. automodule:: co4.databases.core - :members: - :undoc-members: - :show-inheritance: - -co4.databases.fts module ------------------------- - -.. automodule:: co4.databases.fts - :members: - :undoc-members: - :show-inheritance: - -co4.databases.vss module ------------------------- - -.. automodule:: co4.databases.vss - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/co4.managers.rst b/docs/_autoref/co4.managers.rst deleted file mode 100644 index cea3f3d..0000000 --- a/docs/_autoref/co4.managers.rst +++ /dev/null @@ -1,34 +0,0 @@ -co4.managers package -==================== - -.. automodule:: co4.managers - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -co4.managers.core module ------------------------- - -.. automodule:: co4.managers.core - :members: - :undoc-members: - :show-inheritance: - -co4.managers.fts module ------------------------ - -.. automodule:: co4.managers.fts - :members: - :undoc-members: - :show-inheritance: - -co4.managers.vss module ------------------------ - -.. automodule:: co4.managers.vss - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/co4.rst b/docs/_autoref/co4.rst deleted file mode 100644 index 7d5ccfc..0000000 --- a/docs/_autoref/co4.rst +++ /dev/null @@ -1,70 +0,0 @@ -co4 package -=========== - -.. automodule:: co4 - :members: - :undoc-members: - :show-inheritance: - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - co4.accessors - co4.collectors - co4.composers - co4.databases - co4.managers - -Submodules ----------- - -co4.accessor module -------------------- - -.. automodule:: co4.accessor - :members: - :undoc-members: - :show-inheritance: - -co4.co4 module --------------- - -.. automodule:: co4.co4 - :members: - :undoc-members: - :show-inheritance: - -co4.collector module --------------------- - -.. automodule:: co4.collector - :members: - :undoc-members: - :show-inheritance: - -co4.composer module -------------------- - -.. automodule:: co4.composer - :members: - :undoc-members: - :show-inheritance: - -co4.indexer module ------------------- - -.. automodule:: co4.indexer - :members: - :undoc-members: - :show-inheritance: - -co4.manager module ------------------- - -.. automodule:: co4.manager - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/_autoref/modules.rst b/docs/_autoref/modules.rst index a72e900..6f73bf6 100644 --- a/docs/_autoref/modules.rst +++ b/docs/_autoref/modules.rst @@ -1,7 +1,7 @@ -co4 +co3 === .. toctree:: :maxdepth: 4 - co4 + co3 diff --git a/docs/_build/doctrees/_autoref/co4.accessors.doctree b/docs/_build/doctrees/_autoref/co4.accessors.doctree deleted file mode 100644 index 5c190c7..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.accessors.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/co4.collectors.doctree b/docs/_build/doctrees/_autoref/co4.collectors.doctree deleted file mode 100644 index c5f6566..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.collectors.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/co4.composers.doctree b/docs/_build/doctrees/_autoref/co4.composers.doctree deleted file mode 100644 index 7541752..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.composers.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/co4.databases.doctree b/docs/_build/doctrees/_autoref/co4.databases.doctree deleted file mode 100644 index b4eb95a..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.databases.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/co4.doctree b/docs/_build/doctrees/_autoref/co4.doctree deleted file mode 100644 index e21a9d8..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/co4.managers.doctree b/docs/_build/doctrees/_autoref/co4.managers.doctree deleted file mode 100644 index 9a26e45..0000000 Binary files a/docs/_build/doctrees/_autoref/co4.managers.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autoref/modules.doctree b/docs/_build/doctrees/_autoref/modules.doctree index 67cd714..cbd9793 100644 Binary files a/docs/_build/doctrees/_autoref/modules.doctree and b/docs/_build/doctrees/_autoref/modules.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 7ffbe48..12d5b66 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index a4d5130..7790f2d 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/doctrees/reference/documentation/index.doctree b/docs/_build/doctrees/reference/documentation/index.doctree index 2128358..555f896 100644 Binary files a/docs/_build/doctrees/reference/documentation/index.doctree and b/docs/_build/doctrees/reference/documentation/index.doctree differ diff --git a/docs/_build/doctrees/reference/documentation/sphinx.doctree b/docs/_build/doctrees/reference/documentation/sphinx.doctree index 12ff60f..4997364 100644 Binary files a/docs/_build/doctrees/reference/documentation/sphinx.doctree and b/docs/_build/doctrees/reference/documentation/sphinx.doctree differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index ffe6c62..6724cba 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 84df2ad39c764f4e875b6546ac3281a5 +config: 42689903516d5840d143a46f4ba615c6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_autoref/co4.accessors.html b/docs/_build/html/_autoref/co4.accessors.html deleted file mode 100644 index 1196348..0000000 --- a/docs/_build/html/_autoref/co4.accessors.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - co4.accessors package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4.accessors package#

-
-

Submodules#

-
-
-

co4.accessors.fts module#

-
-
-

co4.accessors.table module#

-
-
-

co4.accessors.vss module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.collectors.html b/docs/_build/html/_autoref/co4.collectors.html deleted file mode 100644 index 1867725..0000000 --- a/docs/_build/html/_autoref/co4.collectors.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - co4.collectors package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4.collectors package#

-
-

Submodules#

-
-
-

co4.collectors.core module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.composers.html b/docs/_build/html/_autoref/co4.composers.html deleted file mode 100644 index 35d3349..0000000 --- a/docs/_build/html/_autoref/co4.composers.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - co4.composers package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4.composers package#

-
-

Submodules#

-
-
-

co4.composers.core module#

-
-
-

co4.composers.fts module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.databases.html b/docs/_build/html/_autoref/co4.databases.html deleted file mode 100644 index 97f3f95..0000000 --- a/docs/_build/html/_autoref/co4.databases.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - co4.databases package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4.databases package#

-
-

Submodules#

-
-
-

co4.databases.core module#

-
-
-

co4.databases.fts module#

-
-
-

co4.databases.vss module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.html b/docs/_build/html/_autoref/co4.html deleted file mode 100644 index cbf2136..0000000 --- a/docs/_build/html/_autoref/co4.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - - - - co4 package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4 package#

-
-

Subpackages#

-
- -
-
-
-

Submodules#

-
-
-

co4.accessor module#

-
-
-

co4.co4 module#

-
-
-

co4.collector module#

-
-
-

co4.composer module#

-
-
-

co4.indexer module#

-
-
-

co4.manager module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.managers.html b/docs/_build/html/_autoref/co4.managers.html deleted file mode 100644 index 7482d65..0000000 --- a/docs/_build/html/_autoref/co4.managers.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - co4.managers package - co4 documentation - - - - - - - - - - - - - - - - Contents - - - - - - Menu - - - - - - - - Expand - - - - - - Light mode - - - - - - - - - - - - - - Dark mode - - - - - - - Auto light/dark mode - - - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
co4 documentation
 -
-
-
- -
- -
-
- -
-
-
- - - - - Back to top - -
- -
- -
- -
-
-
-

co4.managers package#

-
-

Submodules#

-
-
-

co4.managers.core module#

-
-
-

co4.managers.fts module#

-
-
-

co4.managers.vss module#

-
-
- -
-
- -
- -
-
- - - - - \ No newline at end of file diff --git a/docs/_build/html/_autoref/modules.html b/docs/_build/html/_autoref/modules.html index c7d96e9..688ebd8 100644 --- a/docs/_build/html/_autoref/modules.html +++ b/docs/_build/html/_autoref/modules.html @@ -5,8 +5,8 @@ - - co4 - co4 documentation + + co3 - co3 documentation @@ -123,7 +123,7 @@
-
co4 documentation
 +
co3 documentation
@@ -146,7 +146,7 @@
- co4 documentation + co3 documentation
-
co4 documentation
 +
co3 documentation
@@ -146,7 +146,7 @@
- co4 documentation + co3 documentation @@ -156,18 +156,52 @@

Autoref

-
-

co4 package docs#

+
+

co3 package docs

Index Module Index Search Page

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

co3.Accessor

Access wrapper class for complex queries and easy integration with Composer tables.

co3.Collector

co3.CO3

CO3: COllate, COllect, COmpose - conversion & DB insertion base

co3.Database

Generic Database definition

co3.Indexer

Indexer class

co3.Manager

Management wrapper class for table groupings.

co3.Mapper

Mapper base class for housing schema components and managing relationships between CO3 types and storage components (of type C).

co3.Component

co3.Schema

co3.Engine

Engine base class.

+

Autoref

+
+

Overview

+

co3 is a package for file conversion and associated database operations. The CO3 base class +provides a standard interface for performing conversions, preparing inserts, and +interacting with database schemas that mirror the class hierarchy.

+

Simplified description of the operational model:

+

Goal: interact with a storage medium (database, pickled structure, VSS framework) with +a known schema.

+
    +

  • Accessor to provide access to stored items

    • +

  • Composer to compose common access points (e.g., JOINed tables)

    • +

  • Indexer to index/cache access queries

    • +

  • Manager to manage storage state (e.g., supported inserts, database syncs)

    • +

  • Collector to collect data for updating storage state

    • +

  • Database to collect data for updating storage state

    • +

  • Mapper to collect data for updating storage state

    • +

  • Component to collect data for updating storage state

    • +
+

CO3 is an abstract base class that makes it easy to integrate this model with object +hierarchies that mirror a storage schema.

+
+
+

Detailed structural breakdown

+

There are a few pillars of the CO3 model that meaningfully group up functionality:

+
    +

  • Database: generic to a Component type, provides basic connection to a database at a +specific address/location. The explicit Component type makes it easy to hook into +appropriately typed functional objects:

    +
      +

    • Manager: generic to a Component and Database type, provides a supported set of +state-modifying operations to a constituent database

      • +

    • Accessor: generic to a Component and Database type, provides a supported set of +state inspection operations on a constituent database

      • +

    • Indexer:

      • +
    +
    • +

  • Mapper: generic to a Component, serves as the fundamental connective component between +types in the data representation hierarchy (CO3 subclasses) and database Components.

    • +
@@ -246,12 +366,12 @@