# PyMavryk
[](https://badge.fury.io/py/pytezos)
[](https://github.com/baking-bad/pytezos/actions?query=workflow%3ATests)
[](https://hub.docker.com/r/bakingbad/pytezos)
[](ttps://www.python.org)
[](https://opensource.org/licenses/MIT)
[](https://mybinder.org/v2/gh/baking-bad/pytezos/master?filepath=michelson_quickstart.ipynb)
* RPC query engine
* Cryptography
* Building and parsing operations
* Smart contract interaction
* Local forging/packing & vice versa
* Working with Michelson AST
#### PyMavryk CLI
* Generating contract parameter/storage schema
* Activating and revealing accounts
* Deploying contracts (+ GitHub integration)
#### Michelson REPL
* Builtin interpreter (reimplemented)
* Set of extra helpers (stack visualization, blockchain context mocking)
#### Michelson Jupyter kernel
* Custom interpreter with runtime type checker
* Syntax highlighting, autocomplete with `Tab`
* In-place docstrings with `Shift+Tab`
* Macros support
* Verbose execution logging
* Debug helpers
#### Michelson integration testing framework
* Writing integration tests using `unittest` package
* Simulating contract execution using remote intepreter (via RPC) or builtin one
## Installation
Make sure you have Python 3.8+ installed and set as default in the system.
You also need to install cryptographic packages before installing the library/building the project:
#### Linux
##### Ubuntu, Debian and other apt-based distributions
```shell
$ sudo apt install libsodium-dev libsecp256k1-dev libgmp-dev pkg-config
```
##### Arch Linux
```shell
$ sudo pacman -Syu --needed libsodium libsecp256k1 gmp
```
#### MacOS
[Homebrew](https://brew.sh/) needs to be installed.
```shell
$ brew tap cuber/homebrew-libsecp256k1
$ brew install libsodium libsecp256k1 gmp pkg-config
```
##### M1 (ARM)
In case `secp256k1` or `gmp` cannot find either include or lib paths, try explicitly set environment vars:
```
CFLAGS="-I/opt/homebrew/Cellar/gmp/6.2.1_1/include/ -L/opt/homebrew/Cellar/gmp/6.2.1_1/lib/" LIB_DIR="/opt/homebrew/Cellar/libsecp256k1/0.1/lib" INCLUDE_DIR=/opt/homebrew/Cellar/libsecp256k1/0.1/include pip3 install --user pymavryk
```
For running tests you might also need to export `LD_LIBRARY_PATH`:
```
export LD_LIBRARY_PATH=/opt/homebrew/lib/
```
#### Windows
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:
1. Install MinGW from [https://osdn.net/projects/mingw/](https://osdn.net/projects/mingw/)
2. Make sure `C:\MinGW\bin` is added to your `PATH`
3. Download the latest libsodium-X.Y.Z-msvc.zip from [https://download.libsodium.org/libsodium/releases/](https://download.libsodium.org/libsodium/releases/).
4. Extract the Win64/Release/v143/dynamic/libsodium.dll from the zip file
5. Copy libsodium.dll to C:\Windows\System32\libsodium.dll
### From PyPi
```shell
$ pip install wheel setuptools pkginfo cryptography
$ pip install pymavryk
```
### [Google Colab](https://colab.research.google.com)
`````python
>>> !apt install libsodium-dev libsecp256k1-dev libgmp-dev
>>> !pip install pymavryk
`````
### Docker container
Verified & minified images for CI/CD https://hub.docker.com/r/mavrykdynamics/pymavryk/tags
```shell
$ # 1. Use image from registry
$ docker pull mavrykdynamics/pymavryk
$ # or build it yourself
$ docker build . -t pymavryk
$ # 2. Use included docker-compose.yml
$ docker-compose up -d notebook
```
### Building from sources
Requirements:
* Python 3.8+
* libsodium, libsecp256k1, gmp
* make
```shell
$ # prepare environment
$ make install
# # run full CI with tests
$ make
```
## Quick start
Read [quick start guide](https://pytezos.org/quick_start.html)
Learn how to [enable Jupyter with Michelson](./src/michelson_kernel/README.md)
## API reference
Check out a complete [API reference](https://pytezos.org/contents.html)
### Inline documentation
If you are working in Jupyter/Google Colab or any other interactive console,
you can display documentation for a particular class/method:
```python
>>> from pymavryk import pymavryk
>>> pymavryk
```
### Publications
* Pymavryk 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 PyMavryk 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
### Contact
* Telegram chat: [@baking_bad_chat](https://t.me/baking_bad_chat)
* Slack channel: [#baking-bad](https://tezos-dev.slack.com/archives/CV5NX7F2L)
## Credits
* 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
Raw data
{
"_id": null,
"home_page": "https://pytezos.org",
"name": "pymavryk",
"maintainer": "Tristan Allaire",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "tristan@mavryk.io",
"keywords": "mavryk,blockchain,sdk,michelson,repl,cryptocurrencies,smart-contracts,jupyter,ipython,docker,crypto",
"author": "Michael Zaikin",
"author_email": "mz@baking-bad.org",
"download_url": "https://files.pythonhosted.org/packages/9d/8e/902673db1d190ac11972fca1090e266c5dd2c358639848acc3e40d8827e8/pymavryk-3.10.3.tar.gz",
"platform": null,
"description": "# PyMavryk\n\n[](https://badge.fury.io/py/pytezos)\n[](https://github.com/baking-bad/pytezos/actions?query=workflow%3ATests)\n[](https://hub.docker.com/r/bakingbad/pytezos)\n[](ttps://www.python.org)\n[](https://opensource.org/licenses/MIT)\n[](https://mybinder.org/v2/gh/baking-bad/pytezos/master?filepath=michelson_quickstart.ipynb)\n\n\n* RPC query engine\n* Cryptography\n* Building and parsing operations\n* Smart contract interaction\n* Local forging/packing & vice versa\n* Working with Michelson AST\n\n#### PyMavryk CLI\n* Generating contract parameter/storage schema\n* Activating and revealing accounts\n* Deploying contracts (+ GitHub integration)\n\n#### Michelson REPL\n* Builtin interpreter (reimplemented)\n* Set of extra helpers (stack visualization, blockchain context mocking)\n\n#### Michelson Jupyter kernel\n* Custom interpreter with runtime type checker\n* Syntax highlighting, autocomplete with `Tab`\n* In-place docstrings with `Shift+Tab`\n* Macros support\n* Verbose execution logging\n* Debug helpers\n\n#### Michelson integration testing framework\n* Writing integration tests using `unittest` package\n* Simulating contract execution using remote intepreter (via RPC) or builtin one\n\n\n## Installation\n\nMake sure you have Python 3.8+ installed and set as default in the system. \n\nYou also need to install cryptographic packages before installing the library/building the project:\n\n#### Linux\n\n##### Ubuntu, Debian and other apt-based distributions\n```shell\n$ sudo apt install libsodium-dev libsecp256k1-dev libgmp-dev pkg-config\n```\n\n##### Arch Linux\n```shell\n$ sudo pacman -Syu --needed libsodium libsecp256k1 gmp\n```\n#### MacOS\n\n[Homebrew](https://brew.sh/) needs to be installed.\n```shell\n$ brew tap cuber/homebrew-libsecp256k1\n$ brew install libsodium libsecp256k1 gmp pkg-config\n```\n\n##### M1 (ARM)\n\nIn case `secp256k1` or `gmp` cannot find either include or lib paths, try explicitly set environment vars:\n```\nCFLAGS=\"-I/opt/homebrew/Cellar/gmp/6.2.1_1/include/ -L/opt/homebrew/Cellar/gmp/6.2.1_1/lib/\" LIB_DIR=\"/opt/homebrew/Cellar/libsecp256k1/0.1/lib\" INCLUDE_DIR=/opt/homebrew/Cellar/libsecp256k1/0.1/include pip3 install --user pymavryk\n```\n\nFor running tests you might also need to export `LD_LIBRARY_PATH`:\n```\nexport LD_LIBRARY_PATH=/opt/homebrew/lib/\n```\n\n#### Windows\n\nThe recommended way is to use WSL and then follow the instructions for Linux,\nbut if you feel lucky you can try to install natively:\n\n1. Install MinGW from [https://osdn.net/projects/mingw/](https://osdn.net/projects/mingw/)\n2. Make sure `C:\\MinGW\\bin` is added to your `PATH`\n3. Download the latest libsodium-X.Y.Z-msvc.zip from [https://download.libsodium.org/libsodium/releases/](https://download.libsodium.org/libsodium/releases/).\n4. Extract the Win64/Release/v143/dynamic/libsodium.dll from the zip file\n5. Copy libsodium.dll to C:\\Windows\\System32\\libsodium.dll\n\n### From PyPi\n\n```shell\n$ pip install wheel setuptools pkginfo cryptography\n$ pip install pymavryk\n```\n\n### [Google Colab](https://colab.research.google.com)\n\n`````python\n>>> !apt install libsodium-dev libsecp256k1-dev libgmp-dev\n>>> !pip install pymavryk\n`````\n\n### Docker container\nVerified & minified images for CI/CD https://hub.docker.com/r/mavrykdynamics/pymavryk/tags\n```shell\n$ # 1. Use image from registry\n$ docker pull mavrykdynamics/pymavryk\n$ # or build it yourself\n$ docker build . -t pymavryk\n$ # 2. Use included docker-compose.yml\n$ docker-compose up -d notebook\n```\n\n### Building from sources\n\nRequirements:\n* Python 3.8+\n* libsodium, libsecp256k1, gmp\n* make\n\n```shell\n$ # prepare environment\n$ make install\n# # run full CI with tests\n$ make\n```\n\n## Quick start\nRead [quick start guide](https://pytezos.org/quick_start.html) \nLearn how to [enable Jupyter with Michelson](./src/michelson_kernel/README.md)\n\n## API reference\nCheck out a complete [API reference](https://pytezos.org/contents.html)\n\n### Inline documentation\nIf you are working in Jupyter/Google Colab or any other interactive console, \nyou can display documentation for a particular class/method:\n\n```python\n>>> from pymavryk import pymavryk\n>>> pymavryk\n```\n\n### Publications\n\n* Pymavryk 2.0 release with embedded docs and smart contract interaction engine \nhttps://medium.com/coinmonks/high-level-interface-for-michelson-contracts-and-not-only-7264db76d7ae\n\n* Materials from TQuorum:Berlin workshop - building an app on top of PyMavryk and ConseilPy \nhttps://medium.com/coinmonks/atomic-tips-berlin-workshop-materials-c5c8ee3f46aa\n\n* Materials from the EETH hackathon - setting up a local development infrastructure, deploying and interacting with a contract \nhttps://medium.com/tezoscommons/preparing-for-the-tezos-hackathon-with-baking-bad-45f2d5fca519\n\n* Introducing integration testing engine \nhttps://medium.com/tezoscommons/testing-michelson-contracts-with-pytezos-513718499e93\n\n### Contact\n* Telegram chat: [@baking_bad_chat](https://t.me/baking_bad_chat)\n* Slack channel: [#baking-bad](https://tezos-dev.slack.com/archives/CV5NX7F2L)\n\n## Credits\n* The project was initially started by Arthur Breitman, now it's maintained by Baking Bad team.\n* Baking Bad is supported by Tezos Foundation\n* Michelson test set from the Tezos repo is used to ensure the interpreter workability\n* Michelson structured documentation by Nomadic Labs is used for inline help\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python toolkit for Mavryk",
"version": "3.10.3",
"project_urls": {
"Homepage": "https://pytezos.org",
"Repository": "https://github.com/mavryk-network/pymavryk"
},
"split_keywords": [
"mavryk",
"blockchain",
"sdk",
"michelson",
"repl",
"cryptocurrencies",
"smart-contracts",
"jupyter",
"ipython",
"docker",
"crypto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c988b3ec74b74e93f46f1949146a6817eb77a4ec5328a0a71706aaf53052e13",
"md5": "608ab03c26b5215e69d5187c45be22d7",
"sha256": "64eec3dfc68b882fe140fc528209d91a95a5246e46928a79831e6c13b2f5f05c"
},
"downloads": -1,
"filename": "pymavryk-3.10.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "608ab03c26b5215e69d5187c45be22d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 208676,
"upload_time": "2023-12-01T06:09:57",
"upload_time_iso_8601": "2023-12-01T06:09:57.765268Z",
"url": "https://files.pythonhosted.org/packages/4c/98/8b3ec74b74e93f46f1949146a6817eb77a4ec5328a0a71706aaf53052e13/pymavryk-3.10.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d8e902673db1d190ac11972fca1090e266c5dd2c358639848acc3e40d8827e8",
"md5": "94b919ef67f7d4279f94454aef824391",
"sha256": "44ce96baa6732367e5606a8d247bb4eac52183f4a5541bfbe87a624fcfb79302"
},
"downloads": -1,
"filename": "pymavryk-3.10.3.tar.gz",
"has_sig": false,
"md5_digest": "94b919ef67f7d4279f94454aef824391",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 165626,
"upload_time": "2023-12-01T06:10:00",
"upload_time_iso_8601": "2023-12-01T06:10:00.315723Z",
"url": "https://files.pythonhosted.org/packages/9d/8e/902673db1d190ac11972fca1090e266c5dd2c358639848acc3e40d8827e8/pymavryk-3.10.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-01 06:10:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mavryk-network",
"github_project": "pymavryk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pymavryk"
}
JSON
