31 lines
1.2 KiB
Plaintext
31 lines
1.2 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
Name: co3
|
||
|
Version: 0.1.1
|
||
|
Summary: Lightweight ORM
|
||
|
Author-email: Sam Griesemer <samgriesemer@gmail.com>
|
||
|
Classifier: Programming Language :: Python :: 3
|
||
|
Classifier: License :: OSI Approved :: MIT License
|
||
|
Classifier: Operating System :: OS Independent
|
||
|
Requires-Python: >=3.11
|
||
|
Description-Content-Type: text/markdown
|
||
|
Requires-Dist: tqdm
|
||
|
|
||
|
# Overview
|
||
|
`co4` is a package for file conversion and associated database operations. The `CO4` 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
|
||
|
|
||
|
**CO4** is an abstract base class that makes it easy to integrate this model with object
|
||
|
hierarchies that mirror a storage schema.
|