Convenience wrapper for exonware-xwformats - provides 'import xwformats' alias
Project description
xwformats
Advanced serialization formats in one package. Schema (Protobuf, Avro, Parquet, …), scientific (HDF5, Feather, Zarr, …), database (LMDB, LevelDB, …), binary and text. Same API as xwsystem; auto-registers with codec registry on import. Lite / lazy / full install.
Company: eXonware.com · Author: eXonware Backend Team · Email: connect@exonware.com
Version: See version.py or PyPI. · Updated: See version.py (__date__)
Install
| Install | What you get | When to use |
|---|---|---|
pip install exonware-xwformats |
Lite — core + xwsystem only | Minimal footprint; you add formats as needed. |
pip install exonware-xwformats[lazy] |
Lazy — missing format deps install on first use | Development; optional formats without pre-installing everything. |
pip install exonware-xwformats[full] |
Full — common format deps pre-installed | Production or CI when you want all formats up front. |
Requires exonware-xwsystem. Same package; [lazy] and [full] are extras.
Quick start
from exonware.xwformats import XWFormats
xf = XWFormats()
print(xf.list_formats()) # All registered formats
data = xf.convert(json_bytes, "json", "yaml") # Bidirectional conversion
ser = xf.get_serializer("parquet")
ser.encode(value)
ser.decode(data)
Importing xwformats registers its formats with xwsystem; use xwsystem's codec/facade for auto-detection by file extension. See REF_14_DX and REF_15_API.
What you get
| Area | What's in it |
|---|---|
| Schema | Protobuf, Avro, Parquet, Thrift, ORC, Cap'n Proto, FlatBuffers, Arrow. |
| Scientific | HDF5, Feather, Zarr, NetCDF, MAT. |
| Database | LMDB, LevelDB, RocksDB, GraphDB. |
| Binary / text | BSON, UBJSON; CSV, YAML, TOML, XML, RON. |
| Integration | Same converter/facade as xwsystem; auto-registration with codec registry on import. |
Lite = minimal deps. Lazy = optional format deps install on first use. Full = common optionals pre-installed. Platform notes (e.g. RocksDB on Windows) in docs/logs/setup/. Known issues: docs/_archive/KNOWN_ISSUES.md and REF_22_PROJECT.md.
Docs and tests
Content in this README is aligned with the project REFs and docs/GUIDE_01_USAGE.md (per GUIDE_63_README).
- Start: docs/INDEX.md — doc index and quick links.
- Use it: docs/GUIDE_01_USAGE.md — usage, key code, formats.
- Requirements and status: docs/REF_01_REQ.md, docs/REF_22_PROJECT.md.
- API and design: docs/REF_15_API.md, docs/REF_13_ARCH.md, docs/REF_14_DX.md.
- Tests: See docs/REF_51_TEST.md. Run via
python tests/runner.pyor pytest from project root.
License and links
MIT — see LICENSE.
- Homepage: https://exonware.com
- Repository: https://github.com/exonware/xwformats
- Version:
from exonware.xwformats import __version__orimport exonware.xwformats; print(exonware.xwformats.__version__)
Contributing → CONTRIBUTING.md · Security → SECURITY.md (when present).
Built with ❤️ by eXonware.com - Revolutionizing Python Development Since 2025
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xwformats-0.9.0.21.tar.gz.
File metadata
- Download URL: xwformats-0.9.0.21.tar.gz
- Upload date:
- Size: 58.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b944cba975736433712a43f3eb5b71036d26ee81fa5a7118e53fb97461accfb
|
|
| MD5 |
7a00bfdfcf6d78a01c9c3525684e701f
|
|
| BLAKE2b-256 |
f132ad1253beb0886142b45e2846588ce996e56135647234623ec778b95c4bc1
|
File details
Details for the file xwformats-0.9.0.21-py3-none-any.whl.
File metadata
- Download URL: xwformats-0.9.0.21-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
269e3c2c4169178f1edbfeda37a876f9158e3f0fad41945a17bd6782fd797a4e
|
|
| MD5 |
34e3f94c7362f97b62779ba3974f64bf
|
|
| BLAKE2b-256 |
fa11c331085f7cc40736388da80e978a806ec410450d602dbd40e3faa832f779
|