compoundfiles icon indicating copy to clipboard operation
compoundfiles copied to clipboard

A reader for OLE Compound Document Files (like OleFileIO, but better)

============= compoundfiles

|pypi| |rtd| |travis|

This package provides a library for reading Microsoft's Compound File Binary_ format (CFB), formerly known as OLE Compound Documents, the Advanced Authoring Format (AAF), or just plain old Microsoft Office files (the non-XML sort). This format is also widely used with certain media systems and a number of scientific applications (tomography and microscopy).

The code is pure Python and should run on any platform; it is compatible with Python 2.7 (or above) and Python 3.2 (or above). The library has an emphasis on rigour and performs numerous validity checks on opened files. By default, the library merely warns when it comes across non-fatal errors in source files but this behaviour is configurable by developers through Python's warnings mechanisms.

Links

  • The code is licensed under the MIT license_
  • The source code_ can be obtained from GitHub, which also hosts the bug tracker_
  • The documentation_ (which includes installation instructions and quick-start examples) can be read on ReadTheDocs
  • The build status_ can be observed on Travis CI

.. _documentation: http://compound-files.readthedocs.org/ .. _source code: https://github.com/waveform-computing/compoundfiles .. _bug tracker: https://github.com/waveform-computing/compoundfiles/issues .. _Compound File Binary: http://msdn.microsoft.com/en-gb/library/dd942138.aspx .. _OLE Compound Documents: http://www.openoffice.org/sc/compdocfileformat.pdf .. _Advanced Authoring Format: http://www.amwa.tv/downloads/specifications/aafcontainerspec-v1.0.1.pdf .. _MIT license: http://opensource.org/licenses/MIT .. _build status: https://travis-ci.org/waveform-computing/compoundfiles

.. |pypi| image:: https://img.shields.io/pypi/v/compoundfiles.svg :target: https://pypi.python.org/pypi/compoundfiles :alt: Latest release

.. |rtd| image:: https://readthedocs.org/projects/compound-files/badge/?version=latest :target: https://compound-files.readthedocs.org/ :alt: Documentation status

.. |travis| image:: https://travis-ci.org/waveform-computing/compoundfiles.svg?branch=master :target: https://travis-ci.org/waveform-computing/compoundfiles :alt: Build status