|
| 1 | +########## |
| 2 | +python-opc |
| 3 | +########## |
| 4 | + |
| 5 | +VERSION: 0.0.1d (first development release) |
| 6 | + |
| 7 | + |
| 8 | +STATUS (as of June 23 2013) |
| 9 | +=========================== |
| 10 | + |
| 11 | +First development release. Under active development. |
| 12 | + |
| 13 | + |
| 14 | +Vision |
| 15 | +====== |
| 16 | + |
| 17 | +A robust, general-purpose library for manipulating Open Packaging Convention |
| 18 | +(OPC) packages, suitable as a foundation for a family of Open XML document |
| 19 | +libraries. Also to be suitable for general purpose manipulation of OPC |
| 20 | +packages, for example to access the XML and binary contents for indexing |
| 21 | +purposes and perhaps for manipulating package parts, for example to remove |
| 22 | +slide notes pages or to assemble presentations from individual slides in a |
| 23 | +library. |
| 24 | + |
| 25 | + |
| 26 | +Documentation |
| 27 | +============= |
| 28 | + |
| 29 | +Documentation is hosted on Read The Docs (readthedocs.org) at |
| 30 | +https://python-opc.readthedocs.org/en/latest/. |
| 31 | + |
| 32 | + |
| 33 | +Reaching out |
| 34 | +============ |
| 35 | + |
| 36 | +We'd love to hear from you if you like |po|, want a new feature, find a bug, |
| 37 | +need help using it, or just have a word of encouragement. |
| 38 | + |
| 39 | +The **mailing list** for |pp| is (google groups ... ) |
| 40 | + |
| 41 | +The **issue tracker** is on github at `python-openxml/python-opc`_. |
| 42 | + |
| 43 | +Feature requests are best broached initially on the mailing list, they can be |
| 44 | +added to the issue tracker once we've clarified the best approach, |
| 45 | +particularly the appropriate API signature. |
| 46 | + |
| 47 | +.. _`python-openxml/python-opc`: |
| 48 | + https://github.com/python-openxml/python-opc |
| 49 | + |
| 50 | + |
| 51 | +Installation |
| 52 | +============ |
| 53 | + |
| 54 | +|po| may be installed with ``pip`` if you have it available:: |
| 55 | + |
| 56 | + pip install python-opc |
| 57 | + |
| 58 | +It can also be installed using ``easy_install``:: |
| 59 | + |
| 60 | + easy_install python-opc |
| 61 | + |
| 62 | +If neither ``pip`` nor ``easy_install`` is available, it can be installed |
| 63 | +manually by downloading the distribution from PyPI, unpacking the tarball, |
| 64 | +and running ``setup.py``:: |
| 65 | + |
| 66 | + tar xvzf python-opc-0.0.1d1.tar.gz |
| 67 | + cd python-opc-0.0.1d1 |
| 68 | + python setup.py install |
| 69 | + |
| 70 | +|po| depends on the ``lxml`` package. Both ``pip`` and ``easy_install`` will |
| 71 | +take care of satisfying that dependency for you, but if you use this last |
| 72 | +method you will need to install ``lxml`` yourself. |
| 73 | + |
| 74 | + |
| 75 | +Release History |
| 76 | +=============== |
| 77 | + |
| 78 | +June 23, 2013 - v0.0.1d1 |
| 79 | + * Establish initial enviornment and development branches |
| 80 | + |
| 81 | + |
| 82 | +License |
| 83 | +======= |
| 84 | + |
| 85 | +Licensed under the `MIT license`_. Short version: this code is copyrighted by |
| 86 | +me (Steve Canny), I give you permission to do what you want with it except |
| 87 | +remove my name from the credits. See the LICENSE file for specific terms. |
| 88 | + |
| 89 | +.. _MIT license: |
| 90 | + http://www.opensource.org/licenses/mit-license.php |
| 91 | + |
| 92 | +.. |p0| replace:: ``python-opc`` |
0 commit comments