Migrate to py-cid v0.4.0: Update dependencies (#54)

* Migrate to py-cid v0.4.0: Update dependencies and migrate base58 to py-multicodec

- Update dependencies: py-multibase>=2.0.0, py-multicodec>=1.0.0, py-multihash>=3.0.0
- Remove local base58 module and migrate to py-multicodec's b58encode/b58decode
- Update version to 0.4.0
- Add newsfragments for breaking changes, features, and internal changes
- Remove base58 from ruff known-third-party config

* Restore base58 package dependency

- Add base58>=1.0.2,<2.0 to dependencies
- Revert code to use base58 package instead of py-multicodec
- Add base58 back to ruff known-third-party config

* Fix linting and documentation issues

- Fix import sorting in cid/cid.py (ruff)
- Update Makefile to use --separate flag for sphinx-apidoc and remove modules.rst
- Add cid.rst to toctree in docs/index.rst to fix documentation warning

* Fix CI linting issues

- Fix import order in cid/cid.py (ruff isort)
- Remove trailing blank lines from newsfragments files (end-of-file-fixer)

* Remove newsfragments for non-existent issue 48

* Simplify docs generation: use --no-toc instead of removing modules.rst

- Use --no-toc flag to prevent generating modules.rst
- Remove redundant rm -f docs/modules.rst commands
- Cleaner approach similar to py-libp2p pattern

* Restore local base58.py and revert version to 0.3.1

- Restore cid/base58.py (copied from base58 package)
- Remove base58 package dependency from pyproject.toml
- Update imports to use local base58 module
- Revert version from 0.4.0 to 0.3.1 (version bump handled by release process)
- Remove base58 from ruff known-third-party config

Author: acul71

Makefile

@@ -73,16 +73,14 @@ coverage: ## check code coverage quickly with the default Python
 
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -f docs/cid.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ cid
+	sphinx-apidoc -o docs/ --separate --no-toc cid
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
 
 check-docs-ci: ## check documentation for CI
 	rm -f docs/cid.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ cid
+	sphinx-apidoc -o docs/ --separate --no-toc cid
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 

docs/index.rst

@@ -14,6 +14,7 @@ Table of contents
    installation
    usage
    api_reference
+   cid
    contributing
    authors
    history

pyproject.toml

@@ -32,9 +32,9 @@ classifiers = [
 requires-python = ">=3.10"
 dependencies = [
     "py-multibase>=1.0.0",
-    "py-multicodec>=0.3.0",
+    "py-multicodec>=1.0.0",
     "morphys>=1.0,<2.0",
-    "py-multihash>=2.0.0",
+    "py-multihash>=3.0.0",
 ]
 
 [project.urls]
@@ -149,7 +149,7 @@ combine-as-imports = true
 extra-standard-library = []
 force-sort-within-sections = true
 known-first-party = ["cid", "tests"]
-known-third-party = ["base58", "multibase", "multicodec", "morphys", "multihash"]
+known-third-party = ["multibase", "multicodec", "morphys", "multihash"]
 force-to-top = ["pytest"]
 
 [tool.ruff.format]

tests/test_cid.py

@@ -2,7 +2,6 @@
 import string
 
 import pytest
-import base58
 from hypothesis import (
     given,
     strategies as st,
@@ -13,7 +12,7 @@
 import multicodec
 import multihash
 
-from cid import CIDv0, CIDv1, from_string, is_cid, make_cid
+from cid import CIDv0, CIDv1, base58, from_string, is_cid, make_cid
 
 ALLOWED_ENCODINGS = [encoding for encoding in ENCODINGS if encoding.code != b"\x00"]