| Sybren A. Stüvel | aa28c04 | 2011-07-30 23:48:00 +0200 | [diff] [blame] | 1 | Installation |
| 2 | ================================================== |
| 3 | |
| 4 | Installation can be done in various ways. The simplest form uses pip |
| 5 | or easy_install. Either one will work:: |
| 6 | |
| 7 | pip install rsa |
| 8 | easy_install rsa |
| 9 | |
| 10 | Depending on your system you may need to use ``sudo pip`` or ``sudo |
| 11 | easy_install``. |
| 12 | |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 13 | Installation from source is also quite easy. Download the source and |
| 14 | then type:: |
| Sybren A. Stüvel | aa28c04 | 2011-07-30 23:48:00 +0200 | [diff] [blame] | 15 | |
| Sybren A. Stüvel | a3fd61a | 2011-07-31 00:22:31 +0200 | [diff] [blame] | 16 | python setup.py install |
| 17 | |
| 18 | or if that doesn't work:: |
| 19 | |
| 20 | sudo python setup.py install |
| 21 | |
| 22 | |
| 23 | .. todo:: |
| 24 | |
| 25 | Add a source link here |
| 26 | |
| 27 | |
| 28 | Dependencies |
| 29 | -------------------------------------------------- |
| 30 | |
| 31 | Python-RSA has very few dependencies. As a matter of fact, to use it |
| 32 | you only need Python itself. Loading and saving keys does require an |
| 33 | extra module, though: pyasn1. If you used pip or easy_install like |
| 34 | described above, you should be ready to go. |
| 35 | |
| 36 | Development dependencies |
| 37 | -------------------------------------------------- |
| 38 | |
| 39 | In order to start developing on Python-RSA you need a bit more. Use |
| 40 | pip or easy_install to install the following packages: |
| 41 | |
| 42 | - Mercurial |
| 43 | - nose |
| 44 | - sphinx |
| 45 | - pyasn1 |
| 46 | |
| 47 | Once these are installed, use Mercurial_ to get a copy of the source:: |
| 48 | |
| 49 | hg clone http://hg.stuvel.eu/python-rsa |
| 50 | sudo python setup.py develop |
| 51 | |
| 52 | |
| 53 | .. _Mercurial: http://hg-scm.com/ |