feat: add validator for eth addresses (#383)

- move to a new directory for crypto addresses validators
- add a new feature to validate ethereum address
- create a new dep group for crypto eth address
- update tooling requirements
- update api docs for crypto addresses
- add a new dependency group for testing, update scripts accordingly
- include crypto-eth-addresses in tooling requirements
- add docs
- bump version, update change log
- fix: make `eth_hash` truly optional
- make `eth_hash` truly optional
- update dev dependencies
- improve changelog
- fix packaging and CI

---------

Co-authored-by: Yozachar <[email protected]>

Author: msamsami

.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 .
@@ -50,6 +48,6 @@ jobs:
           cache: "pip"
       # testing
       - name: Install 'testing' dependencies
-        run: pip install pytest
+        run: pip install -r package/requirements.testing.txt
       - name: Testing
         run: pytest .

CHANGES.md

@@ -9,6 +9,22 @@ Note to self: Breaking changes must increment either
 
 -->
 
+## 0.29.0 (2024-07-01)
+
+_**Breaking**_ ⚠️
+
+- 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: add validator for eth addresses by @msamsami in [#383](https://github.com/python-validators/validators/pull/383)
+
+_**Maintenance**_
+
+- 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)
+
 ## 0.28.3 (2024-05-25)
 
 _**Breaking**_

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.

SECURITY.md

@@ -4,7 +4,7 @@
 
 | Version    | Supported          |
 | ---------- | ------------------ |
-| `>=0.28.3` | :white_check_mark: |
+| `>=0.29.0` | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

docs/api/btc_address.md

@@ -0,0 +1,4 @@
+# crypto_addresses
+
+::: validators.crypto_addresses.btc_address
+::: validators.crypto_addresses.eth_address

docs/api/btc_address.rst

@@ -0,0 +1,6 @@
+crypto_addresses
+----------------
+
+.. module:: validators.crypto_addresses
+.. autofunction:: btc_address
+.. autofunction:: eth_address

docs/api/crypto_addresses.md

@@ -70,7 +70,7 @@ nav:
   - Install and Use: install_and_use.md
   - API:
       - api/between.md
-      - api/btc_address.md
+      - api/crypto_addresses.md
       - api/card.md
       - api/country.md
       - api/cron.md