# coin-valid
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/coin-valid"></img></a> <a href="https://pypistats.org/packages/coin-valid"><img src="https://img.shields.io/pypi/dm/coin-valid"></img></a> <a href="https://pypi.org/project/coin-valid/"><img src="https://img.shields.io/pypi/v/coin-valid"></img></a> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img src="https://img.shields.io/pypi/l/coin-valid"></img></a>
Crypto Currency address validation library.
## Installation
### Recommended
```
pip install coin-valid
```
### Manual
Git clone repo:
```
git clone https://codeberg.org/NotMtth/coin-valid.git && cd coin-valid
```
Install **Poetry** and all the dependencies:
```
pip install poetry && poetry install
```
Build using **Poetry**:
```
poetry build && cd dist
```
Install the build locally:
```
pip install --user coin_valid<...>.whl
```
### Viewing docs locally (also for offline use)
Run with **mkdocs**:
```
cd docs/coin-valid/ && mkdocs serve
```
For offline use make sure to change remove `[ OFFLINE, false ]` from **mkdocs.yml**
```
plugins:
- search:
lang:
- en
- offline:
enabled: !ENV [ OFFLINE, false ]
```
## Features
- Light and compact
- Easily extensible
- No dependencies
- Pycharm auto-completion ready
- Address validation
- Coin / network detection based on address
- Convert coin names to acronyms and vice-versa
## Coins supported
- Bitcoin ₿
- Ethereum ⟠
- Litecoin Ł
- Wownero ຝ
- Bitcoincash Ƀ
- Firo
## Donations
Monero:
```
4ASpDUymEkgcBBDoqp7HFs2xqiTuddJzbhvHmSVQWdt51mbbtxjMWP4LwvbYk6xqTDNnj9FyvSRGqMvRYxWuKyALJbf8265
```
Wownero:
```
WW2jekePGc7UoK7wqvJPUs9fBW6ocUwzCTymuedUr47rFVJ18yERWT7M4Sn35QQae94TT2TvpCydYLgsAHVLftNa2nr73rtmS
```
## TODO
- [x] Create docs, add shield readthedocs build
- [x] Utils get_acronym from coin, and the opposite
- [ ] Add testnet and stagenet regex strings for currently supported coins
- [ ] Add full support for more coins
- [ ] More...
Suggestions and prs are welcome :D
Raw data
{
"_id": null,
"home_page": "https://notmtth.codeberg.page/coin-valid",
"name": "coin-valid",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "cryptocurrency,validation,bitcoin,etherum,monero",
"author": "NotMtth",
"author_email": "notmtth@xmpp.is",
"download_url": "",
"platform": null,
"description": "# coin-valid\n\n<a href=\"https://www.python.org/downloads/\"><img src=\"https://img.shields.io/pypi/pyversions/coin-valid\"></img></a> <a href=\"https://pypistats.org/packages/coin-valid\"><img src=\"https://img.shields.io/pypi/dm/coin-valid\"></img></a> <a href=\"https://pypi.org/project/coin-valid/\"><img src=\"https://img.shields.io/pypi/v/coin-valid\"></img></a> <a href=\"https://www.gnu.org/licenses/gpl-3.0.en.html\"><img src=\"https://img.shields.io/pypi/l/coin-valid\"></img></a>\n\nCrypto Currency address validation library.\n\n## Installation\n\n### Recommended\n\n```\npip install coin-valid\n```\n\n### Manual\n\nGit clone repo:\n```\ngit clone https://codeberg.org/NotMtth/coin-valid.git && cd coin-valid\n```\n\nInstall **Poetry** and all the dependencies:\n```\npip install poetry && poetry install\n```\n\nBuild using **Poetry**:\n```\npoetry build && cd dist\n```\n\nInstall the build locally:\n```\npip install --user coin_valid<...>.whl\n```\n\n### Viewing docs locally (also for offline use)\n\nRun with **mkdocs**:\n```\ncd docs/coin-valid/ && mkdocs serve\n```\n\nFor offline use make sure to change remove `[ OFFLINE, false ]` from **mkdocs.yml**\n```\nplugins:\n - search:\n lang:\n - en\n - offline:\n enabled: !ENV [ OFFLINE, false ]\n```\n\n## Features\n\n- Light and compact \n- Easily extensible\n- No dependencies\n- Pycharm auto-completion ready\n- Address validation\n- Coin / network detection based on address\n- Convert coin names to acronyms and vice-versa\n\n## Coins supported \n\n- Bitcoin \u20bf\n- Ethereum \u27e0\n- Litecoin \u0141\n- Wownero \u0e9d\n- Bitcoincash \u0243\n- Firo\n\n## Donations\n\nMonero:\n```\n4ASpDUymEkgcBBDoqp7HFs2xqiTuddJzbhvHmSVQWdt51mbbtxjMWP4LwvbYk6xqTDNnj9FyvSRGqMvRYxWuKyALJbf8265\n```\n\nWownero:\n```\nWW2jekePGc7UoK7wqvJPUs9fBW6ocUwzCTymuedUr47rFVJ18yERWT7M4Sn35QQae94TT2TvpCydYLgsAHVLftNa2nr73rtmS\n```\n\n## TODO\n\n- [x] Create docs, add shield readthedocs build\n- [x] Utils get_acronym from coin, and the opposite\n- [ ] Add testnet and stagenet regex strings for currently supported coins\n- [ ] Add full support for more coins\n- [ ] More...\n\nSuggestions and prs are welcome :D\n",
"bugtrack_url": null,
"license": "GPL-3",
"summary": "Crypto Currency address validation library",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://notmtth.codeberg.page/coin-valid",
"Repository": "https://codeberg.org/NotMtth/coin-valid"
},
"split_keywords": [
"cryptocurrency",
"validation",
"bitcoin",
"etherum",
"monero"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c7b94b01adbf721cb1461e7878eb088d730f97f1a2a7476b6aba43afc569b9b5",
"md5": "7805d6f8ed8599b8e76297d98ce60ecf",
"sha256": "980526d95009e0947b0e248b24c6455b2304bf7e98b4d0610aea9f2054a8c168"
},
"downloads": -1,
"filename": "coin_valid-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7805d6f8ed8599b8e76297d98ce60ecf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 18544,
"upload_time": "2023-06-10T12:17:24",
"upload_time_iso_8601": "2023-06-10T12:17:24.876109Z",
"url": "https://files.pythonhosted.org/packages/c7/b9/4b01adbf721cb1461e7878eb088d730f97f1a2a7476b6aba43afc569b9b5/coin_valid-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-10 12:17:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "NotMtth",
"codeberg_project": "coin-valid",
"lcname": "coin-valid"
}
JSON