diff options
| -rw-r--r-- | CONTRIBUTING.rst | 17 | ||||
| -rw-r--r-- | README.rst | 6 |
2 files changed, 18 insertions, 5 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ff1a619c..3ee89b80 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -10,6 +10,13 @@ Code When in doubt, refer to `PEP 8`_ for Python code. +Every code file must start with the boilerplate notice of the Apache License. +Additionally, every Python code file must contain + +.. code-block:: python + + from __future__ import absolute_import, division, print_function + Docs ==== @@ -17,12 +24,12 @@ Write docstrings like this: .. code-block:: python - def some_function(some_arg): - """ - Does some things. + def some_function(some_arg): + """ + Does some things. - :param some_arg: Some argument. - """ + :param some_arg: Some argument. + """ So, specifically: @@ -13,9 +13,15 @@ recipes to Python developers. It is currently in early development and isn't recommended for general usage yet. It targets Python 2.6-2.7, Python 3.2+, as well as PyPy. +You can find more documentation at `Read The Docs`_. + +.. _`Read The Docs`: https://cryptography.readthedocs.org/ + + Why a new crypto library for Python? ------------------------------------ None of the existing ones work on PyPy, and many of them are unmaintained or are based around very poor implementations of algorithms (i.e ones with known side-channel attacks). + |