Skip to main content

Convenience wrapper for exonware-xwmodels - provides 'import xwmodels' alias

Project description

xwmodels

Entity collections and groups on top of xwentity, wired for the rest of the eXonware stack. Details live in per-project REF docs.

Company: eXonware.com · Author: eXonware Backend Team · Email: connect@exonware.com

Status Python License


Install

pip install exonware-xwmodels
pip install exonware-xwmodels[lazy]
pip install exonware-xwmodels[full]

Quick start

from exonware.xwmodels import *
# Or: import xwmodels
# Collections and groups of entities - see docs for patterns

See docs/ for REF_* files and examples.


What you get

Area Contents
Models Entity collections and groups built on xwentity.
Integration Hooks for xwentity, xwstorage, xwaction.
Tooling Utilities aimed at larger, consistent model graphs.

Core model roles

  • XWModelEntity (entity_compat.py) is the xwmodels compatibility facade over exonware.xwentity.XWEntity (data-first ergonomics + model-facing helpers).
  • XWModelCollection (collection.py) manages many entities of one type and adds persistence-aware collection behavior via storage contracts.
  • XWModelGroup (group.py) manages multiple collections, supports nested subgroups (tree hierarchy), and coordinates group-level save/load through providers.
  • Shared foundation: model collection and model group inherit XWObject from xwsystem for lightweight identity/object semantics; entity behavior is inherited from core xwentity.
  • Compatibility alias: XWEntity remains exported as an alias to XWModelEntity for backward compatibility.

Model management layer in practice

  • Base systems: use one XWModelGroup per bounded system (for example auth, catalog, billing, content) and keep each system's collections under that group.
  • Domain partitioning: map each aggregate/root model to one XWModelCollection (users, roles, invoices, products), with one schema contract and many entities.
  • Nested environments: create subgroups for dev / staging / prod, tenant spaces, or regional shards while preserving one management API.
  • Provider orchestration: plug storage/auth providers at group level so save/load and access control policies are consistent across all collections in that system.
  • App composition: xwbase-style systems can compose multiple groups to build complete application backbones while reusing the same entity/collection/group semantics.

Docs and tests

  • Start: docs/INDEX.md or docs/.
  • Tests: From repo root, e.g. python tests/runner.py, per project layout.

License and links

MIT - see LICENSE. Homepage: https://exonware.com · Repository: https://github.com/exonware/xwmodels

Async Support

  • xwmodels includes asynchronous execution paths in production code.
  • Source validation: 9 async def definitions and 2 await usages under src/.
  • Use async APIs for I/O-heavy or concurrent workloads to improve throughput and responsiveness.

Version: 0.6.0.6 | Updated: 31-Mar-2026

Built with ❤️ by eXonware.com - Revolutionizing Python Development Since 2025

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xwmodels-0.6.0.6.tar.gz (78.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xwmodels-0.6.0.6-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file xwmodels-0.6.0.6.tar.gz.

File metadata

  • Download URL: xwmodels-0.6.0.6.tar.gz
  • Upload date:
  • Size: 78.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for xwmodels-0.6.0.6.tar.gz
Algorithm Hash digest
SHA256 cb83579b4cd8ed97c79523f5d6a4c332425f39bb8d0092520dd1e7e829e7cf16
MD5 d0ba9d64dc204a6fa1532bf198ec8701
BLAKE2b-256 5607b22b030148c128574c7f76c40921b7b7f73cce20d4c32bfac39c23a7b0f9

See more details on using hashes here.

File details

Details for the file xwmodels-0.6.0.6-py3-none-any.whl.

File metadata

  • Download URL: xwmodels-0.6.0.6-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for xwmodels-0.6.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 600d9542a4e21b0a516d1e4fc00c1aed5ceee71b22270c8fe44af7681837ecab
MD5 8bd618fd1efc70c390f000899b390f81
BLAKE2b-256 26a1bf5fc43e3e591e02a1dc2e7a32417b73c30d1150d934e6c6052035c953b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page