Skip to main content

msaDocModels - MSA Document Pydantic Models and Schemas, used to store Parser, NLP, NLU and AI results for processed documents

Project description

msaDocModels Logo


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.
Package version Supported Python versions


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.
  • Schema/Models for Work With Text: spk.
  • 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 on MIT 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/*

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

msaDocModels-0.0.78.tar.gz (33.4 kB view details)

Uploaded Source

File details

Details for the file msaDocModels-0.0.78.tar.gz.

File metadata

  • Download URL: msaDocModels-0.0.78.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for msaDocModels-0.0.78.tar.gz
Algorithm Hash digest
SHA256 20420fdebc30bcc6201b160c7a3791a0782fb03bb38dacdc91a468aa8d232088
MD5 fbe088810e864e3a1f05ea2c35dc3cc4
BLAKE2b-256 67500dde4199c9844922b6151afcc5a035588257f3a19ef342a0b80a488ed75e

See more details on using hashes here.

Supported by

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