To install clans, you’ll need the following:
- A Unix-like operating system (e.g. Linux or Mac OS X)
- Python 2.6+ or 3.3+ (usually preinstalled)
- The pip installer
In addition, clans will only work with Plans accounts that are set to use the postmodern interface.
Most people will want to use the latest stable release. This installs clans and its dependencies:
$ pip install clans
If a newer version is available later, update to it with:
$ pip install --upgrade clans
$ pip uninstall clans
Clans development is versioned using Git. To clone the repository and install it in a single step:
$ pip install -e git+https://github.com/baldwint/clans.git#egg=clans
This installs clans in editable mode - it clones the repository into your
src directory and configures Python to load it from there.
$ mkvirtualenv clans
and then do the installation step. Then the repository would be
~/.virtualenvs/clans/src/clans, but the installation
is only active if I first activate the virtualenv using
As an optional step, install extra dependencies for testing and documentation:
$ cd ~/.virtualenvs/clans/src/clans $ pip install -e .[docs,tests]
Getting updates and sharing improvements¶
To get updates,
cd to the repository and do:
$ git pull
You can make your own modifications to clans by editing the Python source code in the repository. If you like, you can commit your changes using Git and contribute them back to the project.
The first step is to publish your modifications. To do this, fork the project on GitHub and add it as a remote in your local copy:
$ git remote add myfork https://github.com/your_username/clans.git
Now you can publish changes you made locally using
git push myfork
master (although it is often a good idea to work in branches other
master). To submit your changes for review, open a pull
request on GitHub.