| 1 | Stamper - installation instructions
 | 
|---|
| 2 | ===================================
 | 
|---|
| 3 | 
 | 
|---|
| 4 | .. contents::
 | 
|---|
| 5 | 
 | 
|---|
| 6 | First, install dependencies
 | 
|---|
| 7 | ---------------------------
 | 
|---|
| 8 | 
 | 
|---|
| 9 | So far, the only dependency you will need in order to run stamper is Python [1]_
 | 
|---|
| 10 | 
 | 
|---|
| 11 | Stamper has been tested with python *2.7.x*, but it should work with versions
 | 
|---|
| 12 | *2.6.x* too.
 | 
|---|
| 13 | 
 | 
|---|
| 14 | Please, refer to your operating system package system documentation to learn
 | 
|---|
| 15 | more about how to install python.
 | 
|---|
| 16 | 
 | 
|---|
| 17 | 
 | 
|---|
| 18 | Second, install Stamper
 | 
|---|
| 19 | -----------------------
 | 
|---|
| 20 | 
 | 
|---|
| 21 | Installing using pip/easy_install
 | 
|---|
| 22 | +++++++++++++++++++++++++++++++++
 | 
|---|
| 23 | 
 | 
|---|
| 24 | You can install Stamper using pip [2]_::
 | 
|---|
| 25 | 
 | 
|---|
| 26 |   pip install Stamper
 | 
|---|
| 27 | 
 | 
|---|
| 28 | or easy_install [3]_::
 | 
|---|
| 29 | 
 | 
|---|
| 30 |   easy_install Stamper
 | 
|---|
| 31 | 
 | 
|---|
| 32 | Installing from sources
 | 
|---|
| 33 | +++++++++++++++++++++++
 | 
|---|
| 34 | 
 | 
|---|
| 35 | Releases
 | 
|---|
| 36 | ********
 | 
|---|
| 37 | 
 | 
|---|
| 38 | There are no releases yet. You will have to install it from the repository.
 | 
|---|
| 39 | 
 | 
|---|
| 40 | From repository
 | 
|---|
| 41 | ***************
 | 
|---|
| 42 | 
 | 
|---|
| 43 | The source code of Stamper is hosted in bitbucket [4]_. In order to grab
 | 
|---|
| 44 | the latest sources you need Mercurial [5]_.
 | 
|---|
| 45 | 
 | 
|---|
| 46 | To get a copy of the sources, just *clone* the repository::
 | 
|---|
| 47 | 
 | 
|---|
| 48 |   hg clone https://bitbucket.org/codigo23/stamper stamper-repo
 | 
|---|
| 49 | 
 | 
|---|
| 50 | Then, go inside the *stamper-repo* directory and run::
 | 
|---|
| 51 | 
 | 
|---|
| 52 |   python setup.py install
 | 
|---|
| 53 | 
 | 
|---|
| 54 | .. warning::
 | 
|---|
| 55 | 
 | 
|---|
| 56 |    If you want to install it *system-wide*, probably you will need *root*
 | 
|---|
| 57 |    privileges (check your OS documentation to learn more about how to get
 | 
|---|
| 58 |    *root* privileges - for example using sudo [6]_)
 | 
|---|
| 59 | 
 | 
|---|
| 60 | You can also install it in *development mode*, which allow you to test the
 | 
|---|
| 61 | software and make changes to the sources, those changes will be available
 | 
|---|
| 62 | instantly for using/testing::
 | 
|---|
| 63 | 
 | 
|---|
| 64 |   python setup.py develop
 | 
|---|
| 65 | 
 | 
|---|
| 66 | 
 | 
|---|
| 67 | .. [1] http://python.org
 | 
|---|
| 68 | .. [2] http://www.pip-installer.org/en/latest/index.html
 | 
|---|
| 69 | .. [3] http://peak.telecommunity.com/DevCenter/EasyInstall
 | 
|---|
| 70 | .. [4] https://bitbucket.org/codigo23/stamper
 | 
|---|
| 71 | .. [5] http://mercurial.selenic.com
 | 
|---|
| 72 | .. [6] http://sudo.ws
 | 
|---|