1Installation
2============
3
4Installation can be done in various ways. The simplest form uses pip::
5
6    pip install rsa
7
8Depending on your system you may need to use ``sudo pip`` if you want to install
9the library system-wide, or use ``pip install --user rsa`` to install the
10library in your home directory.
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 is compatible with Python versions 3.5 and newer. The last
29version with Python 2.7 support was Python-RSA 4.0.
30
31Python-RSA has very few dependencies. As a matter of fact, to use it
32you only need Python itself. Loading and saving keys does require an
33extra module, though: pyasn1. If you used pip or easy_install like
34described above, you should be ready to go.
35
36
37Development dependencies
38------------------------
39
40In order to start developing on Python-RSA, use Git_ to get a copy of
41the source::
42
43    git clone https://github.com/sybrenstuvel/python-rsa.git
44
45Use Pipenv_ to install the development requirements in a virtual environment::
46
47    cd python-rsa
48    pipenv install --dev
49
50.. _Git: https://git-scm.com/
51.. _Pipenv: https://pipenv.pypa.io/en/latest/
52