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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 2Python 3

File details

Details for the file syllables-0.1.0.tar.gz.

File metadata

  • Download URL: syllables-0.1.0.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for syllables-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4d65e542db97927ccce04f6668bda528f29f346bf7f5d8524c436eabae8a4cd6
MD5 8b60f5f7e44ab94e4e25c446b4af20e8
BLAKE2b-256 66fbf98f990752a3da8f288b41f62ea0e2661a2fe7d839d8ba29a2a2178edf0c

See more details on using hashes here.

File details

Details for the file syllables-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: syllables-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for syllables-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 66718d775b607e2c73f87ce2f6a652daf7c701c4ca8fd1c807b544d4f6bda28b
MD5 34b6c793074d388ac8597e6c25b6c4cc
BLAKE2b-256 16d981a31f640ccf405fdfd0eae8eebfc2579b438804dbf34dc03cad3e76169a

See more details on using hashes here.

Supported by

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