change to xof

GiacomoPope · Jul 28, 2024 · f2d59c3 · f2d59c3
1 parent b9a566e
commit f2d59c3
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 12 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
-name = "xof_py"
+name = "xof"
 version = "0.1.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
-name = "xof_py"
+name = "xof"
 crate-type = ["cdylib"]
 
 [dependencies]

diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ maturin develop --release
 You should now be able to use the package:
 
 ```py
->>> from xof_py import pyo3_shake_128
+>>> from xof import pyo3_shake_128
 >>> pyo3_shake_128(b"cryptohack", 100).hex()
 '8d043455562ebedd1b3fcf5b0e0a058091752d161e7eef40364a565aacb3b5d3bbefa804de6087e77c4c211ef57ab83869e3e18627f8421540ae9a8b61da847d0da513c56c5feba397ab2b4a1a2ef67c6f17162c8dfdb41901ad70bca8195fd35bcea259'
 ```

diff --git a/docs/api.rst b/docs/api.rst
@@ -4,4 +4,4 @@ API Documentation
 .. autosummary::
    :toctree: generated/
 
-   xof_py
+   xof
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,9 +1,9 @@
-.. xof_py documentation master file, created by
+.. xof documentation master file, created by
    sphinx-quickstart on Sat Jul 27 23:21:22 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to xof_py's documentation!
+Welcome to xof's documentation!
 ==================================
 
 .. toctree::

diff --git a/docs/xof_py.rst → docs/xof.rst b/docs/xof_py.rst → docs/xof.rst
@@ -4,7 +4,7 @@ xof\_py package
 Module contents
 ---------------
 
-.. automodule:: xof_py
+.. automodule:: xof
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["maturin>=1.7,<2.0"]
 build-backend = "maturin"
 
 [project]
-name = "xof_py"
+name = "xof"
 requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Rust",

diff --git a/src/lib.rs b/src/lib.rs
@@ -11,15 +11,15 @@ use sha3::{
 macro_rules! impl_sponge_shaker_classes {
     // hasher is tt so we can pick the right kind of methods to generate
     ($hasher:tt, $xof_reader:ident, $shaker_name:ident, $sponge_name:ident) => {
-        #[pyclass(module="xof_py")]
+        #[pyclass(module="xof")]
         #[doc=concat!(stringify!($shaker_name), " implements absorption and finalization for the ", stringify!($hasher), " XOF")]
         struct $shaker_name {
             hasher: $hasher,
         }
 
         impl_sponge_shaker_classes!(@shaker_methods $hasher, $shaker_name, $sponge_name);
 
-        #[pyclass(module="xof_py")]
+        #[pyclass(module="xof")]
         #[doc=concat!(stringify!($sponge_name), " implements sponge expansion for the ", stringify!($hasher), " XOF")]
         struct $sponge_name {
             xof: XofReaderCoreWrapper<$xof_reader>,
@@ -157,7 +157,7 @@ impl_sponge_shaker_classes!(
 
 /// A Python module implemented in Rust.
 #[pymodule]
-fn xof_py(m: &Bound<'_, PyModule>) -> PyResult<()> {
+fn xof(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_class::<Sponge128>()?;
     m.add_class::<Shaker128>()?;
     m.add_class::<Sponge256>()?;

diff --git a/xof_py.pyi → xof.pyi b/xof_py.pyi → xof.pyi
@@ -51,5 +51,11 @@ class TurboShaker256:
         ...
 
 class TurboSponge256:
+    """
+    Can you do doc strings here?
+    """
     def read(self, n: int) -> bytes:
+        """
+        Or here?
+        """
         ...
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,4 @@ API Documentation @@
     .. autosummary::
        :toctree: generated/
-       xof_py
+       xof