Skip to main content

Python Port of John Gruber's titlecase.pl

Project description

https://travis-ci.org/ppannuto/python-titlecase.svg?branch=master https://coveralls.io/repos/github/ppannuto/python-titlecase/badge.svg?branch=master

This filter changes all words to Title Caps, and attempts to be clever about SMALL words like a/an/the in the input.

The list of “SMALL words” which are not capped comes from the New York Times Manual of Style, plus some others like ‘vs’ and ‘v’.

This is a resurrection of Stuart Colville’s titlecase.py, which was in turn a port of John Gruber’s titlecase.pl.

Issues, updates, pull requests, etc should be directed to github.

Installation

The easiest method is to simply use pip:

(sudo) pip install titlecase

Usage

Titlecase provides only one function, simply:

>>> from titlecase import titlecase
>>> titlecase('a thing')
'A Thing'

A callback function may also be supplied, which will be called for every word:

>>> def abbreviations(word, **kwargs):
...   if word.upper() in ('TCP', 'UDP'):
...     return word.upper()
...
>>> titlecase.titlecase('a simple tcp and udp wrapper', callback=abbreviations)
'A Simple TCP and UDP Wrapper'

The callback function is supplied with an all_caps keyword argument, indicating whether the entire line of text was entirely capitalized. Returning None from the callback function will allow titlecase to process the word as normal.

Command Line Usage

Titlecase also provides a command line utility titlecase:

$ titlecase make me a title
Make Me a Title
$ echo "Can pipe and/or whatever else" | titlecase
Can Pipe and/or Whatever Else
# Or read/write files:
$ titlecase -f infile -o outfile

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

titlecase-0.12.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

titlecase-0.12.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file titlecase-0.12.0.tar.gz.

File metadata

  • Download URL: titlecase-0.12.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for titlecase-0.12.0.tar.gz
Algorithm Hash digest
SHA256 84de7a97fb702c400e5ba11c6b30849944b39db12e20fbf4515a23c7538a0611
MD5 238c9655b9943801b1816046dcedb00e
BLAKE2b-256 3b785b9faa7b9288c9fa5a4fdb6989f5e675744511ab6cff0489a0c7744a4f6b

See more details on using hashes here.

Provenance

File details

Details for the file titlecase-0.12.0-py3-none-any.whl.

File metadata

File hashes

Hashes for titlecase-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 95d643a0c08097c02933aced707adfe1c275c335019e8e514dea782a465c5b84
MD5 78f9dd45a2c5b4dd046a6a574c45b264
BLAKE2b-256 1c6b1af08c2d82cf3bad9caf764bca8c398c78f811d0638e5cb268952f45c917

See more details on using hashes here.

Provenance

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