Metadata-Version: 2.1
Name: syllables
Version: 1.0.2
Summary: A Python package for estimating the number of syllables in a word.
Home-page: https://github.com/prosegrinder/python-syllables
Author: David L. Day
Author-email: dday376@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/prosegrinder/python-syllables/issues
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=2.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Syllables: A fast syllable estimator for Python

[![Latest PyPI version](https://img.shields.io/pypi/v/syllables.svg)](https://pypi.python.org/pypi/syllables)
[![Python CI](https://github.com/prosegrinder/python-syllables/workflows/Python%20CI/badge.svg?branch=main)](https://github.com/prosegrinder/python-syllables/actions?query=workflow%3A%22Python+CI%22)

Syllables is a fast, simple syllable estimator for Python. It's intended for use
in places where speed matters. For situations where accuracy matters, please
consider the [cmudict](https://github.com/prosegrinder/python-cmudict) Python
library instead.

## Installation

`syllables` is available on PyPI. Simply install it with `pip`:

```bash
pip install syllables
```

You can also install it from source:

```bash
  $ git clone https://github.com/prosegrinder/python-syllables.git
  Cloning into 'python-syllables'...
  ...

  $ cd python-syllables
  $ python setup.py install
  ...
```

## Usage

Syllables provides a single function, estimate, which estimates the number of
syllables in a single word.

```python
>>> import syllables
>>> syllables.estimate('estimate')
4
>>> syllables.estimate('syllables')
3
```

## Credits

Built on or modeled after the following open source projects:

- [One Bloke: Counting Syllables Accurately in Python on Google App Engine](http://www.onebloke.com/2011/06/counting-syllables-accurately-in-python-on-google-app-engine/)


