How to install configglue¶
This document will get you up and running with configglue.
Install Python¶
Being a Python library, configglue requires Python.
It works with any Python version from 2.6 to 2.7 (due to backwards incompatibilities in Python 3.0, configglue does not currently work with Python 3.0; see the configglue FAQ for more information on supported Python versions and the 3.0 transition).
Get Python at http://www.python.org. If you’re running Linux or Mac OS X, you probably already have it installed.
Remove any old versions of configglue¶
If you are upgrading your installation of configglue from a previous version, you will need to uninstall the old configglue version before installing the new version.
If you installed configglue using setup.py install, uninstalling is as simple as deleting the configglue directory from your Python site-packages.
If you installed configglue from a Python egg, remove the configglue .egg file, and remove the reference to the egg in the file named easy-install.pth. This file should also be located in your site-packages directory.
Where are my site-packages stored?
The location of the site-packages directory depends on the operating system, and the location in which Python was installed. To find out your system’s site-packages location, execute the following:
python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"
(Note that this should be run from a shell prompt, not a Python interactive prompt.)
Install the configglue code¶
Installation instructions are slightly different depending on whether you’re installing a distribution-specific package, downloading the latest official release, or fetching the latest development version.
It’s easy, no matter which way you choose.
Installing a distribution-specific package¶
Check the distribution specific notes to see if your platform/distribution provides official configglue packages/installers. Distribution-provided packages will typically allow for automatic installation of dependencies and easy upgrade paths.
Installing an official release¶
- Download the latest release from our download page.
- Untar the downloaded file (e.g. tar xzvf configglue-NNN.tar.gz, where NNN is the version number of the latest release). If you’re using Windows, you can download the command-line tool bsdtar to do this, or you can use a GUI-based tool such as 7-zip.
- Change into the directory created in step 2 (e.g. cd configglue-NNN).
- If you’re using Linux, Mac OS X or some other flavor of Unix, enter the command sudo python setup.py install at the shell prompt. If you’re using Windows, start up a command shell with administrator privileges and run the command setup.py install.
These commands will install configglue in your Python installation’s site-packages directory.
Installing the development version¶
Tracking configglue development
If you decide to use the latest development version of configglue, you’ll want to pay close attention to the changes made on trunk, until we manage to implement a better way of notifying about changes being made. This will help you stay on top of any new features you might want to use, as well as any changes you’ll need to make to your code when updating your copy of configglue. (For stable releases, any necessary changes are documented in the release notes.)
If you’d like to be able to update your configglue code occasionally with the latest bug fixes and improvements, follow these instructions:
Make sure that you have Bazaar installed, and that you can run its commands from a shell. (Enter bzr help at a shell prompt to test this.)
Check out configglue’s main development branch (the ‘trunk’) like so:
bzr branch lp:configglue configglue-trunk
Next, make sure that the Python interpreter can load configglue’s code. The most convenient way to do this is to use setuptools’ develop target. For example, on a Unix-like system:
cd configglue-trunk python setup.py develop
When you want to update your copy of the configglue source code, just run the command bzr pull from within the configglue-trunk directory. When you do this, Bazaar will automatically download any changes.