Metadata-Version: 2.1
Name: pylingdocs
Version: 0.0.7
Summary: Create data-rich linguistic documents.
Home-page: https://github.com/fmatter/pylingdocs
Author: Florian Matter
Author-email: florianmatter@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/fmatter/pylingdocs/issues
Keywords: digital linguistics,CLDF
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click (>=8.1.2)
Requires-Dist: cldfviz (>=0.9.0)
Requires-Dist: pycldf (>=1.25.1)
Requires-Dist: pandas (>=1.3.5)
Requires-Dist: panflute (>=2.1.3)
Requires-Dist: hupper (>=1.10.3)
Requires-Dist: cookiecutter (>=1.7.3)
Requires-Dist: cffconvert (>=2.0.0)
Requires-Dist: importlib-resources (>=5.6.0) ; python_version < "3.9.0"
Provides-Extra: dev
Requires-Dist: bump2version ; extra == 'dev'
Requires-Dist: coverage[toml] ; extra == 'dev'
Requires-Dist: prospector[with_pyroma] (==1.7.7) ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: sphinx (==4.5.0) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-autoapi ; extra == 'dev'
Requires-Dist: sphinx-click (==4.0.0) ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: myst-parser ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Provides-Extra: publishing
Requires-Dist: twine ; extra == 'publishing'
Requires-Dist: wheel ; extra == 'publishing'

# pylingdocs

Create data-rich linguistic documents.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6567304.svg)](https://doi.org/10.5281/zenodo.6567304)
![License](https://img.shields.io/github/license/fmatter/pylingdocs)
[![Documentation Status](https://readthedocs.org/projects/pylingdocs/badge/?version=latest)](https://pylingdocs.readthedocs.io/en/latest/?badge=latest)
[![Tests](https://img.shields.io/github/workflow/status/fmatter/pylingdocs/tests?label=tests)](https://github.com/fmatter/pylingdocs/actions/workflows/tests.yml)
[![Linting](https://img.shields.io/github/workflow/status/fmatter/pylingdocs/lint?label=linting)](https://github.com/fmatter/pylingdocs/actions/workflows/lint.yml)
[![Codecov](https://img.shields.io/codecov/c/github/fmatter/pylingdocs)](https://app.codecov.io/gh/fmatter/pylingdocs/)
[![PyPI](https://img.shields.io/pypi/v/pylingdocs.svg)](https://pypi.org/project/pylingdocs)
![Versions](https://img.shields.io/pypi/pyversions/pylingdocs)

The main functionalities of `pylingdocs` are showcased in the demo, where [this text](https://github.com/fmatter/pylingdocs/blob/main/docs/demo.txt), using [this dataset](https://github.com/fmatter/pylingdocs/tree/main/tests/data/cldf), is turned into a [PDF file](https://raw.githubusercontent.com/fmatter/pylingdocs/main/docs/demo.pdf).
Integration into CLLD web apps is possible with [clld-markdown-plugin](https://github.com/clld/clld-markdown-plugin/), optionally combined with [clld-document-plugin](https://github.com/fmatter/clld-document-plugin/); an example can be inspected [here](https://fl.mt/yawarana-sketch).

Installation:

`pip install pylingdocs`

For further instructions check out the documentation at [pylingdocs.readthedocs.io](https://pylingdocs.readthedocs.io).

Rudimentary GUI editor:

`pip install pylingdocs-gui`


