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) [![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) [![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-1.0.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: syllables-1.0.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for syllables-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e9eaf9de5761b7692b139e488d144a16968fbec21208815d150643dc91993f4f
MD5 46baada2142ed7104969cc87a1aa16ea
BLAKE2b-256 4a298ee5270f457f85d8b466681d7aa40698989f85226d74e2e4c1151ab7ea18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: syllables-1.0.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/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for syllables-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a310ead48b83af12372159767fe23b6676f69fa0afa805904c3ee51df1de6a56
MD5 df50c9e509233dbb25eee5233d8a9fe7
BLAKE2b-256 965019e7bb2c6d1e43ab585932160674a01f68f4303403c68e189785efd4b85d

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