lexlib 3.0.0

Utilities for research involving words.

Python library for some utilities that may be useful for word research.

Note

This project is a work in progress. New functions may be added at any point. See CHANGELOG.md for important changes.

Features

• Extract consonant clusters from a word or list of words.

• Find neighbors of words.

• Other neighbor utilities, e.g., type of neighbor relationship, position of divergence.

• Get the syllable count for words or a list of words, or filter lists of words by number of syllables.

• Get the consonant-vowel structure of a word.

Requirements

• Python 3

Installation

Using pip install

pip3 install lexlib

From source

git clone for the development version

git clone https://github.com/cranndarach/lexlib.git
cd lexlib
pip install

Download a release

Download the latest release

In a terminal (remember to update the path):

cd path/to/download/lexlib-x.y.z.tar.gz
tar -xvf lexlib-x.y.z.tar.gz
cd lexlib-x.y.z/
pip install

Usage

To import the package to use in your project

import lexlib as lx

Note

All of the submodules are imported by lexlib. That means that you can call, for example, lx.get_neighbor_pairs() instead of lx.neighbors.get_neighbor_pairs().

For documentation on specific functions, see the docs/ directory or the online documentation or enter help(lx.function_name) into your interpreter.

License

This package is licensed under the terms of the MIT license, copyright (c) 2016-2019 R. Steiner.