Skip to main content

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/*

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

msadocmodels-0.0.114.tar.gz (39.7 kB view details)

Uploaded Source

Built Distribution

msadocmodels-0.0.114-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

Details for the file msadocmodels-0.0.114.tar.gz.

File metadata

  • Download URL: msadocmodels-0.0.114.tar.gz
  • Upload date:
  • Size: 39.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.9.18 Linux/6.2.0-1015-azure

File hashes

Hashes for msadocmodels-0.0.114.tar.gz
Algorithm Hash digest
SHA256 636a1f4bae6c3803217652910850b401d6776ef5534bfebe43e31f95128206bc
MD5 37972b0efba2efb2efedfe0fed9b3ae9
BLAKE2b-256 1baed6817e75dd5a658a163337d8899198758420f58ab1f68c22d0aaff4ef289

See more details on using hashes here.

File details

Details for the file msadocmodels-0.0.114-py3-none-any.whl.

File metadata

  • Download URL: msadocmodels-0.0.114-py3-none-any.whl
  • Upload date:
  • Size: 41.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.9.18 Linux/6.2.0-1015-azure

File hashes

Hashes for msadocmodels-0.0.114-py3-none-any.whl
Algorithm Hash digest
SHA256 84c0d894d319c3a16c6121ad1704ba1a14a0fa9daa7cec91a065016103f66ccf
MD5 c2465b9721cab731ff51e7efa15aa00c
BLAKE2b-256 7068e0a71f7c9c6ae0feaab85fb66f2c1709b7860931a24a5fd68a89abe36ae2

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