| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 1 | ============ |
| 2 | Installation |
| 3 | ============ |
| 4 | |
| 5 | For Debian users (including Ubuntu) |
| 6 | ----------------------------------- |
| 7 | |reclass| has been `packaged for Debian`_. To use it, just install it with |
| 8 | APT:: |
| 9 | |
| 10 | $ apt-get install reclass |
| 11 | |
| 12 | .. _packaged for Debian: http://packages.debian.org/search?keywords=reclass |
| 13 | |
| 14 | Other distributions |
| 15 | ------------------- |
| 16 | Developers of other distributions are cordially invited to package |reclass| |
| 17 | themselves and `ping me <mailto:reclass@pobox.madduck.net>`_ to have details |
| 18 | included here. Or send a patch! |
| 19 | |
| 20 | From source |
| 21 | ----------- |
| 22 | |reclass| is currently maintained `on Github |
| 23 | <http://github.com/madduck/reclass>`_, so to obtain the source, run:: |
| 24 | |
| 25 | $ git clone https://github.com/madduck/reclass.git |
| 26 | |
| 27 | or:: |
| 28 | |
| 29 | $ git clone ssh://git@github.com:madduck/reclass.git |
| 30 | |
| 31 | Before you can use |reclass|, you need to install it into a place where Python |
| 32 | can find it. Unless you installed a package from your distribution, the |
| 33 | following step should install the package to /usr/local:: |
| 34 | |
| 35 | $ python setup.py install |
| 36 | |
| 37 | If you want to install to a different location, use --prefix like so:: |
| 38 | |
| 39 | $ python setup.py install --prefix=/opt/local |
| 40 | |
| 41 | Just make sure that the destination is in the Python module search path, which |
| 42 | you can check like this:: |
| 43 | |
| 44 | $ python -c 'import sys; print sys.path' |
| 45 | |
| 46 | More options can be found in the output of |
| 47 | |
| 48 | :: |
| 49 | |
| 50 | $ python setup.py install --help |
| 51 | $ python setup.py --help |
| 52 | $ python setup.py --help-commands |
| 53 | $ python setup.py --help [cmd] |
| 54 | |
| 55 | If you just want to run |reclass| from source, e.g. because you are going to be |
| 56 | making and testing changes, install it in "development mode":: |
| 57 | |
| 58 | $ python setup.py develop |
| 59 | |
| 60 | To uninstall (the rm call is necessary due to `a bug in setuptools`_):: |
| 61 | |
| 62 | $ python setup.py develop --uninstall |
| 63 | $ rm /usr/local/bin/reclass* |
| 64 | |
| 65 | `Uninstallation currently isn't possible`_ for packages installed to |
| 66 | /usr/local as per the above method, unfortunately. The following should do:: |
| 67 | |
| 68 | $ rm -r /usr/local/lib/python*/dist-packages/reclass* /usr/local/bin/reclass* |
| 69 | |
| 70 | .. _a bug in setuptools: http://bugs.debian.org/714960 |
| 71 | .. _Uninstallation currently isn't possible: http://bugs.python.org/issue4673 |
| 72 | |
| 73 | .. include:: substs.inc |