Skip to main content

A tiny web type setter

Project description

License: LGPL3 PyPI version Travis CI

degrotesque - A tiny web type setter.

Introduction

The script loads a HTML page — or several in batch, one after the other — and for each, it replaces some commonly used non-typographic characters, such as ", ', -, etc. into their typographic representant for improving the pages' appearance.

E.g.:

"Well - that's not what I had expected."

will become:

“Well — that's not what I had expected.”

(Uhm, uhm, for those who don't see it, the starting and ending quotes have been replaced by “ and ”, respectively, the ' by ' and the - by an —.)

Download and Installation

The current version is degrotesque-1.0.

You may install degrotesque using

python -m pip install degrotesque

You may download a copy or fork the code at the degrotesque's github page.

Besides, you may download the current release degrotesque-1.0 here:

Licence

degrotesque is licensed under the LGPL v3.0.

Documentation

Usage

degrotesque is currently implemented in Python. It is started on the command line. The option -i <PATH> / --input <PATH> tells the script which file(s) shall be read — you may name a file or a folder, here. If the option -r / --recursive is set, the given folder will be processed recursively.

The tool processes only HTML-files and its derivatives. The extensions of those file types that are processed are given in Appendix A. But you may name the extensions of files to process using the -e <EXTENSION>[,<EXTENSION>]* / --extensions <EXTENSION>[,<EXTENSION>]* option.

The files are read one by one and the replacement of plain ASCII-chars by some nicer ones is based upon a chosen set of “actions”. Known and default actions are given in Appendix B. You may select the actions to apply using the -a <ACTION_NAME>[,<ACTION_NAME>]* / --actions <ACTION_NAME>[,<ACTION_NAME>]* option.

The files are assumed to be encoded as “UTF-8“ per default. You may change the encoding using the option -E <ENCODING> / --encoding <ENCODING>.

The script does not change the quotation marks of HTML elements, of course. As well, the contents of several elements, given in Appendix C are skipped. You may change the list of elements which contents shall not be processed using the option -s <ELEMENT_NAME>[,<ELEMENT_NAME>]* / --skip <ELEMENT_NAME>[,<ELEMENT_NAME>]*. The default elements which contents are not processed are given in Appendix C.

After the actions have been applied to its contents, the file is saved. By default, the original file is saved under the same name, with the appendix “.orig”. You may omit the creation of these backup files using the option -B / --no-backup.

The default actions are: masks, quotes.english, dashes, ellipsis, math, apostroph. Change after version 1.0: Please note that “masks” is a special action set that disallows the application of some other actions so that, e.g., the dividers in ISBN numbers are not replaced by &ndash;. The masks actions set is given in Appendix D.

Options

The script has the following options:

  • --input/-i <PATH>: the file or the folder to process
  • --encoding/-E <ENCODING>: The assumed encoding of the files
  • --recursive/-r: Set if the folder — if given — shall be processed recursively
  • --no-backup/-B: Set if no backup files shall be generated
  • --actions/-a <ACTION_NAME>[,<ACTION_NAME>]*: Name the actions that shall be applied
  • --extensions/-e <EXTENSION>[,<EXTENSION>]*: The extensions of files that shall be processed
  • --skip/-s <ELEMENT_NAME>[,<ELEMENT_NAME>]*: Elements which contents shall not be changed

Application Programming Interface - API

You may as well embedd degrotesque within your own applications. The usage is very straightforward:

import degrotesque
# build the degrotesque instance with default values
degrotesque = degrotesque.Degrotesque()
# apply degroteque
prettyString = degrotesque.prettify(uglyString)

The default values can be replaced using some of the class' interfaces (methods):

# change the actions to apply (by naming them)
# here: apply french quotes and math symbols
degrotesque.setActions("quotes.french,math")
# change the elements which contents shall be skipped
# here: skip the contents of "code", "script", and "style" elements
degrotesque.setToSkip("code,script,style")

You may as well consult the degrotesque pydoc code documentation.

Further Documentation

Implementation Notes

  • I tried Genshi, BeautifulSoup, and lxml. All missed in keeping the code unchanged. So the parser just skips HTML-elements and the contents of some special elements, see above. Works in most cases.

Examples / Users

Summary

Well, have fun. If you have any comments / ideas / issues, please submit them to degrotesque's issue tracker on github.

Appendices

Appendix A: Default Extensions

Files with the following extensions are parsed per default:

  • html, htm, xhtml,
  • php, phtml, phtm, php2, php3, php4, php5,
  • asp,
  • jsp, jspx,
  • shtml, shtm, sht, stm,
  • vbhtml,
  • ppthtml,
  • ssp, jhtml

Appendix B: Named Actions

The following action sets are currently implemented.

Please note that the actions are realised using regular expressions. I decided not to show them in the following for a better readability and show the visible changes only.

Action Name From Opening String From Closing String To Opening String To Closing String
quotes.english ' '
" "
quotes.french < >
<< >> « »
quotes.german ' '
" "
to_quotes ' ' <q> </q>
" " <q> </q>
<< >> <q> </q>
< > <q> </q>
commercial (c) ©
(r) ®
(tm)
dashes -
<NUMBER>-<NUMBER> <NUMBER>–<NUMBER>
bullets *
ellipsis ...
apostrophe ' '
math +/- ±
1/2 ½
1/4 ¼
3/4 ¾
~
!=
<=
>=
<NUMBER>*<NUMBER> <NUMBER>×<NUMBER>
<NUMBER>x<NUMBER> <NUMBER>×<NUMBER>
<NUMBER>/<NUMBER> <NUMBER>÷<NUMBER>
dagger **
*

Appendix C: Skipped Elements

The contents of the following elements are not processed by default:

  • script
  • code
  • style
  • pre
  • ?
  • ?php
  • %
  • %=
  • %@
  • %--
  • %!
  • !--

Appendix D: Masking Action Set

The “masks” action set is masking some patterns to avoid replacements. When matching, the matching string is kept. The actions are given in the following. Please note that the numbers in { } brackets give the number of subsequent elements.

  • 978-<NUMBER>-<NUMBER>-<NUMBER>-<NUMBER>{1}<NO_NUMBER>: avoid ISBN replacement
  • 979-<NUMBER>-<NUMBER>-<NUMBER>-<NUMBER>{1}<NO_NUMBER>: avoid ISBN replacement
  • <NUMBER>-<NUMBER>-<NUMBER>-<NUMBER>{1}<NO_NUMBER>: avoid ISBN replacement
  • ISSN <NUMBER>{4}-<NUMBER>{4}: avoid ISSN replacement

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for degrotesque, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size degrotesque-1.2-py2-none-any.whl (13.9 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size degrotesque-1.2.tar.gz (10.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page