Commits

Christian Tismer committed fcc47c1

added some doc to check if bitbucket email notification works

Comments (0)

Files changed (1)

tiffany/monkeypil.py

 ===================================
 
 This module implements reading and writing of Tiff files.
-<add more here, decide where the info should go>
+It uses a few files from PIL as sub-modules via import_mapper
+and therefore can coexist with a seperate PIL installation.
+
+The sole purpose of Tiffany is reading and writing of multi-file
+Tiff. No attempt is made to encode, decode or modify image data.
+Tags are normalized and cleaned as a side effect.
+
+
+How it works
+------------
+-- to be done --
+
+
+Background
+----------
+
+Tiffany originates in the Didoca project that needs to read
+multi-file Tiff with CCITT G3/G4 encoding and display certain pages
+in Qt (PySide). Qt decodes many formats, but cannot display more than
+the first page and is very pedantic about the Tiff tags. Tiffany solves
+exactly that problem and does not require temporary files.
+
+
+Status
+------
+
+Currently, only Python 2.7 is supported. Support for Python 2.6
+and Python 3.X is in preparation.
 """
 
 rootpath = os.path.abspath(os.path.dirname(__file__))
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.