# Kinetic Python SDK
Kinetic Python SDK is the official [python](https://www.python.org/) SDK for [Kinetic](https://github.com/kin-labs/kinetic) based on the [Kinetic SDK Standard](https://github.com/kin-labs/kinetic/discussions/317).
This SDK allows developers to rapidly integrate Kin and other SPL tokens in their app.
## Usage
In order to use this SDK, please head over to the [Kinetic Pyrhon SDK](https://developer.kin.org/docs/developers/python) documentation.
## Version
This SDK is built to work with `@kinetic/api@v1.0.0-rc.16`. Using it with other versions may lead to issues.
## Contributing
If you want to contribute to this SDK, please follow the steps below to get it running locally:
#### 1. Install the Poetry CLI on your local machine by visiting the link below:
[Install Poetry](https://python-poetry.org/docs/#installation)
#### 2. Install the OpenAPI Generator via NPM (for alternative installs visit: https://openapi-generator.tech)
`$ npm install @openapitools/openapi-generator-cli -g`
#### 3. Fetch the Kinetic Python repo
`$ git clone https://github.com/kin-labs/kinetic-python-sdk`
#### 4. Change into kinetic-python-sdk working directory
`$ cd kinetic-python-sdk`
#### 5. Run the tests
`$ make test`
#### 6. Generate OpenAPI Python client
`$ make generate`
## Directory labels
- [generated](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/generated) Contains all the generated Python client code based on the openapi spec.
- [helpers](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/helpers) Contains helper functions that simply calling the createAccount and makeTranfer sdk functions
- [models](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/models) Here you can find all reference to classes to-be created and what they override.
## Contributing
To start contributing, take a look at the standard as this lays down the base for all clients.
This standard is subject to change so always review this before committing any meaningful work.
You can visit the standard [here](https://github.com/kin-labs/kinetic/discussions/317)
## Troubleshooting
If you have issues with [coincurve](https://github.com/ofek/coincurve) dependency in Apple Silicon M1 run this:
```
xcode-select --install
brew install autoconf automake libffi libtool pkg-config python
```
Raw data
{
"_id": null,
"home_page": "https://github.com/kin-labs/kinetic-python-sdk",
"name": "kinetic-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "solana,blockchain,kin,web3",
"author": "Kin Foundation",
"author_email": "dev@kin.org",
"download_url": "https://files.pythonhosted.org/packages/e3/2f/81e1fcde1b6f83c9d8e4b7960da1324ef0b241b87025a3774ca7242b0bcc/kinetic-sdk-1.0.0rc16.tar.gz",
"platform": null,
"description": "# Kinetic Python SDK\n\nKinetic Python SDK is the official [python](https://www.python.org/) SDK for [Kinetic](https://github.com/kin-labs/kinetic) based on the [Kinetic SDK Standard](https://github.com/kin-labs/kinetic/discussions/317).\n\nThis SDK allows developers to rapidly integrate Kin and other SPL tokens in their app.\n\n## Usage\n\nIn order to use this SDK, please head over to the [Kinetic Pyrhon SDK](https://developer.kin.org/docs/developers/python) documentation.\n\n## Version\n\nThis SDK is built to work with `@kinetic/api@v1.0.0-rc.16`. Using it with other versions may lead to issues.\n\n## Contributing\n\nIf you want to contribute to this SDK, please follow the steps below to get it running locally:\n\n#### 1. Install the Poetry CLI on your local machine by visiting the link below:\n[Install Poetry](https://python-poetry.org/docs/#installation)\n\n#### 2. Install the OpenAPI Generator via NPM (for alternative installs visit: https://openapi-generator.tech)\n`$ npm install @openapitools/openapi-generator-cli -g`\n\n#### 3. Fetch the Kinetic Python repo\n`$ git clone https://github.com/kin-labs/kinetic-python-sdk`\n\n#### 4. Change into kinetic-python-sdk working directory\n`$ cd kinetic-python-sdk`\n\n#### 5. Run the tests\n`$ make test`\n\n#### 6. Generate OpenAPI Python client\n`$ make generate`\n\n## Directory labels\n- [generated](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/generated) Contains all the generated Python client code based on the openapi spec.\n- [helpers](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/helpers) Contains helper functions that simply calling the createAccount and makeTranfer sdk functions\n- [models](https://github.com/kin-labs/kinetic-python-sdk/tree/main/src/kinetic_sdk/models) Here you can find all reference to classes to-be created and what they override.\n\n## Contributing\nTo start contributing, take a look at the standard as this lays down the base for all clients.\nThis standard is subject to change so always review this before committing any meaningful work.\nYou can visit the standard [here](https://github.com/kin-labs/kinetic/discussions/317)\n\n## Troubleshooting\n\nIf you have issues with [coincurve](https://github.com/ofek/coincurve) dependency in Apple Silicon M1 run this:\n```\nxcode-select --install\nbrew install autoconf automake libffi libtool pkg-config python\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "1.0.0rc16",
"split_keywords": [
"solana",
"blockchain",
"kin",
"web3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec3b6ea2ecf8498f2a22b03a06ffaaffd034dec9f7afd6dbe62a2d7748b0a9fe",
"md5": "39ba71a4b52fd36e4e6a05da6310ffbc",
"sha256": "1c26b21b1c090ccc360fea815233aafae06aaeccabce4c85ba00b2654d724d84"
},
"downloads": -1,
"filename": "kinetic_sdk-1.0.0rc16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39ba71a4b52fd36e4e6a05da6310ffbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 160120,
"upload_time": "2023-01-30T21:26:50",
"upload_time_iso_8601": "2023-01-30T21:26:50.148102Z",
"url": "https://files.pythonhosted.org/packages/ec/3b/6ea2ecf8498f2a22b03a06ffaaffd034dec9f7afd6dbe62a2d7748b0a9fe/kinetic_sdk-1.0.0rc16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e32f81e1fcde1b6f83c9d8e4b7960da1324ef0b241b87025a3774ca7242b0bcc",
"md5": "1bdc7ee2f40c06f6dfb77a36d5c00fe7",
"sha256": "e4e5cb1e77b9386a68081351f192aa5ac25e91b9ed76a4c34cd33f813c25ec6f"
},
"downloads": -1,
"filename": "kinetic-sdk-1.0.0rc16.tar.gz",
"has_sig": false,
"md5_digest": "1bdc7ee2f40c06f6dfb77a36d5c00fe7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 64173,
"upload_time": "2023-01-30T21:26:48",
"upload_time_iso_8601": "2023-01-30T21:26:48.759778Z",
"url": "https://files.pythonhosted.org/packages/e3/2f/81e1fcde1b6f83c9d8e4b7960da1324ef0b241b87025a3774ca7242b0bcc/kinetic-sdk-1.0.0rc16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 21:26:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kin-labs",
"github_project": "kinetic-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kinetic-sdk"
}
JSON
