Skip to content

Commit 58c5944

Browse files
committed
Update Readme
Add note on citing, rename NICTA to Data61 in a few places.
1 parent 955f8c0 commit 58c5944

2 files changed

Lines changed: 21 additions & 11 deletions

File tree

README.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,30 @@ python-paillier |release|
99
| |reqM| |
1010
+---------------------+
1111

12-
A Python 3 library for Partially Homomorphic Encryption.
12+
A Python 3 library implementing the Paillier Partially Homomorphic Encryption.
1313

1414
The homomorphic properties of the paillier crypto system are:
1515

1616
- Encrypted numbers can be multiplied by a non encrypted scalar.
1717
- Encrypted numbers can be added together.
1818
- Encrypted numbers can be added to non encrypted scalars.
1919

20+
Citing
21+
======
22+
23+
`python-paillier` is designed, developed and supported by `CSIRO's Data61 <https://www.data61.csiro.au/>`__. If
24+
you use any part of this library in your research, please cite it using the following BibTex entry::
25+
26+
@misc{PythonPaillier,
27+
author = {CSIRO's Data61},
28+
title = {Python Paillier Library},
29+
year = {2013},
30+
publisher = {GitHub},
31+
journal = {GitHub Repository},
32+
howpublished = {\url{https://github.com/data61/python-paillier}},
33+
}
34+
35+
2036
Running unit tests
2137
------------------
2238

@@ -28,6 +44,7 @@ Or use nose::
2844

2945
nosetests
3046

47+
3148
Note related to gmpy2
3249
---------------------
3350

@@ -47,12 +64,6 @@ Developed at `Data61 | CSIRO <http://data61.csiro.au>`_.
4764
Parts derived from the Apache licensed Google project:
4865
https://code.google.com/p/encrypted-bigquery-client/
4966

50-
No audit
51-
--------
52-
53-
This code has neither been written nor vetted by any sort of crypto
54-
expert. The crypto parts are mercifully short, however.
55-
5667

5768
.. |release| image:: https://img.shields.io/pypi/v/phe.svg
5869
:target: https://pypi.python.org/pypi/phe/

phe/__about__.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77

88
__title__ = "phe"
99
__summary__ = "Partially Homomorphic Encryption library for Python"
10-
__uri__ = "https://github.com/n1analytics/python-paillier"
10+
__uri__ = "https://github.com/data61/python-paillier"
1111

1212
# We use semantic versioning - semver.org
1313
__version__ = "1.4.1-dev0"
1414

15-
__author__ = "N1 Analytics developers"
16-
__email__ = "info@n1analytics.com"
15+
__author__ = "CSIRO's Data61"
1716

1817
__license__ = "GPLv3"
19-
__copyright__ = "Copyright 2013-2018 {0}".format(__author__)
18+
__copyright__ = "Copyright 2013-2019 {0}".format(__author__)

0 commit comments

Comments
 (0)