Permalink
Browse files

Update module metadata (__all__ etc).

  • Loading branch information...
1 parent 0ccd936 commit 8d4dbda204db43959f68fab7e21c4cbf6b5da58a @bjornedstrom committed Oct 3, 2012
Showing with 15 additions and 0 deletions.
  1. +15 −0 sha3/__init__.py
View
@@ -1,6 +1,20 @@
# -*- coding: utf-8 -*-
# Copyright (c) Björn Edström <be@bjrn.se> 2012. See LICENSE for more details.
+r"""hashlib-style implementation of SHA-3 winner Keccak.
+
+This module implements SHA-3 with a haslib interface. Four classes are exposed:
+SHA3224, SHA3256, SHA3384 and SHA3512. Usage should be familiar:
+
+>>> s = SHA3512()
+>>> s.update('abc')
+>>> print s.hexdigest()
+"""
+
+__all__ = ['SHA3224', 'SHA3256', 'SHA3384', 'SHA3512']
+__version__ = '0.1beta'
+__author__ = 'Bjorn Edstrom <be@bjrn.se>'
+
import _sha3
import copy
@@ -38,6 +52,7 @@ def digestsize(self):
@property
def block_size(self):
+ # TODO (bjorn): Return something reasonable.
raise NotImplementedError('block size not exposed')

0 comments on commit 8d4dbda

Please sign in to comment.