aptos-sdk 0.1.0.0

No project description provided

Aptos Python SDK

You need to connect to an Aptos node to use this library, or run one yourself locally.

Usage

Currently this is still in development and is unsuitable for directly interfacing with Aptos.

Requirements

• Black
• PyNaCl

Testing

To run all unit tests:

python3 -m unittest discover -s aptos_sdk/ -p '*.py' -t ..

To run all end-to-end tests:

ln -s `pwd`/aptos_sdk examples/
python3 -m examples.coin
python3 -m examples.token

Note: end-to-end tests rely on Aptos Devnet.

Autoformatting

find aptos_sdk -type f -name "*.py" | xargs python3 -m black
find aptos_sdk -type f -name "*.py" | xargs python3 -m autoflake -i -r --remove-all-unused-imports --remove-unused-variables --ignore-init-module-imports
find aptos_sdk -type f -name "*.py" | xargs python3 -m isort

Generating types

The Python openapi-python-client tool cannot parse references. Therefore there are three options:

• Use swagger-cli to dereference, gain a type explosion, and still have missing types
• Live without missing types
• Write a pure python implementation with no autogenerated code

Currently the team is moving forward with pure python, but leaves the following notes for the curious:

npm install  -g @apidevtools/swagger-cli
swagger-cli bundle --dereference ../../../api/doc/v0/openapi.yaml  -t yaml > openapi.yaml
python3 -m openapi_python_client generate --path openapi.yaml
mv aptos-dev-api-specification-client/aptos_dev_api_specification_client/ aptos_sdk/openapi

Semantic versioning

This project follows semver as closely as possible