Metadata-Version: 2.1
Name: pysyllables
Version: 1.0.2
Summary: An in-memory syllable count dictionary for North American English derived from the CMU Pronouncing Dictionary.
Home-page: https://github.com/voberoi/pysyllables
Author: Vikram Oberoi
Author-email: voberoi@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown


# pysyllables

An in-memory syllable count dictionary for North American English derived from 
the CMU Pronouncing Dictionary.

```
>>> from pysyllables import get_syllable_count
>>> get_syllable_count("fabulous")
3
>>> get_syllable_count("word-that-doesn't-exist")
None
```

## Where do these syllable counts come from?

From the [CMU Pronouncing Dictionary](http://www.speech.cs.cmu.edu/cgi-bin/cmudict),
an open-source machine-readable pronunciation dictionary for North American English
that contains over 134,000 words and their pronunciations.

By counting the number of lexical stress markers in each word's pronunciation, we can
compute the # of syllables in each word. This library ships with a file that maps each
word to a syllable count in [pysyllables/syllable-counts.txt](pysyllables/syllable-counts.txt)

## How does one generate [pysyllables/syllable-counts.txt](pysyllables/syllable-counts.txt)?

[scripts/download_syllable_counts.sh](scripts/download_syllable_counts.sh) downloads
the CMU Pronouncing Dictionary, computes each word's syllable count, and emits
[pysyllables/syllable-counts.txt](pysyllables/syllable-counts.txt).

Should there be a new version of the CMU Pronouncing Dictionary, update the source in
[scripts/download_syllable_counts.sh](scripts/download_syllable_counts.sh).

## Contributing

Questions & contributions welcome -- please open an issue or, even better, a PR!


