https://github.com/direct-phonology/phony

phonology in spaCy!
https://github.com/direct-phonology/phony

linguistics nlp phonology python spacy

Last synced: 24 days ago
JSON representation

phonology in spaCy!

• Host: GitHub
• URL: https://github.com/direct-phonology/phony
• Owner: direct-phonology
• License: mit
• Created: 2022-01-22T21:10:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-09T20:50:46.000Z (over 2 years ago)
• Last Synced: 2024-10-12T14:42:11.475Z (24 days ago)
• Topics: linguistics, nlp, phonology, python, spacy
• Language: Python
• Homepage:
• Size: 60.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# phoNy: phonology in spaCy!

[![ci status](https://github.com/direct-phonology/phoNy/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/direct-phonology/phoNy/actions/workflows/ci.yml)

[![pypi version](https://img.shields.io/pypi/v/spacy-phony.svg?style=flat)](https://pypi.org/project/spacy-phony/)

[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

phoNy is a spaCy extension that adds pipeline components, models, and features for working with phonology.

## installation

requires spacy v3.

```sh

pip install spacy-phony

```

## usage

this package currently provides a single pipeline component, the `Phonemizer`, which performs grapheme-to-phoneme conversion. documentation is coming soon!

## developing

after cloning the repository:

```sh

pip install -e ".[dev]"

pre-commit install

```

## testing

to run tests:

```sh

python -m unittest

```

you can also generate a [coverage report](https://coverage.readthedocs.io/en/latest/):

```sh

coverage run --source=src -m unittest discover

coverage report -m

```

## building

remove the `-dev` prefix from the version in `setup.cfg` before the release.

clear out any previously built packages before building:

```sh

rm -rf dist/*

```

build a source archive and distribution for a release:

```sh

python -m build

```

publish the release on [test PyPI](https://test.pypi.org/) (useful for making sure everything worked):

```sh

python -m twine upload --repository testpypi dist/*

```

if everything looks ok, upload to the real PyPI:

```sh

python -m twine upload dist/*

```

bump the version number to the next version with a `-dev` prefix in setup.cfg after releasing.

## license

code is licensed under the [MIT license](LICENSE).