Python SDK for Circle APIs
Project description
Circle APIs Python Library
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. Also see this project's PyPI package page.
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):
python3 -m pip install circle-sdk
The other option requires you to clone this repo and run
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, and enabling type checking for your workspace (see this guide).
Usage
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
# For codegen tools and git hook checks
yarn install
# For the Python SDK's dependencies
python3 -m pip install -r requirements.txt
-
Run the codegen command to generate the source code for thi s SDK from the
.openapi-generator/sdk.json
OpenAPI specificat ion file:yarn gen-sdk
Contributions
Please follow the Conventional Commits format for all commits when creating a contributing pull request for this repo.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for circle_sdk-0.1.0b5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 714a5e15e341f3368b6f3964e0a3b796174b81f9a5c8ae53fd8e2b168232a3a8 |
|
MD5 | 9d08a24b0d91765ad9fce5e44b3d61c6 |
|
BLAKE2b-256 | f37af8f05cd08b1d7dc8289760f0abe93bcee1f7b28f85aadeb2291d8ea06ec9 |