fix: make eth_hash truly optional

- make `eth_hash` truly optional
- update dev dependencies
- improve changelog
- fix packaging and CI

Author: yozachar

.github/workflows/pycqa.yaml

@@ -22,9 +22,7 @@ jobs:
           python-version: "3.8"
       # tooling
       - name: Install 'tooling' dependencies
-        run: |
-          pip install .
-          pip install -r package/requirements.tooling.txt
+        run: pip install -r package/requirements.tooling.txt
       - name: Tooling
         run: |
           black .

CHANGES.md

@@ -13,17 +13,15 @@ Note to self: Breaking changes must increment either
 
 _**Breaking**_ ⚠️
 
-> patch: moves `btc_address` module to `crypto_addresses` module by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
+- patch: moves `btc_address` to `crypto_addresses` by @msamsami in [#383](https://github.com/python-validators/validators/pull/383) on [`2f300b`](https://github.com/python-validators/validators/pull/383/commits/2f300bccf31e7d8914817cac2ca466fd2a0a4d08)
 
 _**Features**_
 
-> feat: adds `eth_address` validator by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
+- feat: add validator for eth addresses by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
 
 _**Maintenance**_
 
-- chore: adds a new dependency group for `eth_address` by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
-- chore: adds a redundant dependency group `testing`, updates testing workflow by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
-- chore: updates dev dependencies; bump version by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
+- chore: update dev deps; adds python EOL info by @yozachar in [#381](https://github.com/python-validators/validators/pull/381)
 
 **Full Changelog**: [`0.28.3...0.29.0`](https://github.com/python-validators/validators/compare/0.28.3...0.29.0)
 

CONTRIBUTING.md

@@ -78,7 +78,7 @@ $ python -m http.server -d docs/_build/web
     $ git push upstream --tag
     ```
 
-4. To prevew versioned docs, run `mike serve` (`mike` is already a dev dependency).
+4. To preview versioned docs, run `mike serve` (`mike` is already a dev dependency).
 5. To update it, checkout to the tag you want to include in the versioned documentation `git checkout TAG_NAME`.
 6. Then run `mike deploy -p -u VERSION stable` OR run `mike deploy -p -u dev master`,
 7. Which will deploy docs in the CURRENT commit as the `latest` documentation, onto `gh-pages` branch.

package/requirements.mkdocs.txt

@@ -97,6 +97,9 @@ colorama==0.4.6 \
 docutils==0.20.1 \
     --hash=sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6 \
     --hash=sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b
+eth-hash[pycryptodome]==0.7.0 \
+    --hash=sha256:b8d5a230a2b251f4a291e3164a23a14057c4a6de4b0aa4a16fa4dc9161b57e2f \
+    --hash=sha256:bacdc705bfd85dadd055ecd35fd1b4f846b671add101427e089a4ca2e8db310a
 furo==2024.5.6 \
     --hash=sha256:490a00d08c0a37ecc90de03ae9227e8eb5d6f7f750edf9807f398a2bdf2358de \
     --hash=sha256:81f205a6605ebccbb883350432b4831c0196dd3d1bc92f61e1f459045b3d2b0b
@@ -106,9 +109,9 @@ idna==3.7 \
 imagesize==1.4.1 \
     --hash=sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b \
     --hash=sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a
-importlib-metadata==7.1.0 \
-    --hash=sha256:30962b96c0c223483ed6cc7280e7f0199feb01a0e40cfae4d4450fc6fab1f570 \
-    --hash=sha256:b78938b926ee8d5f020fc4772d487045805a55ddbad2ecf21c6d60938dc7fcd2
+importlib-metadata==8.0.0 \
+    --hash=sha256:15584cf2b1bf449d98ff8a6ff1abef57bf20f3ac6454f431736cd3e660921b2f \
+    --hash=sha256:188bd24e4c346d3f0a933f275c2fec67050326a856b9a359881d7c2a697e8812
 jinja2==3.1.4 \
     --hash=sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369 \
     --hash=sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d
@@ -179,6 +182,28 @@ myst-parser==3.0.1 \
 packaging==24.1 \
     --hash=sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002 \
     --hash=sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124
+pycryptodome==3.20.0 \
+    --hash=sha256:09609209ed7de61c2b560cc5c8c4fbf892f8b15b1faf7e4cbffac97db1fffda7 \
+    --hash=sha256:210ba1b647837bfc42dd5a813cdecb5b86193ae11a3f5d972b9a0ae2c7e9e4b4 \
+    --hash=sha256:2ab6ab0cb755154ad14e507d1df72de9897e99fd2d4922851a276ccc14f4f1a5 \
+    --hash=sha256:405002eafad114a2f9a930f5db65feef7b53c4784495dd8758069b89baf68eab \
+    --hash=sha256:4401564ebf37dfde45d096974c7a159b52eeabd9969135f0426907db367a652a \
+    --hash=sha256:49a4c4dc60b78ec41d2afa392491d788c2e06edf48580fbfb0dd0f828af49d25 \
+    --hash=sha256:6e0e4a987d38cfc2e71b4a1b591bae4891eeabe5fa0f56154f576e26287bfdea \
+    --hash=sha256:76658f0d942051d12a9bd08ca1b6b34fd762a8ee4240984f7c06ddfb55eaf15a \
+    --hash=sha256:76cb39afede7055127e35a444c1c041d2e8d2f1f9c121ecef573757ba4cd2c3c \
+    --hash=sha256:8d6b98d0d83d21fb757a182d52940d028564efe8147baa9ce0f38d057104ae72 \
+    --hash=sha256:9b3ae153c89a480a0ec402e23db8d8d84a3833b65fa4b15b81b83be9d637aab9 \
+    --hash=sha256:a60fedd2b37b4cb11ccb5d0399efe26db9e0dd149016c1cc6c8161974ceac2d6 \
+    --hash=sha256:ac1c7c0624a862f2e53438a15c9259d1655325fc2ec4392e66dc46cdae24d044 \
+    --hash=sha256:acae12b9ede49f38eb0ef76fdec2df2e94aad85ae46ec85be3648a57f0a7db04 \
+    --hash=sha256:acc2614e2e5346a4a4eab6e199203034924313626f9620b7b4b38e9ad74b7e0c \
+    --hash=sha256:acf6e43fa75aca2d33e93409f2dafe386fe051818ee79ee8a3e21de9caa2ac9e \
+    --hash=sha256:c18b381553638414b38705f07d1ef0a7cf301bc78a5f9bc17a957eb19446834b \
+    --hash=sha256:ec1f93feb3bb93380ab0ebf8b859e8e5678c0f010d2d78367cf6bc30bfeb148e \
+    --hash=sha256:f35d6cee81fa145333137009d9c8ba90951d7d77b67c79cbe5f03c7eb74d8fe2 \
+    --hash=sha256:f47888542a0633baff535a04726948e876bf1ed880fddb7c10a736fa99146ab3 \
+    --hash=sha256:fb3b87461fa35afa19c971b0a2b7456a7b1db7b4eba9a8424666104925b78128
 pygments==2.18.0 \
     --hash=sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199 \
     --hash=sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a

package/requirements.sphinx.txt

@@ -4,7 +4,7 @@
 colorama==0.4.6 \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
-eth-hash==0.7.0 \
+eth-hash[pycryptodome]==0.7.0 \
     --hash=sha256:b8d5a230a2b251f4a291e3164a23a14057c4a6de4b0aa4a16fa4dc9161b57e2f \
     --hash=sha256:bacdc705bfd85dadd055ecd35fd1b4f846b671add101427e089a4ca2e8db310a
 exceptiongroup==1.2.1; python_version < "3.11" \

package/requirements.testing.txt

@@ -30,7 +30,7 @@ click==8.1.7 \
 colorama==0.4.6 \
     --hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
     --hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
-eth-hash==0.7.0 \
+eth-hash[pycryptodome]==0.7.0 \
     --hash=sha256:b8d5a230a2b251f4a291e3164a23a14057c4a6de4b0aa4a16fa4dc9161b57e2f \
     --hash=sha256:bacdc705bfd85dadd055ecd35fd1b4f846b671add101427e089a4ca2e8db310a
 exceptiongroup==1.2.1; python_version < "3.11" \
@@ -87,30 +87,31 @@ pypandoc-binary==1.13 \
     --hash=sha256:67c0c7af811bcf3cd4f3221be756a4975ec35b2d7df89d8de4313a8caa2cd54f \
     --hash=sha256:9455fdd9521cbf4b56d79a56b806afa94c8c22f3c8ef878536e58d941a70f6d6 \
     --hash=sha256:946666388eb79b307d7f497b3b33045ef807750f8e5ef3440e0ba3bbab698044
-pyright==1.1.367 \
-    --hash=sha256:89de6502ae02f1552d0c4df4b46867887a419849f379db617695ef9308cf01eb \
-    --hash=sha256:b1e5522ceb246ee6bc293a43d6d0162719d6467c1f1e9b81cee741aa11cdacbd
+pyright==1.1.369 \
+    --hash=sha256:06d5167a8d7be62523ced0265c5d2f1e022e110caf57a25d92f50fb2d07bcda0 \
+    --hash=sha256:ad290710072d021e213b98cc7a2f90ae3a48609ef5b978f749346d1a47eb9af8
 pytest==8.2.2 \
     --hash=sha256:c434598117762e2bd304e526244f67bf66bbd7b5d6cf22138be51ff661980343 \
     --hash=sha256:de4bb8104e201939ccdc688b27a89a7be2079b22e2bd2b07f806b6ba71117977
-ruff==0.4.9 \
-    --hash=sha256:06b60f91bfa5514bb689b500a25ba48e897d18fea14dce14b48a0c40d1635893 \
-    --hash=sha256:0e8e7b95673f22e0efd3571fb5b0cf71a5eaaa3cc8a776584f3b2cc878e46bff \
-    --hash=sha256:2d45ddc6d82e1190ea737341326ecbc9a61447ba331b0a8962869fcada758505 \
-    --hash=sha256:4555056049d46d8a381f746680db1c46e67ac3b00d714606304077682832998e \
-    --hash=sha256:5d5460f789ccf4efd43f265a58538a2c24dbce15dbf560676e430375f20a8198 \
-    --hash=sha256:673bddb893f21ab47a8334c8e0ea7fd6598ecc8e698da75bcd12a7b9d0a3206e \
-    --hash=sha256:732dd550bfa5d85af8c3c6cbc47ba5b67c6aed8a89e2f011b908fc88f87649db \
-    --hash=sha256:784d3ec9bd6493c3b720a0b76f741e6c2d7d44f6b2be87f5eef1ae8cc1d54c84 \
-    --hash=sha256:78de3fdb95c4af084087628132336772b1c5044f6e710739d440fc0bccf4d321 \
-    --hash=sha256:8064590fd1a50dcf4909c268b0e7c2498253273309ad3d97e4a752bb9df4f521 \
-    --hash=sha256:88bffe9c6a454bf8529f9ab9091c99490578a593cc9f9822b7fc065ee0712a06 \
-    --hash=sha256:8c1aff58c31948cc66d0b22951aa19edb5af0a3af40c936340cd32a8b1ab7438 \
-    --hash=sha256:98ec2775fd2d856dc405635e5ee4ff177920f2141b8e2d9eb5bd6efd50e80317 \
-    --hash=sha256:b262ed08d036ebe162123170b35703aaf9daffecb698cd367a8d585157732991 \
-    --hash=sha256:e0a22c4157e53d006530c902107c7f550b9233e9706313ab57b892d7197d8e52 \
-    --hash=sha256:e91175fbe48f8a2174c9aad70438fe9cb0a5732c4159b2a10a3565fea2d94cde \
-    --hash=sha256:f1cb0828ac9533ba0135d148d214e284711ede33640465e706772645483427e3
+ruff==0.5.0 \
+    --hash=sha256:2c4dfcd8d34b143916994b3876b63d53f56724c03f8c1a33a253b7b1e6bf2a7d \
+    --hash=sha256:38f3b8327b3cb43474559d435f5fa65dacf723351c159ed0dc567f7ab735d1b6 \
+    --hash=sha256:46e193b36f2255729ad34a49c9a997d506e58f08555366b2108783b3064a0e1e \
+    --hash=sha256:49141d267100f5ceff541b4e06552e98527870eafa1acc9dec9139c9ec5af64c \
+    --hash=sha256:7594f8df5404a5c5c8f64b8311169879f6cf42142da644c7e0ba3c3f14130370 \
+    --hash=sha256:81e5facfc9f4a674c6a78c64d38becfbd5e4f739c31fcd9ce44c849f1fad9e4c \
+    --hash=sha256:9dc5cfd3558f14513ed0d5b70ce531e28ea81a8a3b1b07f0f48421a3d9e7d80a \
+    --hash=sha256:adc7012d6ec85032bc4e9065110df205752d64010bed5f958d25dbee9ce35de3 \
+    --hash=sha256:b1a321c4f68809fddd9b282fab6a8d8db796b270fff44722589a8b946925a2a8 \
+    --hash=sha256:cd096e23c6a4f9c819525a437fa0a99d1c67a1b6bb30948d46f33afbc53596cf \
+    --hash=sha256:d2ffbc3715a52b037bcb0f6ff524a9367f642cdc5817944f6af5479bbb2eb50e \
+    --hash=sha256:d505fb93b0fabef974b168d9b27c3960714d2ecda24b6ffa6a87ac432905ea38 \
+    --hash=sha256:db3ca35265de239a1176d56a464b51557fce41095c37d6c406e658cf80bbb362 \
+    --hash=sha256:e589e27971c2a3efff3fadafb16e5aef7ff93250f0134ec4b52052b673cf988d \
+    --hash=sha256:e9118f60091047444c1b90952736ee7b1792910cab56e9b9a9ac20af94cd0440 \
+    --hash=sha256:eb641b5873492cf9bd45bc9c5ae5320648218e04386a5f0c264ad6ccce8226a1 \
+    --hash=sha256:ed5c4df5c1fb4518abcb57725b576659542bdbe93366f4f329e8f398c4b71178 \
+    --hash=sha256:ee770ea8ab38918f34e7560a597cc0a8c9a193aaa01bfbd879ef43cb06bd9c4c
 tomli==2.0.1; python_version < "3.11" \
     --hash=sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc \
     --hash=sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f

package/requirements.tooling.txt

@@ -4,14 +4,14 @@ $ErrorActionPreference = "Stop"
 
 # Check if CI environment variable is set to "false"
 if ($null -eq $env:CI || "false" -eq $env:CI) {
-    # tooling
-    pdm export --group tooling,crypto-eth-addresses -f requirements -o package/requirements.tooling.txt
     # testing
     pdm export --group testing,crypto-eth-addresses -f requirements -o package/requirements.testing.txt
+    # tooling
+    pdm export --group tooling,crypto-eth-addresses -f requirements -o package/requirements.tooling.txt
     # mkdocs
-    pdm export --group docs-online -f requirements -o package/requirements.mkdocs.txt
+    # pdm export --group docs-online -f requirements -o package/requirements.mkdocs.txt
     # sphinx
-    pdm export --group docs-offline -f requirements -o package/requirements.sphinx.txt
+    pdm export --group docs-offline,crypto-eth-addresses -f requirements -o package/requirements.sphinx.txt
 
     # create environment variable
     $env:CI = "true";

package/roll.ps1

@@ -6,14 +6,14 @@ set -e
 # or set to empty string or not set at all.
 # Using the wrong way see: https://stackoverflow.com/a/13864829
 if [ -z "$CI" ] || [ "$CI" = "false" ]; then
-    # tooling
-    pdm export --group tooling,crypto-eth-addresses -f requirements -o package/requirements.tooling.txt
     # testing
     pdm export --group testing,crypto-eth-addresses -f requirements -o package/requirements.testing.txt
+    # tooling
+    pdm export --group tooling,crypto-eth-addresses -f requirements -o package/requirements.tooling.txt
     # mkdocs
-    pdm export --group docs-online -f requirements -o package/requirements.mkdocs.txt
+    # pdm export --group docs-online -f requirements -o package/requirements.mkdocs.txt
     # sphinx
-    pdm export --group docs-offline -f requirements -o package/requirements.sphinx.txt
+    pdm export --group docs-offline,crypto-eth-addresses -f requirements -o package/requirements.sphinx.txt
     export CI=true
 fi