msaDocModels - MSA Document Pydantic Models and Schemas, used to store Parser, NLP, NLU and AI results for processed documents
Project description
msaDocModels - MSA Document Pydantic Models and Schemas, used to store Parser, NLP, NLU and AI results for processed documents
Optimized for use with FastAPI/Pydantic.
Documentation: msaDocModels Documentation (https://msaDocModels.u2d.ai/)
Features
- Schema/Models for Document Understanding Result Data: sdu.
- Schema/Models for General Document Handling Data: wdc.
- Schema/Models for Workflow Definition and Processing Data: wfl.
- API Message class: msg, allows generic API JSON message creation with capabilities to re-create original datatypes and class instances.
Main Dependencies
- msaUtils >= 0.0.2
- Pydantic
License Agreement
msaDocModels
is based onMIT
open source and free to use, it is free for commercial use, but please show/list the copyright information about msaDocModels somewhere.
How to create the documentation
We use mkdocs and mkdocsstring. The code reference and nav entry get's created virtually by the triggered python script /docs/gen_ref_pages.py while mkdocs
serve
or build
is executed.
Requirements Install for the PDF creation option:
PDF Export is using mainly weasyprint, if you get some errors here pls. check there documentation. Installation is part of the msaDocModels, so this should be fine.
We can now test and view our documentation using:
mkdocs serve
Build static Site:
mkdocs build
Build and Publish
Build:
python setup.py sdist
Publish to pypi:
twine upload dist/*
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
File details
Details for the file msaDocModels-0.0.8.tar.gz
.
File metadata
- Download URL: msaDocModels-0.0.8.tar.gz
- Upload date:
- Size: 14.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd5eef20a6be95ef6ebc5073a4076df2f96de7d248987a56ffb1cd7b25f6f381 |
|
MD5 | ef29b06e23ac054a6a648ff2c51bbad7 |
|
BLAKE2b-256 | 560f69d99cbcb8c722bddeac6aebb0479fa8c7243682c1f6daddd489000439dc |