ryft-sdk


Nameryft-sdk JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
SummaryPython SDK for Ryft API
upload_time2025-08-20 16:14:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseNone
keywords ryft api sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Ryft Python SDK

[![Python - Build & Test](https://github.com/RyftPay/ryft-python/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/RyftPay/ryft-python/actions/workflows/build-and-test.yml)
[![PyPI version](https://badge.fury.io/py/ryft-sdk.svg)](https://badge.fury.io/py/ryft-sdk)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

The Ryft Python SDK allows you to quickly integrate our API into your Python-powered backend services.

## Installation

## Usage

The SDK must be configured with your account's secret key in the Ryft Dashboard. The SDK will automatically determine the environment based on the provided key. For example, `sk_sandbox...` will point to `sandbox`, while `sk_live...` will point to `production`.

### Importing the SDK

You can access the SDK and all of the methods and types by importing it as follows:

```python
from ryft_sdk import Ryft
```

### Initialising with a secret key

You can pass your secret key via the constructor in the `Ryft` package. For example:

```python
ryft = Ryft(secret_key="sk_live_123")
```

### Initialising with environment variables

You can set the following environment variable, and the SDK will automatically pick it up:

* `RYFT_SECRET_KEY`

> [!NOTE]
> Using env variables, you don't have to pass your secret key to the config. This is handled for you by the SDK

## Basic Example

```python
ryft = Ryft(secret_key="sk_live_123")

try:
  resp = await ryft.accounts.get('acc_123456789')
except RyftException as e:
  print(e)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ryft-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "Ryft <tech@ryftpay.com>",
    "keywords": "ryft, api, sdk",
    "author": null,
    "author_email": "Ryft <tech@ryftpay.com>",
    "download_url": "https://files.pythonhosted.org/packages/1b/bc/b017e19e1bd6ffc57cab0cf6b73013ed349c4b9bb18a2e1ed566e30fb5b9/ryft_sdk-1.1.0.tar.gz",
    "platform": null,
    "description": "# Ryft Python SDK\n\n[![Python - Build & Test](https://github.com/RyftPay/ryft-python/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/RyftPay/ryft-python/actions/workflows/build-and-test.yml)\n[![PyPI version](https://badge.fury.io/py/ryft-sdk.svg)](https://badge.fury.io/py/ryft-sdk)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n\nThe Ryft Python SDK allows you to quickly integrate our API into your Python-powered backend services.\n\n## Installation\n\n## Usage\n\nThe SDK must be configured with your account's secret key in the Ryft Dashboard. The SDK will automatically determine the environment based on the provided key. For example, `sk_sandbox...` will point to `sandbox`, while `sk_live...` will point to `production`.\n\n### Importing the SDK\n\nYou can access the SDK and all of the methods and types by importing it as follows:\n\n```python\nfrom ryft_sdk import Ryft\n```\n\n### Initialising with a secret key\n\nYou can pass your secret key via the constructor in the `Ryft` package. For example:\n\n```python\nryft = Ryft(secret_key=\"sk_live_123\")\n```\n\n### Initialising with environment variables\n\nYou can set the following environment variable, and the SDK will automatically pick it up:\n\n* `RYFT_SECRET_KEY`\n\n> [!NOTE]\n> Using env variables, you don't have to pass your secret key to the config. This is handled for you by the SDK\n\n## Basic Example\n\n```python\nryft = Ryft(secret_key=\"sk_live_123\")\n\ntry:\n  resp = await ryft.accounts.get('acc_123456789')\nexcept RyftException as e:\n  print(e)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python SDK for Ryft API",
    "version": "1.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/ryftpay/ryft-python/issues",
        "Changelog": "https://github.com/ryftpay/ryft-python",
        "Documentation": "https://api-reference.ryftpay.com",
        "Homepage": "https://ryftpay.com",
        "Issues": "https://github.com/ryftpay/ryft-python",
        "Repository": "https://github.com/ryftpay/ryft-python"
    },
    "split_keywords": [
        "ryft",
        " api",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a0c0a9383adbb40e45532b81f9ea1f332cc4a1e48d1eda80dd80030f8930107e",
                "md5": "141ba31e557271e7d18396aaf34c3e54",
                "sha256": "cb058145bf5477a3c2152d46aa849ce82834283eed2c59d5ddf90905a1f7710d"
            },
            "downloads": -1,
            "filename": "ryft_sdk-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "141ba31e557271e7d18396aaf34c3e54",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 45311,
            "upload_time": "2025-08-20T16:14:06",
            "upload_time_iso_8601": "2025-08-20T16:14:06.168054Z",
            "url": "https://files.pythonhosted.org/packages/a0/c0/a9383adbb40e45532b81f9ea1f332cc4a1e48d1eda80dd80030f8930107e/ryft_sdk-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1bbcb017e19e1bd6ffc57cab0cf6b73013ed349c4b9bb18a2e1ed566e30fb5b9",
                "md5": "2e1d68b11fb461a5876719ef275292c1",
                "sha256": "e6fa2edd69ff20a4169aac3622e176f710f9f19a2105df7eb78ee7f2e93fbd58"
            },
            "downloads": -1,
            "filename": "ryft_sdk-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e1d68b11fb461a5876719ef275292c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 20569,
            "upload_time": "2025-08-20T16:14:07",
            "upload_time_iso_8601": "2025-08-20T16:14:07.592452Z",
            "url": "https://files.pythonhosted.org/packages/1b/bc/b017e19e1bd6ffc57cab0cf6b73013ed349c4b9bb18a2e1ed566e30fb5b9/ryft_sdk-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 16:14:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ryftpay",
    "github_project": "ryft-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "ryft-sdk"
}
        
Elapsed time: 0.84297s