Skip to content

threefoldfoundation/Grid3.py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grid3.py

This is a collection of Python modules for working with ThreeFold Grid v3. It's designed foremostly for interactive use on the REPL and joyful scripting. We value conciseness and trying to do what you meant, even at the expense of a few extra CPU cycles.

The following are included:

  • Client for querying data from GraphQL and Grid Proxy
  • TFChain client mostly for queries but can also be used for submitting extrinsics
  • Some minting related code, including minting period calculations
  • RMB client based on RMB Peer (external processes required)
  • Basic wrapper around tfcmd for creating deployments

If you're looking for a complete Grid v3 SDK, they are availalbe for Go and Typescript.

Installation

Tldr: pip install grid3

Requirements

Most of the functionality just requires python3.8 or newer.

The Reliable Message Bus functionality is Linux only and also depends on:

Detailed install

Assuming that python is python3 and pip is pip3, install the latest release from PyPI into a venv using pip:

python -m venv venv
source venv/bin/activate
pip install grid3

Quick tour

With the graphql module, you can easily answer questions like, how many nodes are currently in the standby state that were online in the last 24 hours?

import time, grid3.network
mainnet = grid3.network.GridNetwork()
sleepers = mainnet.graphql.nodes(['nodeID'], power={'state_eq': 'Down'}, updatedAt_gt=int(time.time()) - 24 * 60 * 60)
print(len(sleepers))

We just executed a query against the mainnet GraphQL endpoint nodes without even sweating a line break. Pretty cool!

About

Python modules for ThreeFold Grid3

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages