Skip to main content

A brief description of dapytains

Project description

MyDapytains

Flask Server Tests Test

The name of the library is completely temporary.

This library offers a base python implementation of the following functionalities:

  • Parsing of machine-actionable citeStructure and citeData to retrieve reference, structure and citable unit metadata within a TEI file
  • Reuse of citeStructure architecture to retrieve and build partial documents, based on provided reference.
  • Support for multiple citeStructure, similar to the ?tree parameter of the DTS Specifications.

This library will:

  • Provide a base implementation of the DTS API, using python as a server-side language
  • Provide some light "caching" features, to avoid reparsing document at query time.

ToDo

  • Support XSL transformation with mediaType dictionary for outputting different data
  • Add tests to webapp

WebApp

You can try the webapp using python -m dapytains.app.app. It uses test files at the moment.

Guidelines

Document level guidelines

  1. For TEI document to be accessible in full, no specific requirements are necessary.
  2. For TEI document to have a single citation tree, they must provide at least one element at the XPath /TEI/teiHeader/encodingDesc/refsDecl[@default='true']/citeStructure.
  3. For TEI document to have multiple citation trees, they must provide at least one element at the XPath /TEI/teiHeader/encodingDesc/refsDecl[@default='true']/citeStructure and any number of element matching the XPath /TEI/teiHeader/encodingDesc/refsDecl[@n]/citeStructure, where @n holds the citation tree name.

We are currently figuring out the Resource level metadata.

See one of our test files to check out the minimal requirements: we have one with citeData and one with multiple trees

Collection and Resource level guidelines

Collection and Resource level guidelines can be provided through file named dts-metadata.xml in each subfolder of a given repository. We are currently looking at using external file that would help you ingest metadata, while leaving you the option to load up metadata yourself.

The current schema for the collection catalog ingestion is available in ./tests/catalog/schema.rng.

Support

Funded via the CLLG Project.

Ce travail a bénéficié d’une aide de l’État gérée par l’Agence Nationale de la Recherche au titre de France 2030 portant la référence « ANR-24-RRII- 0002 » et opéré par le Programme Inria Quadrant.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dapytains-1.0.0rc1.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dapytains-1.0.0rc1-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file dapytains-1.0.0rc1.tar.gz.

File metadata

  • Download URL: dapytains-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 38.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dapytains-1.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 1573ca98fcaad92922e0efc466d8105d9b2b65746c6bf19b1d0fff6d2daa91ce
MD5 79b03b74869cc05c5fc3dcecf603ccc7
BLAKE2b-256 db349da003c878d1b9629cd8d2bc0534ba106a6b6c58c69a9b16b756f62de149

See more details on using hashes here.

Provenance

The following attestation bundles were made for dapytains-1.0.0rc1.tar.gz:

Publisher: release.yml on distributed-text-services/MyDapytains

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dapytains-1.0.0rc1-py3-none-any.whl.

File metadata

  • Download URL: dapytains-1.0.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dapytains-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 338b047986e7ebf0af5ed203322017b5894b49c3490d57de7cb66b0a8470c19e
MD5 7c5a127f14c55cdb632b8f707608b37a
BLAKE2b-256 85b3f49f4fe9e79ab6be5828c5642b38e44544fe788b100b54d435db8777b67f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dapytains-1.0.0rc1-py3-none-any.whl:

Publisher: release.yml on distributed-text-services/MyDapytains

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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