Metadata-Version: 2.1
Name: pyigt
Version: 1.1.0
Summary: A Python library for handling inter-linear-glossed text.
Home-page: https://github.com/cldf/pyigt
Author: Johann-Mattis List
Author-email: list@shh.mpg.de
License: GPL
Description: # pyigt: Handling interlinear glossed text with Python
        
        [![Build Status](https://travis-ci.org/cldf/pyigt.svg?branch=master)](https://travis-ci.org/cldf/pyigt)
        [![codecov](https://codecov.io/gh/cldf/pyigt/branch/master/graph/badge.svg)](https://codecov.io/gh/cldf/pyigt)
        [![PyPI](https://img.shields.io/pypi/v/pyigt.svg)](https://pypi.org/project/pyigt)
        
        This library provides easy access to **I**nterlinear **G**lossed **T**ext (IGT) according
        to the [Leipzig Glossing Rules](https://www.eva.mpg.de/lingua/resources/glossing-rules.php), stored as [CLDF examples](https://github.com/cldf/cldf/tree/master/components/examples).
        
        
        ## Installation
        
        Installing `pyigt` via pip
        
        ```shell script
        pip install pyigt
        ```
        will install the Python package along with a command line interface `igt`.
        
        ## Usage
        
        ### CLI
        
        ```shell script
        $ igt -h
        usage: igt [-h] [--log-level LOG_LEVEL] COMMAND ...
        
        optional arguments:
          -h, --help            show this help message and exit
          --log-level LOG_LEVEL
                                log level [ERROR|WARN|INFO|DEBUG] (default: 20)
        
        available commands:
          Run "COMAMND -h" to get help for a specific command.
        
          COMMAND
            ls                  List IGTs in a CLDF dataset
            stats               Describe the IGTs in a CLDF dataset
        
        ```
        
        The `igt ls` command allows inspecting IGTs from the commandline, formatted using the
        four standard lines described in the Leipzig Glossing Rules, where analyzed text and
        glosses are aligned, e.g.
        ```shell script
        $ igt ls tests/fixtures/examples.csv 
        Example 1:
        zəple: ȵike: peji qeʴlotʂuʁɑ,
        zəp-le:       ȵi-ke:       pe-ji       qeʴlotʂu-ʁɑ,
        earth-DEF:CL  WH-INDEF:CL  become-CSM  in.the.past-LOC
        
        ...
        
        Example 5:
        zuɑməɸu oʐgutɑ ipiχuɑȵi,
        zuɑmə-ɸu      o-ʐgu-tɑ    i-pi-χuɑ-ȵi,
        cypress-tree  one-CL-LOC  DIR-hide-because-ADV
        
        IGT corpus at tests/fixtures/examples.csv
        ```
        
        `igt ls` can be chained with other commandline tools such as commands from the 
        [csvkit](https://csvkit.readthedocs.io/en/latest/) package for filtering:
        ```shell script
        $ csvgrep -c Primary_Text -m"ȵi"  tests/fixtures/examples.csv | csvgrep -c Gloss -m"ADV" |  igt ls -
        Example 5:
        zuɑməɸu oʐgutɑ ipiχuɑȵi,
        zuɑmə-ɸu      o-ʐgu-tɑ    i-pi-χuɑ-ȵi,
        cypress-tree  one-CL-LOC  DIR-hide-because-ADV
        
        ```
        
        
        
        ### Python API
        
        ```python
        >>> from pyigt import Corpus
        >>> corpus = Corpus.from_path('tests/fixtures/cldf-metadata.json')
        >>> len(corpus)
        >>> len(corpus)
        5
        >>> for igt in corpus:
        ...     print(igt)
        ...     break
        ... 
        zəple: ȵike: peji qeʴlotʂuʁɑ,
        zəp-le:       ȵi-ke:       pe-ji       qeʴlotʂu-ʁɑ,
        earth-DEF:CL  WH-INDEF:CL  become-CSM  in.the.past-LOC
        ```
        
        
        ## See also
        
        - [interlineaR](https://cran.r-project.org/web/packages/interlineaR/index.html) - an R package with similar functionality, but support for more input formats.
        
Keywords: Chinese linguistics,historical linguistics,computer-assisted language comparison
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
