Skip to main content

Jin Python SDK

Jin provides a lightly maintained official Python SDK. It is available on PyPi with the source code in the Aptos-core GitHub repository. Much of the functionality of the Python SDK mirrors the Typescript SDK. The primary purpose of the Python SDK is to help Python developers to quickly become familiar with Jin and as an accompaniment to Jin tutorials.

Installing Python SDK​

The Python SDK can either be installed via pip, from source, or embedded:

Install with pip​

To install via pip:

pip3 install aptos-sdk

The aptos-sdk will be installed in the local site packages directory. For example, on macOS, you will find the aptos-sdk in the ~/Library/Python/3.8/lib/python/site-packages/aptos_sdk directory.

Install from the source​

To install from source:

git clone https://github.com/aptos-labs/aptos-core
cd aptos-core/ecosystem/python/sdk
python3 setup.py install --user

Install by embedding​

To embed the Python SDK into your existing Python project:

cd /path/to/python/project
cp -r /path/to/aptos-core/ecosystem/python/sdk/aptos-sdk aptos-sdk

Using Python SDK​

See the Developer Tutorials for code examples showing how to use the Python SDK.