Introduction

smartypants is a Python fork of SmartyPants.

smartypants can perform the following transformations:

  • Straight quotes (" and ') into “curly” quote HTML entities
  • Backticks-style quotes (``like this'') into “curly” quote HTML entities
  • Dashes (-- and ---) into en- and em-dash entities
  • Three consecutive dots (... or . . .) into an ellipsis entity

This means you can write, edit, and save your posts using plain old ASCII straight quotes, plain dashes, and plain dots, but your published posts (and final HTML output) will appear with smart quotes, em-dashes, and proper ellipses.

smartypants does not modify contents in some HTML element, see Skipped HTML Elements. Typically, these tags are used to display text where smart quotes and other “smart punctuation” would not be appropriate, such as source code or example markup.

Quick usage

To use it as a module:

import smartypants

text = '"SmartyPants" is smart, so is <code>smartypants</code> -- a Python port'
print(smartypants.smartypants(text))

To use the command-line script smartypants:

echo '"SmartyPants" is smart, so is <code>smartypants</code> -- a Python port' | smartypants

Both produce:

&#8220;SmartyPants&#8221; is smart, so is <code>smartypants</code> &#8212; a Python port

Installation

smartypants package on PyPI can be installed via pip:

pip install smartypants

If you want to install latest development code, you can run:

pip install hg+https://bitbucket.org/livibetter/smartypants.py

or:

pip install hg+ssh://hg@bitbucket.org/livibetter/smartypants.py

Table Of Contents

Previous topic

Welcome to smartypants documentation!

Next topic

Usage

This Page