https://github.com/cranndarach/lexlib
Python package containing functions that may be useful for word research.
https://github.com/cranndarach/lexlib
cognitive-science nlp orthography phonology psycholinguistics psychology python3 research stimulus words
Last synced: 4 days ago
JSON representation
Python package containing functions that may be useful for word research.
- Host: GitHub
- URL: https://github.com/cranndarach/lexlib
- Owner: cranndarach
- License: mit
- Created: 2016-12-27T06:07:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-08T01:30:11.000Z (over 7 years ago)
- Last Synced: 2025-09-11T05:52:12.245Z (10 months ago)
- Topics: cognitive-science, nlp, orthography, phonology, psycholinguistics, psychology, python3, research, stimulus, words
- Language: Python
- Size: 6.03 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
========
lexlib
========
Python library for some utilities that may be useful for word research.
.. image:: https://badge.fury.io/py/lexlib.svg
:target: https://badge.fury.io/py/lexlib
.. note:: This project is a work in progress. New functions may be added at
any point. See `CHANGELOG.md`_ for important changes.
.. _CHANGELOG.md: https://github.com/cranndarach/lexlib/blob/master/CHANGELOG.md
----------
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.
.. _online documentation: http://lexlib.readthedocs.io
---------
License
---------
This package is licensed under the terms of the MIT license, copyright (c)
2016-2019 R. Steiner.