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

Uploaded Source

Built Distribution

msadocmodels-0.0.107-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: msadocmodels-0.0.107.tar.gz
  • Upload date:
  • Size: 38.2 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.107.tar.gz
Algorithm Hash digest
SHA256 addb4b7909a1456959444d57e650cfa060b93d6979a591a8d4de19a6be035c06
MD5 8ceea3053bd8e5aa73b25b7f16c104c5
BLAKE2b-256 08d436e284931597dff466aeb7644eca0d32ce54f4c980226c3e8c85f6994d0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: msadocmodels-0.0.107-py3-none-any.whl
  • Upload date:
  • Size: 39.7 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.107-py3-none-any.whl
Algorithm Hash digest
SHA256 b682f66ef7e96cbd50f40330542c64dff4a81b0c6d4140525e0040a18ce6773e
MD5 f0a59b060aefe0e89709cd88a3ecbea8
BLAKE2b-256 e357e91c70174a77a0c1cca1ae2b073d4ce4749d0b0f080133e918add9b7a0b0

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