Skip to main content

Unified entity model with schema, actions, data, metadata, caching, and performance features

Project description

xwentity

Unified entity layer. Ties schema (xwschema), actions (xwaction), and data (xwdata) together with metadata, caching, state, and XWNode. Used by xwmodels, xwbase, and the rest of the eXonware stack. Details live in docs/.

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

Status Python License


📦 Install

pip install exonware-xwentity
pip install exonware-xwentity[lazy]
# Full stack used by xwentity flows
pip install exonware-xwentity[full]

[full] pulls the full variants of: xwsystem, xwaction, xwdata, xwquery, xwschema, and xwnode.


🚀 Quick start

from exonware.xwentity import XWEntity
from exonware.xwschema import XWSchema

schema = XWSchema({"type": "object", "properties": {"name": {"type": "string"}, "age": {"type": "integer"}}})
entity = XWEntity(schema=schema, data={"name": "Alice", "age": 30})
print(entity.data["name"])

See docs/ for metadata, state, and REF_* files.


✨ What you get

Area What's in it
Entity One class for schema, actions, data, metadata, caching.
Integration xwschema, xwaction, xwdata, XWNode.
Lifecycle State and property discovery.

🧱 Core model (explicit roles)

  • XWEntity (entity.py) composes XWSchema + XWAction + XWData: validation contract, entity-scoped behavior, and multi-format data payloads.
  • XWCollection (collection.py) is a logical, storage-agnostic collection of entities of the same type, with collection-level actions (search/bulk operations).
  • XWGroup (group.py) manages multiple collections and supports nested parent/child groups, forming a tree structure for organization.
  • Shared foundation: XWCollection and XWGroup directly extend XWObject (xwsystem), and XWEntity extends AEntity which extends XWObject, so all core entity types inherit the same lightweight identity/object base.

🌐 Ecosystem functional contributions

xwentity is the domain model backbone; other XW libs provide validation, behavior, data, and persistence layers around it. You can use xwentity standalone as a domain modeling layer with only the components you need. The broader XW stack is optional and is most relevant for enterprise and mission-critical systems that need fully integrated, self-hosted model infrastructure.

Supporting XW lib What it provides to xwentity Functional requirement it satisfies
XWSchema Schema definitions and validation contracts attached to entities. Strong model integrity and versionable validation rules.
XWAction Entity-scoped actions and workflow behavior. Behavioral domain methods with consistent execution hooks.
XWData Multi-format data payload support and transformation paths. Portable model serialization/input across formats.
XWNode Node/graph structural representation and traversal capabilities. Rich relationships and graph-aware entity operations.
XWSystem Base object model and shared runtime primitives. Uniform identity/runtime behavior across entities, collections, and groups.
XWStorage Persistence providers used by higher-level entity collections/groups. Durable entity lifecycle management across storage backends.

This combination is the differentiator: xwentity is not just a dataclass layer, it is a contract-validated domain core connected to action, data, and storage infrastructure.


📖 Docs and tests

  • Start: docs/INDEX.md or docs/.
  • Tests: From repo root, follow the layout in this package (pytest or project runner).

📜 License and links

Apache-2.0 - see LICENSE. Homepage: https://exonware.com · Repository: https://github.com/exonware/xwentity

⏱️ Async Support

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

Version: 0.6.0.7 | Updated: 08-Apr-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

exonware_xwentity-0.6.0.7.tar.gz (87.1 kB view details)

Uploaded Source

Built Distribution

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

exonware_xwentity-0.6.0.7-py3-none-any.whl (58.4 kB view details)

Uploaded Python 3

File details

Details for the file exonware_xwentity-0.6.0.7.tar.gz.

File metadata

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

File hashes

Hashes for exonware_xwentity-0.6.0.7.tar.gz
Algorithm Hash digest
SHA256 32a75c8c5f41d02a28855eda58358c8cd5b1c380b04e7a14c8591f28fbefb36c
MD5 00abadd0fa91db36e9d2273b808cb11b
BLAKE2b-256 a20d0870764bec25d526b887de2bc18eaad08fd6bddae27213ad91f13004aac9

See more details on using hashes here.

File details

Details for the file exonware_xwentity-0.6.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for exonware_xwentity-0.6.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c79bb8202fc6323feaa82cafdd9876ed83b2f590366698854754cfc8c12b767d
MD5 32724a6f56460fdff82c6b51c454c8bb
BLAKE2b-256 2a770564a6aaba8a91d627bbbf07253527b1c1c85afab7386b6dd5e469669be3

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