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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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