Permalink
Browse files

More on packaging

  • Loading branch information...
1 parent 1e4e835 commit a1b9e75ac52955fcc3f91aa26aec9e9dab1c22ba @brendonh committed Nov 23, 2009
Showing with 47 additions and 4 deletions.
  1. +2 −0 MANIFEST.in
  2. +43 −4 README
  3. +2 −0 setup.py
View
2 MANIFEST.in
@@ -0,0 +1,2 @@
+recursive-include examples *.py
+recursive-include tests *.py
View
47 README
@@ -1,9 +1,48 @@
-====
-pyth
-====
+========================================
+pyth - Python text markup and conversion
+========================================
+Pyth is intended to make it easy to convert marked-up text between different common formats.
-unit tests
+*Marked-up text* means text which has:
+
+* Paragraphs
+* Headings
+* Bold, italic, and underlined text
+* Hyperlinks
+* Bullet lists
+* Simple tables
+* Very little else
+
+
+Formats I initially want to support are:
+
+* xhtml
+* rtf
+* pdf (output)
+
+
+These three formats cover web, Word / OpenOffice, and print.
+
+
+Design principles
+=================
+
+* Ignore unsupported information in input formats (e.g. page layout)
+* Ignore font issues -- output in a single font.
+* Ignore specific text sizes -- support relative sizes (bigger, littler) only. Output in a single base size.
+* Have no dependencies unless they are written in Python, and work
+* Make it easy to add support for new formats, by using an architecture based on *plugins* and *adapters*.
+
+
+
+Examples
+========
+
+See `http://github.com/brendonh/pyth/tree/master/examples/`
+
+
+Unit tests
==========
The sources contains some unit tests (written using python unittest
View
2 setup.py
@@ -3,9 +3,11 @@
setup(name="pyth",
version="0.5",
packages = find_packages(),
+ zip_safe = False,
description="Python text markup conversion",
author="Brendon Hogger",
author_email="brendonh@taizilla.com",
url="http://wiki.github.com/brendonh/pyth",
+ long_description=open('README').read(),
)

0 comments on commit a1b9e75

Please sign in to comment.