pyCryptomusAPI


NamepyCryptomusAPI JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/Badiboy/pyCryptomusAPI
SummaryPython implementation of Cryptomus (https://cryptomus.com) pubilc API
upload_time2024-04-20 19:15:38
maintainerNone
docs_urlNone
authorBadiboy
requires_pythonNone
licenseMIT license
keywords crypto pay api cryptomus
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPi Package Version](https://img.shields.io/pypi/v/pyCryptomusAPI.svg)](https://pypi.python.org/pypi/pyCryptomusAPI)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pyCryptomusAPI.svg)](https://pypi.python.org/pypi/pyCryptomusAPI)
[![PyPi downloads](https://img.shields.io/pypi/dm/pyCryptomusAPI.svg)](https://pypi.org/project/pyCryptomusAPI/)

# <p align="center">pyCryptomusAPI</p>
Python implementation of [Cryptomus](https://cryptomus.com) public [API](https://doc.cryptomus.com)

**This library is developing for my personal needs, so it may not fully implement API. However I will continue to maintain it, so if you need some not implemented methods - just open an issue.**

# Installation
Installation using pip (a Python package manager):
```
$ pip install pyCryptomusAPI
```

# Usage
Everything is as simple as the [API](https://help.crypt.bot/crypto-pay-api#available-methods) itself.
1. Create pyCryptomusAPI instance
2. Access API methods in pythonic notation (e.g. "Creating an invoice" -> create_invoice())
3. Most methods return result as correspondent class, so you can access data as fields 
```
from pyCryptomusAPI import pyCryptomusAPI
client = pyCryptomusAPI(
    "xxxx-xxxx-xxxx-xxxx-xxxx",  # Merchand UUID
    payment_api_key="xxxxxxx",   # Payment API key (for payment methods)
    payout_api_key="xxxxxxx")    # Payout API key (for payout methods)
balance = client.balance()
for item in balance.merchant:
    print("Merchant balance: {} {}".format(item.balance, item.currency_code))
```
You can also check tests.py.

# Exceptions
Exceptions are rised using pyCryptomusAPIException class.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Badiboy/pyCryptomusAPI",
    "name": "pyCryptomusAPI",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Crypto Pay API Cryptomus",
    "author": "Badiboy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/eb/b7/de8c5b58d40a918936025a73770930ec3a29775eb75d8f93923421e8492f/pyCryptomusAPI-0.1.0.tar.gz",
    "platform": null,
    "description": "[![PyPi Package Version](https://img.shields.io/pypi/v/pyCryptomusAPI.svg)](https://pypi.python.org/pypi/pyCryptomusAPI)\r\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/pyCryptomusAPI.svg)](https://pypi.python.org/pypi/pyCryptomusAPI)\r\n[![PyPi downloads](https://img.shields.io/pypi/dm/pyCryptomusAPI.svg)](https://pypi.org/project/pyCryptomusAPI/)\r\n\r\n# <p align=\"center\">pyCryptomusAPI</p>\r\nPython implementation of [Cryptomus](https://cryptomus.com) public [API](https://doc.cryptomus.com)\r\n\r\n**This library is developing for my personal needs, so it may not fully implement API. However I will continue to maintain it, so if you need some not implemented methods - just open an issue.**\r\n\r\n# Installation\r\nInstallation using pip (a Python package manager):\r\n```\r\n$ pip install pyCryptomusAPI\r\n```\r\n\r\n# Usage\r\nEverything is as simple as the [API](https://help.crypt.bot/crypto-pay-api#available-methods) itself.\r\n1. Create pyCryptomusAPI instance\r\n2. Access API methods in pythonic notation (e.g. \"Creating an invoice\" -> create_invoice())\r\n3. Most methods return result as correspondent class, so you can access data as fields \r\n```\r\nfrom pyCryptomusAPI import pyCryptomusAPI\r\nclient = pyCryptomusAPI(\r\n    \"xxxx-xxxx-xxxx-xxxx-xxxx\",  # Merchand UUID\r\n    payment_api_key=\"xxxxxxx\",   # Payment API key (for payment methods)\r\n    payout_api_key=\"xxxxxxx\")    # Payout API key (for payout methods)\r\nbalance = client.balance()\r\nfor item in balance.merchant:\r\n    print(\"Merchant balance: {} {}\".format(item.balance, item.currency_code))\r\n```\r\nYou can also check tests.py.\r\n\r\n# Exceptions\r\nExceptions are rised using pyCryptomusAPIException class.\r\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Python implementation of Cryptomus (https://cryptomus.com) pubilc API",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Badiboy/pyCryptomusAPI"
    },
    "split_keywords": [
        "crypto",
        "pay",
        "api",
        "cryptomus"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ebb7de8c5b58d40a918936025a73770930ec3a29775eb75d8f93923421e8492f",
                "md5": "185df4a7cab8ab306c90924cc14216f8",
                "sha256": "9656a2e9b3eb5a35509ceecfa5568373aaa18baa2c375c6434a22a862739f8cb"
            },
            "downloads": -1,
            "filename": "pyCryptomusAPI-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "185df4a7cab8ab306c90924cc14216f8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12878,
            "upload_time": "2024-04-20T19:15:38",
            "upload_time_iso_8601": "2024-04-20T19:15:38.985932Z",
            "url": "https://files.pythonhosted.org/packages/eb/b7/de8c5b58d40a918936025a73770930ec3a29775eb75d8f93923421e8492f/pyCryptomusAPI-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 19:15:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Badiboy",
    "github_project": "pyCryptomusAPI",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pycryptomusapi"
}
        
Elapsed time: 0.25015s