Merge branch 'release/0.4.1'

.travis.yml

@@ -1,5 +1,9 @@
+os:
+  - linux
+  - osx
 language: python
 python:
+  - "3.6"
   - "3.5"
   - "3.4"
   - "3.3"
@@ -9,38 +13,50 @@ python:
 matrix:
   include:
     # add a pep8 test
-    - python: 3.5
+    - python: 3.6
       env: TOXENV=pep8
+
     # test setup.py using each tested version
+    - python: 3.6
+      env: TOXENV=setup36
+
     - python: 3.5
       env: TOXENV=setup35
+
     - python: 3.4
       env: TOXENV=setup34
+
     - python: 3.3
       env: TOXENV=setup33
+
     - python: 2.7
       env: TOXENV=setup27
+
   allow_failures:
     # pep8 failures shouldn't be considered fatal
     - env: TOXENV=pep8
     # pypy and pypy3 tests are just for fun
     - python: "pypy"
     - python: "pypy3"
+    # osx, until it's working
+    - os: osx
+
 # install requirements
 install:
-  # make sure libffi-dev, gnupg2, and pgpdump are installed
-  - sudo apt-get update
-  - sudo apt-get install -y libffi-dev gnupg2 pgpdump
+  - ./install_dependencies.${TRAVIS_OS_NAME}.sh
   # ensure tox and coveralls are installed
   - pip install tox python-coveralls
+
 # set TOXENV if it isn't yet
 before_script:
   - if [[ -z "$TOXENV" ]]; then export TOXENV=py${TRAVIS_PYTHON_VERSION//.}; fi
-  - if [[ "$TRAVIS_PYTHON_VERSION" == 'pypy' ]]; then export TOXENV=pypy; fi
-  - if [[ "$TRAVIS_PYTHON_VERSION" == 'pypy3' ]]; then export TOXENV=pypy3; fi
+  - if [[ "${TRAVIS_PYTHON_VERSION}" == 'pypy' ]]; then export TOXENV=pypy; fi
+  - if [[ "${TRAVIS_PYTHON_VERSION}" == 'pypy3' ]]; then export TOXENV=pypy3; fi
+
 # run tox
 script:
   - ./tox.sh
+
 # and report coverage to coveralls, but only if this was a pytest run
 after_success:
   - if [[ "${TOXENV}" == "py"* ]]; then coveralls; fi

README.rst

@@ -38,12 +38,19 @@ Documentation
 
 `PGPy Documentation <https://pythonhosted.org/PGPy/>`_
 
+Discussion
+----------
+
+Please report any bugs found on the `issue tracker <https://github.com/SecurityInnovation/PGPy/issues>`_
+
+You can also join ``#pgpy`` on Freenode to ask questions or get involved
+
 Requirements
 ------------
 
 - Python 3 >= 3.3; Python 2 >= 2.7
 
-  Tested with: 3.5, 3.4, 3.3, 2.7
+  Tested with: 3.6, 3.5, 3.4, 3.3, 2.7
 
 - `Cryptography <https://pypi.python.org/pypi/cryptography>`_
 
@@ -59,3 +66,4 @@ License
 -------
 
 BSD 3-Clause licensed. See the bundled `LICENSE <https://github.com/SecurityInnovation/PGPy/blob/master/LICENSE>`_ file for more details.
+

docs/source/api/classes.rst → docs/source/api/classes.rst.inc

@@ -8,16 +8,13 @@ Classes
 
 .. autoclass:: PGPKey
     :members:
-    :noindex:
 
     .. py:attribute:: ascii_header
-        :noindex:
         :annotation: = OrderedDict([('Version', 'PGPy v|version|')])
 
         An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
 
     .. py:classmethod:: from_file(filename)
-        :noindex:
 
         Create a new :py:obj:`PGPKey` object, with contents loaded from a file. May be binary or ASCII armored.
 
@@ -32,7 +29,6 @@ Classes
                     # others: { (Fingerprint, bool(key.is_public): PGPKey }
 
     .. py:classmethod:: from_blob(blob)
-        :noindex:
 
         Create a new :py:obj:`PGPKey` object, with contents loaded from a blob. May be binary or ASCII armored.
 
@@ -55,7 +51,6 @@ Classes
     :members:
 
     .. py:attribute:: ascii_header
-        :noindex:
 
         An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
 
@@ -67,12 +62,10 @@ Classes
     :members:
 
     .. py:attribute:: ascii_header
-        :noindex:
 
         An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
 
     .. py:classmethod:: from_file(filename)
-        :noindex:
 
         Create a new :py:obj:`PGPMessage` object, with contents loaded from a file. May be binary or ASCII armored.
 
@@ -83,7 +76,6 @@ Classes
         :returns: :py:obj:`PGPMessage`
 
     .. py:classmethod:: from_blob(blob)
-        :noindex:
 
         Create a new :py:obj:`PGPMessage` object, with contents loaded from a blob. May be binary or ASCII armored.
 
@@ -102,12 +94,10 @@ Classes
     :members:
 
     .. py:attribute:: ascii_header
-        :noindex:
 
         An :py:obj:`~collections.OrderedDict` of headers that appear, in order, in the ASCII-armored form of this object.
 
     .. py:classmethod:: from_file(filename)
-        :noindex:
 
         Create a new :py:obj:`PGPSignature` object, with contents loaded from a file. May be binary or ASCII armored.
 
@@ -118,7 +108,6 @@ Classes
         :returns: :py:obj:`PGPSignature`
 
     .. py:classmethod:: from_blob(blob)
-        :noindex:
 
         Create a new :py:obj:`PGPSignature` object, with contents loaded from a blob. May be binary or ASCII armored.