Skip to main content

Create data-rich linguistic documents.

Project description

lingdocs

Create data-rich linguistic documents with CLDF, with a variety of output formats.

Versions PyPI License Tests Changelog

About

Linguistic documents usually contain linguistic data, be it from primary research or sourced from the literature. The primary function of lingdocs is to make the integration of such data as simple as possible. To achieve this, all data is stored in a CLDF dataset, while the accompanying prose is written in markdown. This means that the document that contains no linguistic data, only pointers to the dataset. Changes to the data only have to be done in the dataset, and don't include tinkering with the document. Presentation of the data in the document is done by templates,

To illustrate, this plain text in combination with this dataset can be turned into multiple formats:

It is also possible to integrate the output into CLLD web apps, using the clld-document-plugin; an example can be inspected here.

🔥 Quickstart

  1. pip install lingdocs (full installation guide)
  2. create or get a CLDF dataset
  3. lingdocs new, point to metadata.json file
  4. lingdocs preview

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

lingdocs-0.1.4.tar.gz (94.1 kB view details)

Uploaded Source

Built Distribution

lingdocs-0.1.4-py3-none-any.whl (134.4 kB view details)

Uploaded Python 3

File details

Details for the file lingdocs-0.1.4.tar.gz.

File metadata

  • Download URL: lingdocs-0.1.4.tar.gz
  • Upload date:
  • Size: 94.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.8.10 Linux/5.15.0-73-generic

File hashes

Hashes for lingdocs-0.1.4.tar.gz
Algorithm Hash digest
SHA256 428e0224b5c66dc8dd35e707e9065c010cf2cdd25e1d44dc434102d406bca321
MD5 ff407f475920c6a2bebb64aed9dd8a24
BLAKE2b-256 236fdb9ce6d7598547104f30c051088429e37eab73f5b4792c14fe4d6da7b479

See more details on using hashes here.

File details

Details for the file lingdocs-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: lingdocs-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 134.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.8.10 Linux/5.15.0-73-generic

File hashes

Hashes for lingdocs-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bb56b2c9b06f7356f40b18dd71abcc851610a5fa74dd9026cfbe7388d635ccf6
MD5 930271ac83ac14505432c49f6e1855a0
BLAKE2b-256 94ed8b1e98a25e3c16c872cd73803588ae78be384ded9eb0882e211d95f63df1

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