camelcase changed to snakecase for methods & variables.readme updated

Author: Aviksaikat

README.md

@@ -30,7 +30,7 @@
 <img src="https://img.shields.io/github/languages/top/Aviksaikat/swarm-cid-py?style=for-the-badge&color=DEDE17" alt="GitHub top language" />
 </div>
 
-______________________________________________________________________
+---
 
 ## 📖 Table of Contents
 
@@ -43,15 +43,15 @@ ______________________________________________________________________
 - [🤝 Contributing](#-contributing)
 - [📄 License](#-license)
 
-______________________________________________________________________
+---
 
 ## 📍 Api
 
 Utility library written in Python to convert Swarm hex references into Swarm CIDs.
 
 The swarm-cid library provides the following functions:
 
-`encodeReference(reference, type, version)`
+`encode_reference(reference, type, version)`
 
 Encodes a reference string into a CID.
 
@@ -60,7 +60,7 @@ Encodes a reference string into a CID.
 - version: The version of the CID (either 1 or 2).
   Returns a CID string.
 
-`decodeCid(cid)`
+`decode_cid(cid)`
 
 Decodes a CID string into a dictionary containing information about the underlying data.
 
@@ -72,34 +72,34 @@ following keys:
 - reference: The reference string extracted from the CID.
 - type: The type of the reference (either ReferenceType.MANIFEST or ReferenceType.FEED).
 
-`decodeFeedCid(cid)`
+`decode_feed_cid(cid)`
 
 Decodes a CID string into a feed reference string.
 
 - cid: The CID string to decode.
   Returns a feed reference string.
 
-`decodeManifestCid(cid)`
+`decode_manifest_cid(cid)`
 
 Decodes a CID string into a manifest reference string.
 
 - cid: The CID string to decode.
   Returns a manifest reference string.
 
-`encodeFeedReference(reference)`
+`encode_feed_reference(reference)`
 
 Encodes a feed reference string into a CID.
 
 - reference: The feed reference string to encode.
   Returns a CID string.
 
-`encodeManifestReference(reference)`
+`encode_manifest_reference(reference)`
 
 Encodes a manifest reference string into a CID.
 
 - reference: The manifest reference string to encode.
 
-______________________________________________________________________
+---
 
 ## 🚀 Getting Started
 
@@ -109,39 +109,39 @@ ______________________________________________________________________
 py-multiformats-cid
 ```
 
-______________________________________________________________________
+---
 
 ### 🔧 Installation
 
 ```sh
 pip install swarm_cid_py
 ```
 
-______________________________________________________________________
+---
 
 ### 🤖 Running swarm-cid-py
 
 ```py
->>> from swarm_cid import encodeReference, decodeCid
+>>> from swarm_cid import encode_reference, decode_cid
 >>> reference = "4c949794d617238d928ef1dc544ee07cbdcfd6b946e5202fa06c4d32088d7e69"
->>> cid = encodeReference(reference, ReferenceType.MANIFEST, 1)
+>>> cid = encode_reference(reference, ReferenceType.MANIFEST, 1)
 >>> print(str(cid))
 bah5acgzajskjpfgwc4ry3euo6hofitxaps647vvzi3ssal5anrgtecenpzuq
->>> decoded_cid = decodeCid(cid)
+>>> decoded_cid = decode_cid(cid)
 >>> print(decoded_cid.to_dict())
 {'reference':
 '4c949794d617238d928ef1dc544ee07cbdcfd6b946e5202fa06c4d32088d7e69', 'type': 'manifest'}
 ```
 
-______________________________________________________________________
+---
 
 ### 🧪 Tests
 
 ```sh
 pytest tests/test_swarm_cid.py
 ```
 
-______________________________________________________________________
+---
 
 ## 🤝 Contributing
 
@@ -180,12 +180,12 @@ Once your PR is reviewed and approved, it will be merged into the main branch.
 
 </details>
 
-______________________________________________________________________
+---
 
 ## 📄 License
 
 This project is protected under the [BSD-3-Clause](./LICENSE) License.
 
 [**Return**](#Top)
 
-______________________________________________________________________
+---

poetry.lock

@@ -1,16 +1,18 @@
 [tool.poetry]
 name = "swarm-cid-py"
-version = "0.1.0"
+version = "0.1.2"
 description = "Utility library written in Python to convert Swarm hex references into Swarm CIDs"
 authors = ["SAIKAT KARMAKAR <saikickkarma@protonmail.com>"]
 readme = "README.md"
+license = "AGPL-3.0-or-later"
 packages = [{ include = "swarm_cid", from = "src" }]
+homepage = "https://github.com/Aviksaikat/swarm-cid-py"
 
 [tool.poetry.dependencies]
 python = "^3.9"
 py-multiformats-cid = "^0.4.4"
 multiformats-fix = "^0.2.2"
-pysha3 = "^1.0.2"
+safe-pysha3 = "^1.0.4"
 
 [tool.poetry.group.lint.dependencies]
 black = "^23.11.0"
@@ -28,6 +30,7 @@ mdformat = "^0.7.17"
 mdformat-gfm = "^0.3.5"
 mdformat-frontmatter = "^0.4.1"
 mdformat-pyproject = "^0.0.1"
+flake8-pyproject = "^1.2.3"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"
@@ -67,7 +70,12 @@ number = true
 module = "eth_keys.*"
 ignore_missing_imports = true
 
-# * not working so defined in setup.cfg
-# [tool.flake8]
-# line-length = 100
-# exclude = ["__pycache__", ".venv/*"]
+# flake8
+[tool.flake8]
+max-line-length = 100
+ignore = ["E203", "W503"]
+exclude = ["__pycache__", ".venv/*", "docs/*"]
+docstring-convention = "google"
+
+[tool.mypy]
+ignore_missing_imports = true