add: keccaky lib

.github/ISSUE_TEMPLATE/feature_request.md

@@ -13,13 +13,13 @@ assignees: ""
 
 ## Describe what you expect! (Example)
 
-**I want Liby to work like this:**
+**I want keccaky to work like this:**
 
 ```py
-import liby
+import keccaky
 
 data = []
-result = liby.new_feature(data)
+result = keccaky.new_feature(data)
 
 assert result == ["new data very cool"]
 ```

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     hooks:
       - id: pytest
         name: Unit Tests (Pytest)
-        entry: pytest -m "not benchmark and not merkletreejs"
+        entry: pytest
         language: system
         pass_filenames: false
         always_run: true

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Lucas Oliveira
+Copyright (c) 2024 Lucas Oliveira
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,25 @@
-# Template for automatic library deployment in PyPi
+# Keccaky
 
-**RUN BEFORE COMMIT**
+Secure and easy-to-use keccak
+
+## Docs
+
+**INSTALL**
+
+```
+pip install keccaky
+```
 
 ```
-poetry install
-pre-commit install
+poetry add keccaky
 ```
+
+**USE**
+
+
+```python
+import keccak
+
+assert keccak("Hello, world") == bytes.fromhex("db99debe7fc546756227481ecaf5136f5b86180d99c5666a14421367c7187e5c")
+assert keccak("Hello, world").hex() == "db99debe7fc546756227481ecaf5136f5b86180d99c5666a14421367c7187e5c"
+```

pyproject.toml

@@ -1,15 +1,15 @@
 [tool.poetry]
-name = "liby"
-version = "0.2.0"
-description = "Template for automatic library deployment in PyPi"
+name = "keccaky"
+version = "0.1.0"
+description = "Secure and easy-to-use keccak"
 authors = ["Lucas Oliveira <[email protected]>"]
-repository = "https://github.com/olivmath/liby.git"
-documentation = "https://pypi.org/project/liby/"
+repository = "https://github.com/olivmath/keccaky.git"
+documentation = "https://pypi.org/project/keccaky/"
 readme = "README.md"
 license = "MIT"
-keywords = ["template", "lib", "python", "deploy", "pipeline"]
+keywords = ["keccak", "ethereum", "sha3", "hash"]
 classifiers = [
-    "Development Status :: 5 - Production/Stable",
+"Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
@@ -20,6 +20,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Security :: Cryptography"
 ]
 
 [tool.poetry.dependencies]

tests/test_version.py

@@ -1,5 +0,0 @@
-from liby import version
-
-
-def test_version():
-    version == "0.1.0"