# CKB SDK Python
This is my personal side project, which is not an official SDK. The project is
still in an early stage, the interfaces are unstable, and I may add breaking
changes without notifications.
The library works only with Python 3.
## Quick Start
Install in a virtualenv
```
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
Example
```
from ckb.rpc import rpc
rpc.get_tip_block_number()
```
## Design Choices
This project does not add model classes, instead it uses the JSON response
dict directly. You can check the dict schema in `ckb/types.py`.
I want to experiment another way to build a CKB SDK. This project will not
support any features that require knowing how a lock or type script works. I'm
going to create various generator library to building transaction, such as
`ckb-sdk-python-secp256k1-generator`.
Raw data
{
"_id": null,
"home_page": "https://github.com/doitian/ckb-sdk-python",
"name": "ckb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "ian",
"author_email": "ian@nervos.org",
"download_url": "https://files.pythonhosted.org/packages/21/bf/5d2a9bbe446e68afd23d429371b01d9648387e3268c7b3d1d0ecc0b3d070/ckb-0.6.0.tar.gz",
"platform": null,
"description": "# CKB SDK Python\n\nThis is my personal side project, which is not an official SDK. The project is\nstill in an early stage, the interfaces are unstable, and I may add breaking\nchanges without notifications.\n\nThe library works only with Python 3.\n\n## Quick Start\n\nInstall in a virtualenv\n\n```\npython3 -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\nExample\n\n```\nfrom ckb.rpc import rpc\nrpc.get_tip_block_number()\n```\n\n## Design Choices\n\nThis project does not add model classes, instead it uses the JSON response\ndict directly. You can check the dict schema in `ckb/types.py`.\n\nI want to experiment another way to build a CKB SDK. This project will not\nsupport any features that require knowing how a lock or type script works. I'm\ngoing to create various generator library to building transaction, such as\n`ckb-sdk-python-secp256k1-generator`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Nervos CKB SDK",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/doitian/ckb-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05ac063a807bca2759402cd2de0a3631247fd77a36163530781baccdcfd8e4a2",
"md5": "8bcee25c7c1e592fc970f641288e2365",
"sha256": "36e730ad4f9c4776a9d39d9cc58917ca712634f8d2fb8901c2d2d68eb9324dcc"
},
"downloads": -1,
"filename": "ckb-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bcee25c7c1e592fc970f641288e2365",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13775,
"upload_time": "2023-11-01T16:19:36",
"upload_time_iso_8601": "2023-11-01T16:19:36.026923Z",
"url": "https://files.pythonhosted.org/packages/05/ac/063a807bca2759402cd2de0a3631247fd77a36163530781baccdcfd8e4a2/ckb-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21bf5d2a9bbe446e68afd23d429371b01d9648387e3268c7b3d1d0ecc0b3d070",
"md5": "be1b12edfe9817cccb7ef5de1fcccfcb",
"sha256": "654d78a86a4457f15f7cdf73b28152f6e2d0aad2a686134a1b8a942d47557894"
},
"downloads": -1,
"filename": "ckb-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "be1b12edfe9817cccb7ef5de1fcccfcb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11675,
"upload_time": "2023-11-01T16:19:37",
"upload_time_iso_8601": "2023-11-01T16:19:37.620954Z",
"url": "https://files.pythonhosted.org/packages/21/bf/5d2a9bbe446e68afd23d429371b01d9648387e3268c7b3d1d0ecc0b3d070/ckb-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 16:19:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "doitian",
"github_project": "ckb-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ckb"
}