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.106.tar.gz (38.3 kB view details)

Uploaded Source

Built Distribution

msadocmodels-0.0.106-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: msadocmodels-0.0.106.tar.gz
  • Upload date:
  • Size: 38.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1012-azure

File hashes

Hashes for msadocmodels-0.0.106.tar.gz
Algorithm Hash digest
SHA256 a60e370dab85a5f323a69a8d5228f8cc7e418f17a1302532d319d5ddf3f8f3f0
MD5 1fb0ac6c504cd23319adbc4fc311f58a
BLAKE2b-256 b66c49fa59f096a7ca60949db8dd06d18ef33fd5f5ef60ecadfb74aa81327168

See more details on using hashes here.

File details

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

File metadata

  • Download URL: msadocmodels-0.0.106-py3-none-any.whl
  • Upload date:
  • Size: 39.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1012-azure

File hashes

Hashes for msadocmodels-0.0.106-py3-none-any.whl
Algorithm Hash digest
SHA256 278a40aa138f41a4c582a40af879e97cdbb9e7942701f143a50b2b3a19651c58
MD5 be549a107b0c1caf8d29db322b21452c
BLAKE2b-256 9ccf3af7649fafed02ef3f63774336fa082f045f350ad30e234f0d7f3c47880d

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