Skip to main content

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

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.9 | Updated: 11-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

xwentity-0.6.0.9.tar.gz (86.4 kB view details)

Uploaded Source

Built Distribution

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

xwentity-0.6.0.9-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file xwentity-0.6.0.9.tar.gz.

File metadata

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

File hashes

Hashes for xwentity-0.6.0.9.tar.gz
Algorithm Hash digest
SHA256 33e69581a8ca5d2b74fc516fd6d6366e89d1c9a584f0dbb46f8e48ff9bed3710
MD5 8f5c451c4ef0dd203d9fc87bca98e3ce
BLAKE2b-256 f0d5a5e46a220d441eceb7d50e24b91f1f091b26caf34882c409a78823561314

See more details on using hashes here.

File details

Details for the file xwentity-0.6.0.9-py3-none-any.whl.

File metadata

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

File hashes

Hashes for xwentity-0.6.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 673bfa3c7d44681544e38855b03575f42f87f88289fa5b0c2c0585dd02669549
MD5 446ce834abe71aee476492830cb2a55b
BLAKE2b-256 3591bee5f9bcd43f3ba7520bdeacbe83d35a21a5f470537b9b3400e889212a96

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