Data

Tools

Indexes

Applications

Experiments

Open Source Science

lingdocs

Create data-rich linguistic documents.

https://github.com/fmatter/lingdocs

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary

Keywords

cldf digital-humanities digital-linguistics editor linguistics markdown
Last synced: 6 months ago · JSON representation ·

Repository

Create data-rich linguistic documents.

Basic Info
  • Host: GitHub
  • Owner: fmatter
  • License: apache-2.0
  • Language: TeX
  • Default Branch: main
  • Homepage: https://fl.mt/pylingdocs
  • Size: 3.58 MB
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 0
  • Open Issues: 23
  • Releases: 15
Topics
cldf digital-humanities digital-linguistics editor linguistics markdown
Created almost 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

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. installation (full guide)
    1. pip install lingdocs
    2. install pandoc
  2. create or get a CLDF dataset
  3. lingdocs new, point to metadata.json file
  4. lingdocs preview

Owner

  • Name: Florian Matter
  • Login: fmatter
  • Kind: user
  • Location: Eugene
  • Company: University of Eugene / University of Bern

Citation (CITATION.cff) 

# YAML 1.2
---
cff-version: "1.1.0"
title: "lingdocs"
authors:
  - family-names: Matter
    given-names: Florian
    orcid: "https://orcid.org/0000-0002-2545-5154"
date-released: 2023-12-27
version: "0.1.4"
url: "https://github.com/fmatter/lingdocs/releases/tag/0.1.4"
keywords:
  - digital linguistics
  - CLDF
message: "If you use this software, please cite it using these metadata."
license: Apache-2.0

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 29
  • Total pull requests: 1
  • Average time to close issues: 3 months
  • Average time to close pull requests: 11 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.93
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • fmatter (23)
  • xrotwang (6)
Pull Request Authors
  • fmatter (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

tests/data/cldf/requirements.txt pypi
  • DateTime ==4.4 test
  • Markdown ==3.3.6 test
  • MarkupSafe ==2.1.1 test
  • SQLAlchemy ==1.4.35 test
  • WebHelpers2 ==2.0 test
  • WebOb ==1.8.7 test
  • Zope ==5.5.1 test
  • appdirs ==1.4.4 test
  • certifi ==2021.10.8 test
  • chardet ==4.0.0 test
  • cldfbench ==1.11.0 test
  • cldfcatalog ==1.5.1 test
  • clld ==9.0.2 test
  • clldutils ==3.11.1 test
  • colorlog ==6.6.0 test
  • csvw ==2.0.0 test
  • gitdb ==4.0.9 test
  • greenlet ==1.1.2 test
  • idna ==3.3 test
  • isodate ==0.6.1 test
  • nameparser ==1.1.1 test
  • newick ==1.3.2 test
  • numpy ==1.21.6 test
  • pandas ==1.3.5 test
  • purl ==1.6 test
  • pybtex ==0.24.0 test
  • pycldf ==1.26.1 test
  • pycountry ==22.3.5 test
  • pyglottolog ==3.7.0 test
  • pyramid ==2.0 test
  • python-dateutil ==2.8.2 test
  • python-gettext ==4.0 test
  • python-slugify ==6.1.1 test
  • pytz ==2021.3 test
  • rdflib ==6.1.1 test
  • requests ==2.27.1 test
  • rfc3986 ==1.5.0 test
  • six ==1.16.0 test
  • smmap ==5.0.0 test
  • tabulate ==0.8.9 test
  • termcolor ==1.1.0 test
  • tqdm ==4.64.0 test
  • transaction ==3.0.1 test
  • typing_extensions ==4.2.0 test
  • uritemplate ==4.1.1 test
  • urllib3 ==1.26.9 test
  • venusian ==3.0.0 test
  • wcwidth ==0.2.5 test
  • zipp ==3.8.0 test
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • ncipollo/release-action v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • nikeee/setup-pandoc v1 composite
pyproject.toml pypi
  • cldf-rel ^0.0.4
  • cldfviz ^1.0.0
  • click ^8.1.7
  • cookiecutter ^2.4.0
  • hupper ^1.12
  • importlib-resources ^6.1.0
  • mkdocs-awesome-pages-plugin ^2.9.2
  • mkdocs-enumerate-headings-plugin ^0.6.1
  • mkdocs-material ^9.4.3
  • mkdocs-site-urls ^0.2.0
  • pandas ^2.0.3
  • panflute ^2.3.0
  • pycldf ^1.35.0
  • python ^3.8.1
  • python-slugify ^8.0.1
  • writio ^0.0.1