README
1Python wrapper for libiptcdata
2 - Ian Wienand <ianw@ieee.org>
3
4OVERVIEW
5========
6
7The iptcdata module is a wrapper around libiptcdata designed for
8updating IPTC information in JPEG files. It can be enabled by passing
9--enable-python to configure. It will produce a module called
10iptcdata.
11
12An iptcdata.Data object holds a list of iptcdata.DataSet objects.
13Values can be added and modified, but are only written back when the
14Data object's save() function is called. There are a handful of
15functions to query record numbers, etc.
16
17FILES
18=====
19
20 * pyiptcdatamod.c : module implementation
21 * pyiptcdata.c : iptcdata.Data object implementation
22 * pyiptcdataset.c : iptcdata.DataSet object implementation
23 * examples/*.py : some example/test programs using the library
24
25NOTES
26=====
27
28Each DataSet object holds a reference to the Data object; only once
29they are cleared will the Data object go away. To handle the case
30where references are held to a closed Data object, each object has a
31state describing it's current validity. Operations on objects in an
32invalid state should raise an exception saying as much.
33