Skip to content

update readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
escherba merged 1 commit into from
Dec 29, 2021
Merged

update readme #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,11 @@ To use this package in your program, simply type
After that, you should be able to import the module and do things with it (see
Example Usage below).

Example Usage
-------------
Usage Examples
--------------

Simple Hashing
~~~~~~~~~~~~~~

This package provides Python interfaces to 64- and 128-bit implementations of
MetroHash algorithm. For stateless hashing, it exports ``metrohash64`` and
Expand All @@ -46,6 +49,9 @@ unicode) and an optional ``seed`` parameter:
182995299641628952910564950850867298725


Incremental Hashing
~~~~~~~~~~~~~~~~~~~

For incremental hashing, use ``MetroHash64`` and ``MetroHash128`` classes.
Incremental hashing is associative and guarantees that any combination of input
slices will result in the same final hash value. This is useful for processing
Expand All @@ -69,7 +75,7 @@ Note that the resulting hash value above is the same as in:
7851180100622203313

Buffer Protocol Support
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~

The methods in this module support Python `Buffer Protocol
<https://docs.python.org/3/c-api/buffer.html>`__, which allows them to be used
Expand Down
20 changes: 5 additions & 15 deletions pip-freeze.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,19 @@
attrs==21.3.0
backcall==0.2.0
Cython==0.29.26
decorator==5.1.0
distlib==0.3.4
filelock==3.4.2
importlib-metadata==4.10.0
iniconfig==1.1.1
ipython==7.30.1
jedi==0.18.1
matplotlib-inline==0.1.3
-e git+https://github.com/escherba/python-metrohash@d3f96245c18e7e3724b8e8c8c211ff5c524beed0#egg=metrohash
-e git+https://github.com/escherba/python-metrohash@5b2b36b09262853950816ff3852ebda5a8c2779c#egg=metrohash
numpy==1.21.5
packaging==21.3
parso==0.8.3
pexpect==4.8.0
pickleshare==0.7.5
platformdirs==2.4.1
pluggy==1.0.0
prompt-toolkit==3.0.24
ptyprocess==0.7.0
py==1.11.0
Pygments==2.10.0
pyparsing==3.0.6
pytest==6.2.5
six==1.16.0
toml==0.10.2
traitlets==5.1.1
virtualenv==20.11.0
wcwidth==0.2.5
typing_extensions==4.0.1
virtualenv==20.11.1
zipp==3.6.0
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def is_pure(self):
)


VERSION = '0.1.0.post0'
VERSION = '0.1.0.post1'
URL = "https://github.com/escherba/python-metrohash"


Expand Down
22 changes: 11 additions & 11 deletions src/metrohash.cpp
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/metrohash.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Python wrapper for MetroHash, a fast non-cryptographic hashing algorithm

__author__ = "Eugene Scherba"
__email__ = "escherba+metrohash@gmail.com"
__version__ = "0.1.0.post0"
__version__ = "0.1.0.post1"
__all__ = [
"metrohash64",
"metrohash128",
Expand Down