• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Installation
2============
3
4Installation can be done in various ways. The simplest form uses pip
5or easy_install. Either one will work::
6
7    pip install rsa
8
9Depending on your system you may need to use ``sudo pip`` if you want to install
10the library system-wide.
11
12Installation from source is also quite easy. Download the source and
13then type::
14
15    python setup.py install
16
17
18The sources are tracked in our `Git repository`_ at
19GitHub. It also hosts the `issue tracker`_.
20
21.. _`Git repository`: https://github.com/sybrenstuvel/python-rsa.git
22.. _`issue tracker`: https://github.com/sybrenstuvel/python-rsa/issues
23
24
25Dependencies
26------------
27
28Python-RSA has very few dependencies. As a matter of fact, to use it
29you only need Python itself. Loading and saving keys does require an
30extra module, though: pyasn1. If you used pip or easy_install like
31described above, you should be ready to go.
32
33
34Development dependencies
35------------------------
36
37In order to start developing on Python-RSA you need a bit more. Use
38pip to install the development requirements in a virtual environment::
39
40    virtualenv -p /path/to/your-python-version python-rsa-venv
41    . python-rsa-venv/bin/activate
42    pip install -r python-rsa/requirements.txt
43
44
45Once these are installed, use Git_ to get a copy of the source::
46
47    git clone https://github.com/sybrenstuvel/python-rsa.git
48    python setup.py develop
49
50.. _Git: https://git-scm.com/
51