pybundlr 0.0.5

Simple py driver for bundlr

pybundlr

Simple py driver for bundlr

Constructed by wrapping bundlr CLI.

Prerequisites

Ensure prerequisites:

• Linux/MacOS
• Python 3.8.5+
• Bundlr CLI: npm install -g @bundlr-network/client

Install Pybundlr Library

Open a new terminal and:

#Create & activate venv
python -m venv venv
source venv/bin/activate

#main install
pip install pybundlr

Using Pybundlr Library

From terminal: python. Then, in Python console:

from pybundlr import pybundlr
address = "Ry2bDGfBIvYtvDPYnf0eg_ijH4A1EDKaaEEecyjbUQ4"
bal = pybundlr.balance(address)
print(f"bal: {bal}")

Developing pybundlr

This section is for those further improving the pybundlr library.

Installation

In a new terminal:

#clone the repo and enter into it
git clone https://github.com/oceanprotocol/pybundlr
cd pybundlr

#Create & activate venv
python -m venv venv
source venv/bin/activate

#Install modules in the environment
pip install -r requirements.txt

Usage

From the same terminal: python. Then, in Python console:

from src.pybundlr import pybundlr
address = "Ry2bDGfBIvYtvDPYnf0eg_ijH4A1EDKaaEEecyjbUQ4"
bal = pybundlr.balance(address)
print(f"bal: {bal}")

Release Process

Find the current version number at pypi.

Open pyproject.toml in an editor, and update the value in "version" = x.y.z.

In terminal:

#go to root of directory
cd ~/code/pybundlr

#ensure repo is up-to-date
git commit -am "Release x.y.z"
git push

#turn off virtual env't
deactivate

#ensure `dist/` folder is empty
rm -rf dist

#generate distribution archives: create `dist` folder with two files 
python -m build

#run twine to upload `dist` files
python -m twine upload dist/*

# -when prompted, give username: __token__
# -when prompted, given password: <pypi API token>

Done! The updated package will be at pypi.

Notes: this section is based on packaging.python.org tutorial.