Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 57 lines (36 sloc) 1.462 kb
a1b9e75 @brendonh More on packaging
authored
1 ========================================
2 pyth - Python text markup and conversion
3 ========================================
54caa5d @guillaumechereau Add some words about the unit tests in the README file
guillaumechereau authored
4
a1b9e75 @brendonh More on packaging
authored
5 Pyth is intended to make it easy to convert marked-up text between different common formats.
54caa5d @guillaumechereau Add some words about the unit tests in the README file
guillaumechereau authored
6
a1b9e75 @brendonh More on packaging
authored
7 *Marked-up text* means text which has:
8
9 * Paragraphs
10 * Headings
11 * Bold, italic, and underlined text
12 * Hyperlinks
13 * Bullet lists
14 * Simple tables
15 * Very little else
16
17
18 Formats I initially want to support are:
19
20 * xhtml
21 * rtf
22 * pdf (output)
23
24
25 These three formats cover web, Word / OpenOffice, and print.
26
27
28 Design principles
29 =================
30
31 * Ignore unsupported information in input formats (e.g. page layout)
32 * Ignore font issues -- output in a single font.
33 * Ignore specific text sizes -- support relative sizes (bigger, littler) only. Output in a single base size.
34 * Have no dependencies unless they are written in Python, and work
35 * Make it easy to add support for new formats, by using an architecture based on *plugins* and *adapters*.
36
37
38
39 Examples
40 ========
41
889680d @brendonh Okay I think that got it
authored
42 See http://github.com/brendonh/pyth/tree/master/examples/
a1b9e75 @brendonh More on packaging
authored
43
44
45 Unit tests
54caa5d @guillaumechereau Add some words about the unit tests in the README file
guillaumechereau authored
46 ==========
47
48 The sources contains some unit tests (written using python unittest
49 module) in the 'tests' directory.
50
51 To run the tests we can either run them individually as python script,
52 either use `python nose`_. If using nose then we just need to go into
53 the tests directory and invoke nosetest from there (make sure that
54 pyth module is in PYTHONPATH).
55
56 .. _python nose: http://code.google.com/p/python-nose/
Something went wrong with that request. Please try again.