Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 2.43 KB

File metadata and controls

77 lines (53 loc) · 2.43 KB

Paperwork development installation

Dependencies

Depending on which branch you are using, the build and runtime dependencies may not be the same. Setuptools will take care of most of them, but not all. Please have a look at the wiki to know what build dependencies must installed before proceeding. Setuptools will also indicate extra dependencies to install, so watch carefully the ouput of ./setup.py.

System-wide installation

$ mkdir -p ~/git
$ cd ~/git
$ git clone https://github.com/jflesch/paperwork.git
$ cd paperwork
$ git checkout unstable
$ sudo python ./setup.py install

(see the wiki as to why you probably want to work on the branch 'unstable')

Paperwork in a Python Virtualenv

If you intend to work on Paperwork, this is probably the most convenient way to install safely a development version of Paperwork.

Virtualenv allows to run Paperwork in a specific environment, with the latest versions of most of its dependencies. It also make it easier to remove it (you just have to delete the directory containing the virtualenv). However the user that did the installation will be the only one able to run Paperwork. No shortcut will be installed in the menus of your window manager. Paperwork won't be available directly on your PATH.

Requirements

You will have to install python-virtualenv.

Installation

$ virtualenv --system-site-packages paperwork-virtualenv
$ cd paperwork-virtualenv
$ source bin/activate
# you're now in a virtualenv
$ git clone https://github.com/jflesch/paperwork.git
$ cd paperwork
$ python ./setup.py install
# This script will install Paperwork and tell you if some extra dependencies
# are required
<install the extra dependencies>

Note regarding the extra dependencies

Many dependencies can't be installed from Pypi or in a virtualenv. For instance, all the libraries accessed through GObject introspection have no package on Pypi. This is why they can only be installed in a system-wide manner. The setup.py will indicate what is required and how to install it.

Running Paperwork

$ src/launcher.py

To restart paperwork:

$ cd paperwork-virtualenv
$ source bin/activate
$ cd paperwork
$ src/launcher.py

Enjoy :-)