Skip to main content

A Python package for estimating the number of syllables in a word.

Project description

# Syllables: A fast syllable estimator for Python

[![Latest PyPI version](https://img.shields.io/pypi/v/syllables.svg)](https://pypi.python.org/pypi/syllables)

[![Latest Travis CI build status](https://travis-ci.org/prosegrinder/python-syllables.svg?branch=master)](https://travis-ci.org/prosegrinder/python-syllables)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b8f26e0833ae4698b927614e64fd91b4)](https://www.codacy.com/app/ProseGrinder/python-syllables?utm_source=github.com&utm_medium=referral&utm_content=prosegrinder/python-syllables&utm_campaign=Badge_Grade)

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:

$ pip install syllables

You can also install it from source:

$ 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 fo syllables in a single word.

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

## Credits

Built on or modeled after the following open source projects:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syllables-0.1.0.tar.gz (15.6 kB view hashes)

Uploaded Source

Built Distribution

syllables-0.1.0-py2.py3-none-any.whl (15.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page