- RPC query engine
- Cryptography
- Building and parsing operations
- Smart contract interaction
- Local forging/packing & vice versa
- Working with Michelson AST
- Generating contract parameter/storage schema
- Activating and revealing accounts
- Deploying contracts (+ GitHub integration)
- Builtin interpreter (reimplemented)
- Set of extra helpers (stack visualization, blockchain context mocking)
- Custom interpreter with runtime type checker
- Syntax highlighting, autocomplete with
Tab - In-place docstrings with
Shift+Tab - Macros support
- Verbose execution logging
- Debug helpers
- Writing integration tests using
unittestpackage - Simulating contract execution using remote intepreter (via RPC) or builtin one
Make sure you have Python 3.8 to 3.12 installed and set as default in the system.
You also need to install cryptographic packages before installing the library/building the project:
$ sudo apt install libsodium-dev libgmp-dev pkg-config$ sudo pacman -Syu --needed libsodium gmpHomebrew needs to be installed.
$ brew install libsodium gmp pkg-configIn case libsodium or gmp cannot find either include or lib paths, try explicitly set environment vars:
export CFLAGS="-I/opt/homebrew/Cellar/gmp/6.2.1_1/include/ -L/opt/homebrew/Cellar/gmp/6.2.1_1/lib/"
export DYLD_LIBRARY_PATH=/opt/homebrew/lib/
pip3 install --user pytezosFor running tests you might also need to export LD_LIBRARY_PATH:
export LD_LIBRARY_PATH=/opt/homebrew/lib/The recommended way is to use WSL and then follow the instructions for Linux, but if you feel lucky you can try to install natively:
- Install MinGW from https://osdn.net/projects/mingw/
- Make sure
C:\MinGW\binis added to yourPATH - Download the latest libsodium-X.Y.Z-msvc.zip from https://download.libsodium.org/libsodium/releases/.
- Extract the Win64/Release/v143/dynamic/libsodium.dll from the zip file
- Copy libsodium.dll to C:\Windows\System32\libsodium.dll
$ pip install wheel setuptools pkginfo cryptography
$ pip install pytezos>>> !apt install libsodium-dev libgmp-dev
>>> !pip install pytezosVerified & minified images for CI/CD https://hub.docker.com/r/bakingbad/pytezos/tags
$ # 1. Use image from registry
$ docker pull bakingbad/pytezos
$ # or build it yourself
$ docker build . -t pytezos
$ # 2. Use included docker-compose.yml
$ docker-compose up -d notebookRequirements:
- Python 3.8 to 3.12
- libsodium, coincurve, gmp
- make
$ # prepare environment
$ make install
# # run full CI with tests
$ make allRead quick start guide
Learn how to enable Jupyter with Michelson
Check out a complete API reference
If you are working in Jupyter/Google Colab or any other interactive console, you can display documentation for a particular class/method:
>>> from pytezos import pytezos
>>> pytezos-
Pytezos 2.0 release with embedded docs and smart contract interaction engine
https://medium.com/coinmonks/high-level-interface-for-michelson-contracts-and-not-only-7264db76d7ae -
Materials from TQuorum:Berlin workshop - building an app on top of PyTezos and ConseilPy
https://medium.com/coinmonks/atomic-tips-berlin-workshop-materials-c5c8ee3f46aa -
Materials from the EETH hackathon - setting up a local development infrastructure, deploying and interacting with a contract
https://medium.com/tezoscommons/preparing-for-the-tezos-hackathon-with-baking-bad-45f2d5fca519 -
Introducing integration testing engine
https://medium.com/tezoscommons/testing-michelson-contracts-with-pytezos-513718499e93
- Telegram chat: @baking_bad_chat
- Slack channel: #baking-bad
- The project was initially started by Arthur Breitman, now it's maintained by Baking Bad team.
- Baking Bad is supported by Tezos Foundation
- Michelson test set from the Tezos repo is used to ensure the interpreter workability
- Michelson structured documentation by Nomadic Labs is used for inline help