Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 1.76 KB

install.rst

File metadata and controls

68 lines (43 loc) · 1.76 KB

Installation

The library has no dependencies in and of itself, and consists entirely of Python code, so installation should be trivial on most platforms. A debian packaged variant is available from the author's PPA for Ubuntu users, otherwise installation from PyPI is recommended.

Ubuntu installation

To install from the author's PPA:

$ sudo add-apt-repository ppa://waveform/ppa
$ sudo apt-get update
$ sudo apt-get install python-compoundfiles

To remove the installation:

$ sudo apt-get remove python-compoundfiles

PyPI installation

To install from PyPI:

$ sudo pip install compoundfiles

To upgrade the installation:

$ sudo pip install -U compoundfiles

To remove the installation:

$ sudo pip uninstall compoundfiles

Development installation

If you wish to develop the library yourself, you are best off doing so within a virtualenv with source checked out from GitHub, like so:

$ sudo apt-get install make git python-virtualenv exuberant-ctags
$ virtualenv sandbox
$ source sandbox/bin/activate
$ git clone https://github.com/waveform-computing/compoundfiles.git
$ cd compoundfiles
$ make develop

The above instructions assume Ubuntu Linux, and use the included Makefile to perform a development installation into the constructed virtualenv (as well as constructing a tags file for easier navigation in vim/emacs). Please feel free to extend this section with instructions for alternate platforms.