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.11.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

titlecase-0.11.0-py2-none-any.whl (9.6 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for titlecase-0.11.0.tar.gz
Algorithm Hash digest
SHA256 2ad96f67ad3573a9d07a1675d958abc1930df260e08512db2c821c39b2d5fab8
MD5 07a55121104abc2f1503c29877d82b53
BLAKE2b-256 541c4c1b5a4b29abc8f06d6e74d5fd6d25bbc7f66b5b659349d4a4acf26001db

See more details on using hashes here.

File details

Details for the file titlecase-0.11.0-py2-none-any.whl.

File metadata

File hashes

Hashes for titlecase-0.11.0-py2-none-any.whl
Algorithm Hash digest
SHA256 554c820c8165bd8658b4030bd10417e07a80d4a6ad8f13c02b9beb695e244152
MD5 b5426f6aed3b055ecb918c75df537df7
BLAKE2b-256 9994324d2016ffefaded07670741b17578a66df627282ce783fe5c98177b7049

See more details on using hashes here.

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