Skip to content

Commit aa28c04

Browse files
committed
More documentation
1 parent 6ef2262 commit aa28c04

4 files changed

Lines changed: 54 additions & 0 deletions

File tree

doc/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,22 @@
66
Welcome to Python-RSA's documentation!
77
======================================
88

9+
Python-RSA is a pure-Python RSA implementation. It supports
10+
encryption and decryption, signing and verifying signatures, and key
11+
generation according to PKCS#1 version 1.5.
12+
913
Contents:
1014

1115
.. toctree::
1216
:maxdepth: 2
1317

18+
intro
19+
installation
20+
license
21+
usage
22+
compatibility
23+
24+
1425
Indices and tables
1526
==================
1627

doc/installation.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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+
13+

doc/intro.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Introduction
2+
==================================================
3+
4+
Python-RSA's history starts in 2006. As a student assignment for the
5+
University of Amsterdam we wrote a RSA implementation. We chose Python
6+
for various reasons; one of the most important reasons was the
7+
`unlimited precision integer`_ support.
8+
9+
.. _`unlimited precision integer`: http://docs.python.org/library/stdtypes.html#numeric-types-int-float-long-complex
10+
11+
It started out as just a module for calculating large primes, and RSA
12+
encryption, decryption, signing and verification using those large
13+
numbers. It also included generating public and private keys. There
14+
was no functionality for working with byte sequences (such as files)
15+
yet.
16+
17+
.. TODO:: write more history
18+
19+

doc/usage.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Usage
2+
==================================================
3+
4+
5+
.. toctree::
6+
7+
keygen
8+
simple_enc_dec
9+
sign_verify
10+
big_files
11+

0 commit comments

Comments
 (0)