lists.arthurdejong.org
RSS feed

python-pskc branch master updated. 0.3-7-ga86ff8a

[Date Prev][Date Next] [Thread Prev][Thread Next]

python-pskc branch master updated. 0.3-7-ga86ff8a



This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "python-pskc".

The branch, master has been updated
       via  a86ff8aa50beea7d1e879a12788d7cfd992a7120 (commit)
      from  0ff41549a8a316e5577a5cd01f0bcc679943910e (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
http://arthurdejong.org/git/python-pskc/commit/?id=a86ff8aa50beea7d1e879a12788d7cfd992a7120

commit a86ff8aa50beea7d1e879a12788d7cfd992a7120
Author: Arthur de Jong <arthur@arthurdejong.org>
Date:   Mon Dec 28 12:11:55 2015 +0100

    Update some documentation
    
    This adds a development notes section to the README and changes the
    wording on the encryption page.

diff --git a/README b/README
index 7dd7ea0..619fe2c 100644
--- a/README
+++ b/README
@@ -60,3 +60,12 @@ You should have received a copy of the GNU Lesser General 
Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 02110-1301 USA
+
+
+Development notes
+-----------------
+
+This package should use a mostly standard source code layout and support both
+Python 2 (2.6 but 2.7 is recommended) and Python 3 (most recent versions
+should work). The tests can be run with nosetests and the aim is to have
+maximum code coverage.
diff --git a/docs/encryption.rst b/docs/encryption.rst
index 768a3f4..0d5cf3e 100644
--- a/docs/encryption.rst
+++ b/docs/encryption.rst
@@ -3,9 +3,9 @@ PSKC encryption
 
 .. module:: pskc.encryption
 
-The keys (and some embedded data) in PSKC files can be encrypted with either
-pre-shared keys, passphrase-based keys or asymmetric keys (asymmetric keys
-are currently unimplemented).
+Some of the information in PSKC files (e.g. key material) can be encrypted
+with either pre-shared keys, passphrase-based keys or asymmetric keys
+(asymmetric keys are currently unimplemented).
 
 Embedded PSKC encryption is handled inside the :class:`Encryption` class that
 defines encryption key or means of deriving keys. It is accessed from the
@@ -23,7 +23,7 @@ or::
 Once the encryption key has been set up, any encrypted key values from the
 PSKC file are available transparently.
 
-If an incorrect key has been set up, upon accessing encrypted
+If no key or an incorrect key has been set configured, upon accessing encrypted
 information (e.g. the :attr:`~pskc.key.Key.secret` attribute of a
 :class:`~pskc.key.Key` instance) a :exc:`~pskc.exceptions.DecryptionError`
 exception will be raised.

-----------------------------------------------------------------------

Summary of changes:
 README              | 9 +++++++++
 docs/encryption.rst | 8 ++++----
 2 files changed, 13 insertions(+), 4 deletions(-)


hooks/post-receive
-- 
python-pskc
-- 
To unsubscribe send an email to
python-pskc-commits-unsubscribe@lists.arthurdejong.org or see
http://lists.arthurdejong.org/python-pskc-commits/