# Circle APIs Python Library
[](https://pypi.org/project/circle-sdk)
[](https://pypi.org/project/circle-sdk)
The Circle Python library provides convenient access to the Circle API for
applications written in Python. For the API reference, see the [Circle API docs](https://developers.circle.com/reference). Also see this project's [PyPI package page](https://pypi.org/project/circle-sdk/).
## Requirements
Python 3.7+ and Node 10+ (optional for contributing and development).
## Installation
The recommended way of installation is using the Python Package Index (PyPI):
```sh
python3 -m pip install circle-sdk
```
The other option requires you to clone this repo and run
```sh
python3 -m pip install -e /Path/to/this/repo/root
```
## Python Typing
We strongly recommended that you use this SDK with Python typing extensions: we recommend using the VS Code IDE, downloading the [Python IntelliSense extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python), and enabling type checking for your workspace (see [this guide](https://www.emmanuelgautier.com/blog/enable-vscode-python-type-checking)).
## Usage
```python
import circle
from circle.apis.tags import subscriptions_api
from circle.model.subscription_request import SubscriptionRequest
from pprint import pprint
# Configure global settings
circle.base_url = circle.Environment.SANDBOX_BASE_URL
circle.api_key = '<replace-me-with-your-api-key>'
# Choose API driver
api_instance = subscriptions_api.SubscriptionsApi()
# Prepare request data
body = SubscriptionRequest(
endpoint="https://example.org/py/notifications"
)
# Send request
try:
api_response = api_instance.create_subscription(body=body)
pprint(api_response)
except circle.ApiException as e:
print("Exception when calling SubscriptionsApi->create_subscription: %s\n" % e)
```
## Development
Clone this repo and install development dependencies using
```sh
# For codegen tools and git hook checks
yarn install
# For the Python SDK's dependencies
python3 -m pip install -r requirements.txt
```
1. Run the codegen command to generate the source code for thi
s SDK from the `.openapi-generator/sdk.json` OpenAPI specificat
ion file:
```sh
yarn gen-sdk
```
## Contributions
Please follow the [Conventional Commits][convencomms] format for all commits when creating a contributing pull request for this repo.
[convencomms]: https://www.conventionalcommits.org/en/v1.0.0/
Raw data
{
"_id": null,
"home_page": null,
"name": "circle-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "circle, circle.com, usdc, euroc, stablecoins",
"author": "Circle SDK Developers",
"author_email": "sdk-developers+pypi@circle.com",
"download_url": "https://files.pythonhosted.org/packages/8c/7f/02821e4b93af898a395af26a008384fb3c6b533d30983d6703a0da464d74/circle-sdk-0.1.0b14.tar.gz",
"platform": null,
"description": "# Circle APIs Python Library\n\n[](https://pypi.org/project/circle-sdk)\n[](https://pypi.org/project/circle-sdk)\n\nThe Circle Python library provides convenient access to the Circle API for\napplications written in Python. For the API reference, see the [Circle API docs](https://developers.circle.com/reference). Also see this project's [PyPI package page](https://pypi.org/project/circle-sdk/).\n\n## Requirements\n\nPython 3.7+ and Node 10+ (optional for contributing and development).\n\n## Installation\n\nThe recommended way of installation is using the Python Package Index (PyPI): \n```sh\npython3 -m pip install circle-sdk\n```\n\nThe other option requires you to clone this repo and run\n```sh\npython3 -m pip install -e /Path/to/this/repo/root\n``` \n\n## Python Typing\nWe strongly recommended that you use this SDK with Python typing extensions: we recommend using the VS Code IDE, downloading the [Python IntelliSense extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python), and enabling type checking for your workspace (see [this guide](https://www.emmanuelgautier.com/blog/enable-vscode-python-type-checking)).\n\n## Usage\n\n```python\nimport circle\nfrom circle.apis.tags import subscriptions_api\nfrom circle.model.subscription_request import SubscriptionRequest\nfrom pprint import pprint\n\n# Configure global settings\ncircle.base_url = circle.Environment.SANDBOX_BASE_URL\ncircle.api_key = '<replace-me-with-your-api-key>'\n\n# Choose API driver\napi_instance = subscriptions_api.SubscriptionsApi()\n\n# Prepare request data\nbody = SubscriptionRequest(\n endpoint=\"https://example.org/py/notifications\"\n)\n\n# Send request\ntry:\n api_response = api_instance.create_subscription(body=body)\n pprint(api_response)\nexcept circle.ApiException as e:\n print(\"Exception when calling SubscriptionsApi->create_subscription: %s\\n\" % e)\n\n```\n\n## Development\nClone this repo and install development dependencies using \n\n```sh\n# For codegen tools and git hook checks\nyarn install\n\n# For the Python SDK's dependencies\npython3 -m pip install -r requirements.txt\n```\n\n1. Run the codegen command to generate the source code for thi\ns SDK from the `.openapi-generator/sdk.json` OpenAPI specificat\nion file:\n\n ```sh\n yarn gen-sdk\n ```\n\n## Contributions\n\nPlease follow the [Conventional Commits][convencomms] format for all commits when creating a contributing pull request for this repo.\n\n[convencomms]: https://www.conventionalcommits.org/en/v1.0.0/\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for Circle APIs",
"version": "0.1.0b14",
"project_urls": null,
"split_keywords": [
"circle",
" circle.com",
" usdc",
" euroc",
" stablecoins"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68ee3b57144f023cb30fcaead56d891b9bc5ecf898f910714386988ad0879dd7",
"md5": "60be63b8e83d5c690b111ead5b5a03d6",
"sha256": "226daa179c252280dddfb0f09413d52bf631b83504b053ac69fe86ca265c30f6"
},
"downloads": -1,
"filename": "circle_sdk-0.1.0b14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60be63b8e83d5c690b111ead5b5a03d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1009545,
"upload_time": "2024-03-29T14:45:59",
"upload_time_iso_8601": "2024-03-29T14:45:59.555945Z",
"url": "https://files.pythonhosted.org/packages/68/ee/3b57144f023cb30fcaead56d891b9bc5ecf898f910714386988ad0879dd7/circle_sdk-0.1.0b14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c7f02821e4b93af898a395af26a008384fb3c6b533d30983d6703a0da464d74",
"md5": "bb89ec1335171097fdc5ad0db8f8b536",
"sha256": "6074a2f13161eee30a0af61a3c094b3827261ee8efc4a45f15a462377274a351"
},
"downloads": -1,
"filename": "circle-sdk-0.1.0b14.tar.gz",
"has_sig": false,
"md5_digest": "bb89ec1335171097fdc5ad0db8f8b536",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 223753,
"upload_time": "2024-03-29T14:46:02",
"upload_time_iso_8601": "2024-03-29T14:46:02.315175Z",
"url": "https://files.pythonhosted.org/packages/8c/7f/02821e4b93af898a395af26a008384fb3c6b533d30983d6703a0da464d74/circle-sdk-0.1.0b14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 14:46:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "circle-sdk"
}
JSON