# YooKassa API Python Client Library
[](https://travis-ci.org/yoomoney/yookassa-sdk-python)
[](https://pypi.org/project/yookassa/)
[](https://pypi.org/project/yookassa/)
[](https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python)
[Russian](README.md) | English
This product is used for managing payments under [The YooKassa API](https://yookassa.ru/en/developers/api)
For usage by those who implemented YooKassa using the API method.
## Features
* Version 3.x supports Python >=3.7. To work on earlier versions of Python, use versions of yookassa 2.x
* Changing the directory/file structure affected some package imports. When switching from the version of yookassa 2.x, check the imports in your project:
* `yookassa.domain.models.airline` → `yookassa.domain.models.payment_data.request.airline`
* `yookassa.domain.models.authorization_details` → `yookassa.domain.models.payment_data.response.authorization_details`
* `yookassa.domain.models.receipt_customer` → `yookassa.domain.models.receipt_data.receipt_customer`
* `yookassa.domain.models.receipt_item` → `yookassa.domain.models.receipt_data.receipt_item`
* `yookassa.domain.models.receipt_item_supplier` → `yookassa.domain.models.receipt_data.receipt_item_supplier`
* `yookassa.domain.models.recipient` → `yookassa.domain.models.payment_data.recipient`
* `yookassa.domain.models.refund_source` → `yookassa.domain.models.refund_data.refund_source`
* `Settings.get_account_settings()` now returns the `Me` object. To support compatibility, object fields can be accessed as an array - `me.account_id = me['account_id']`
* The `me.fiscalization_enabled` field is deprecated, but it is still supported. The `me.fiscalization` object has been added instead..
## Requirements
1. Python >=3.7
2. pip
## Installation
### Under console using pip
1. Install pip.
2. In the console, run the following command:
```bash
pip install --upgrade yookassa
```
### Under console using easy_install
1. Install easy_install.
2. In the console, run the following command:
```bash
easy_install --upgrade yookassa
```
## Commencing work
1. Import module
```python
import yookassa
```
2. Configure a Client
```python
from yookassa import Configuration
Configuration.configure('<Account Id>', '<Secret Key>')
```
or
```python
from yookassa import Configuration
Configuration.account_id = '<Account Id>'
Configuration.secret_key = '<Secret Key>'
```
or via oauth
```python
from yookassa import Configuration
Configuration.configure_auth_token('<Oauth Token>')
```
If you agree to participate in the development of the SDK, you can submit data about your framework, cms or module:
```python
from yookassa import Configuration
from yookassa.domain.common.user_agent import Version
Configuration.configure('<Account Id>', '<Secret Key>')
Configuration.configure_user_agent(
framework=Version('Django', '2.2.3'),
cms=Version('Wagtail', '2.6.2'),
module=Version('Y.CMS', '0.0.1')
)
```
3. Call the required API method. [More details in our documentation for the YooKassa API](https://yookassa.ru/en/developers/api)
Raw data
{
"_id": null,
"home_page": "https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python",
"name": "yookassa",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "yoomoney, yookassa, payout, sdk, python",
"author": "YooMoney",
"author_email": "cms@yoomoney.ru",
"download_url": "https://files.pythonhosted.org/packages/28/99/288061ff92713ed8dda5fdddd204edb8dfaf78d246d078d86b5ae019f38c/yookassa-3.3.0.tar.gz",
"platform": null,
"description": "\n# YooKassa API Python Client Library\n\n[](https://travis-ci.org/yoomoney/yookassa-sdk-python)\n[](https://pypi.org/project/yookassa/)\n[](https://pypi.org/project/yookassa/)\n[](https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python)\n\n[Russian](README.md) | English\n\nThis product is used for managing payments under [The YooKassa API](https://yookassa.ru/en/developers/api)\nFor usage by those who implemented YooKassa using the API method.\n\n## Features\n\n* Version 3.x supports Python >=3.7. To work on earlier versions of Python, use versions of yookassa 2.x\n* Changing the directory/file structure affected some package imports. When switching from the version of yookassa 2.x, check the imports in your project:\n * `yookassa.domain.models.airline` \u2192 `yookassa.domain.models.payment_data.request.airline`\n * `yookassa.domain.models.authorization_details` \u2192 `yookassa.domain.models.payment_data.response.authorization_details`\n * `yookassa.domain.models.receipt_customer` \u2192 `yookassa.domain.models.receipt_data.receipt_customer`\n * `yookassa.domain.models.receipt_item` \u2192 `yookassa.domain.models.receipt_data.receipt_item`\n * `yookassa.domain.models.receipt_item_supplier` \u2192 `yookassa.domain.models.receipt_data.receipt_item_supplier`\n * `yookassa.domain.models.recipient` \u2192 `yookassa.domain.models.payment_data.recipient`\n * `yookassa.domain.models.refund_source` \u2192 `yookassa.domain.models.refund_data.refund_source`\n* `Settings.get_account_settings()` now returns the `Me` object. To support compatibility, object fields can be accessed as an array - `me.account_id = me['account_id']`\n* The `me.fiscalization_enabled` field is deprecated, but it is still supported. The `me.fiscalization` object has been added instead..\n\n## Requirements\n1. Python >=3.7\n2. pip\n\n## Installation\n### Under console using pip\n\n1. Install pip.\n2. In the console, run the following command:\n```bash\npip install --upgrade yookassa\n```\n\n### Under console using easy_install\n1. Install easy_install.\n2. In the console, run the following command:\n```bash\neasy_install --upgrade yookassa\n```\n\n## Commencing work\n\n1. Import module\n```python\nimport yookassa\n```\n\n2. Configure a Client\n```python\nfrom yookassa import Configuration\n\nConfiguration.configure('<Account Id>', '<Secret Key>')\n```\n\nor\n\n```python\nfrom yookassa import Configuration\n\nConfiguration.account_id = '<Account Id>'\nConfiguration.secret_key = '<Secret Key>'\n```\n\nor via oauth\n\n```python\nfrom yookassa import Configuration\n\nConfiguration.configure_auth_token('<Oauth Token>')\n```\n\nIf you agree to participate in the development of the SDK, you can submit data about your framework, cms or module:\n\n```python\nfrom yookassa import Configuration\nfrom yookassa.domain.common.user_agent import Version\n\nConfiguration.configure('<Account Id>', '<Secret Key>')\nConfiguration.configure_user_agent(\n framework=Version('Django', '2.2.3'),\n cms=Version('Wagtail', '2.6.2'),\n module=Version('Y.CMS', '0.0.1')\n)\n```\n\n3. Call the required API method. [More details in our documentation for the YooKassa API](https://yookassa.ru/en/developers/api)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "YooKassa API SDK Python Library",
"version": "3.3.0",
"project_urls": {
"Homepage": "https://git.yoomoney.ru/projects/SDK/repos/yookassa-sdk-python"
},
"split_keywords": [
"yoomoney",
" yookassa",
" payout",
" sdk",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2899288061ff92713ed8dda5fdddd204edb8dfaf78d246d078d86b5ae019f38c",
"md5": "4c65f2071e91069cd9c015fca4fee063",
"sha256": "2075b52404c78636882d5d68eff58545b0cbe17a3c484c068c33970b9eb8d5e8"
},
"downloads": -1,
"filename": "yookassa-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4c65f2071e91069cd9c015fca4fee063",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 97658,
"upload_time": "2024-07-02T12:30:04",
"upload_time_iso_8601": "2024-07-02T12:30:04.799306Z",
"url": "https://files.pythonhosted.org/packages/28/99/288061ff92713ed8dda5fdddd204edb8dfaf78d246d078d86b5ae019f38c/yookassa-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-02 12:30:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "yookassa"
}
JSON