Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.

Installation:

pip install yandexcloud 

There are several options for authorization your requests - OAuth Token, Metadata Service (if you're executing your code inside VMs or Cloud Functions running in Yandex.Cloud), Service Account Keys, and externally created IAM tokens.

sdk=yandexcloud.SDK(token='AQAD-.....')

Don't forget to assign Service Account for your Instance or Function and grant required roles.

sdk=yandexcloud.SDK()

# you can store and read it from JSON filesa_key={"id": "...", "service_account_id": "...", "private_key": "..." } sdk=yandexcloud.SDK(service_account_key=sa_key)

sdk=yandexcloud.SDK(iam_token="t1.9eu...")

Check examples directory for more examples.

fromyandex.cloud.vpc.v1.network_service_pb2_grpcimportNetworkServiceStubfromyandexcloudimportSDKsdk=SDK(iam_token="t1.9eu...") new_network_client_endpoint="example.new.vpc.very.new.yandex:50051"insecure=False# by default is False, but if server does not support verification can be set to Truenetwork_client=sdk.client(NetworkServiceStub, endpoint=new_network_client_endpoint, insecure=False)

To override endpoints provide dict in format{alias : new-endpoint}

fromyandex.cloud.vpc.v1.network_service_pb2_grpcimportNetworkServiceStubfromyandexcloudimportSDKnew_network_client_endpoint="example.new.vpc.very.new.yandex:50051"sdk=SDK(iam_token="t1.9eu...", endpoints={"vpc": new_network_client_endpoint}) insecure=False# by default is False, but if server does not support verification can be set to Truenetwork_client=sdk.client(NetworkServiceStub, insecure=False)

Notice: if both overrides are used for same endpoint, override by client has priority

fromyandexcloudimportSDK, set_up_yc_api_endpointkz_region_endpoint="api.yandexcloud.kz"# this will make SDK list endpoints from KZ yc installationsdk=SDK(iam_token="t1.9eu...", endpoint="api.yandexcloud.kz") # or you can use global functionset_up_yc_api_endpoint(kz_region_endpoint)

SDK provide built-in retry policy, that supports exponential backoff and jitter, and also retry budget. It's necessary to avoid retry amplification.

importgrpcfromyandexcloudimportSDK, RetryPolicysdk=SDK(retry_policy=RetryPolicy())

SDK provide different modes for retry throttling policy:

• persistent is suitable when you use SDK in any long-lived application, when SDK instance will live long enough for manage budget;
• temporary is suitable when you use SDK in any short-lived application, e.g. scripts or CI/CD.

By default, SDK will use temporary mode, but you can change it through throttling_mode argument.

We use uv to manage dependencies and run commands in Makefile. Install it with official standalone installer: curl -LsSf https://astral.sh/uv/install.sh | sh

Use make deps command to install library, its production and development dependencies.

uv add cryptography

add to dev extras section uv add pre-commit --group dev

add to genproto extras section uv add grpcio-tools --group genproto

Setup pre-commit and commit-msg hooks with make git-hooks command.

Use make format to autoformat code with black tool.

• make test to run tests for current python version
• make lint to run only linters for current python version
• make tox-current to run all checks (tests + code style checks + linters + format check) for current python version
• make tox to run all checks for all supported (installed in your system) python versions
• make test-all-versions to run all checks for all supported python versions in docker container

Use https://github.com/nektos/act

If pull request consists of several meaningful commits, that should be preserved, then use "Rebase and merge" option. Otherwise use "Squash and merge".

New release (changelog, tag and pypi upload) will be automatically created on each push to master via Github Actions workflow.