Skip to content

Commit

Permalink
a couple more doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
oconnor663 committed Mar 4, 2020
1 parent 6cc11be commit ddfadd3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
@@ -1,9 +1,10 @@
# blake3-py [![Actions Status](https://github.com/oconnor663/blake3-py/workflows/tests/badge.svg)](https://github.com/oconnor663/blake3-py/actions) [![PyPI version](https://badge.fury.io/py/blake3.svg)](https://pypi.python.org/pypi/blake3)

Python bindings for the Rust [`blake3`](https://crates.io/crates/blake3)
crate, based on [PyO3](https://github.com/PyO3/pyo3). These bindings
expose all the features of BLAKE3, including extendable output, keying,
and multithreading.
Python bindings for the [official Rust implementation of
BLAKE3](https://github.com/BLAKE3-team/BLAKE3), based on
[PyO3](https://github.com/PyO3/pyo3). These bindings expose all the
features of BLAKE3, including extendable output, keying, and
multithreading.

**Caution:** This is a brand new library. Please expect some build
issues on platforms not covered by [CI
Expand Down
4 changes: 3 additions & 1 deletion src/lib.rs
Expand Up @@ -69,13 +69,15 @@ fn output_bytes(rust_hasher: &blake3::Hasher, length: u64, seek: u64) -> PyResul
Ok(output)
}

/// Python bindings for the Rust `blake3` crate. This module provides a single
/// Python bindings for the official Rust implementation of BLAKE3
/// (https://github.com/BLAKE3-team/BLAKE3). This module provides a single
/// function, also called `blake3.` The interface is similar to `hashlib` from
/// the standard library, which provides `blake2b`, `md5`, etc.
#[pymodule]
fn blake3(_: Python, m: &PyModule) -> PyResult<()> {
// The hasher wrapper type is private. Similar to other types in hashlib,
// it's only exposed through the `blake3()` constructor function.
/// An incremental BLAKE3 hasher.
#[pyclass]
struct Blake3Hasher {
rust_hasher: blake3::Hasher,
Expand Down

0 comments on commit ddfadd3

Please sign in to comment.