Metadata-Version: 2.1
Name: flow-py-sdk
Version: 0.1.3
Summary: A python SKD for the flow blockchain
Home-page: https://github.com/janezpodhostnik/flow-py-sdk
License: MIT
Author: Janez Podhostnik
Author-email: janez.podhostnik@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Dist: betterproto[compiler] (>=1.2.5,<2.0.0)
Requires-Dist: ecdsa (>=0.16.1,<0.17.0)
Requires-Dist: grpcio-tools (>=1.33.2,<2.0.0)
Requires-Dist: grpclib (>=0.4.1,<0.5.0)
Requires-Dist: rlp (>=2.0.1,<3.0.0)
Project-URL: Repository, https://github.com/janezpodhostnik/flow-py-sdk
Description-Content-Type: text/markdown

[![PyPI](https://img.shields.io/pypi/v/flow-py-sdk.svg)](https://pypi.org/project/flow-py-sdk/) 

# flow-py-sdk

Another unofficial flow blockchain python sdk.

Under development! I do not recommend you use this.

If you do want to use it do:

`pip install flow-py-sdk`

It supports python version 3.9 or higher

##Contributing

### Prerequisites

- [poetry](https://python-poetry.org/docs/)
- python 3.9^

### Running tests

Tests can be run using `poetry`.

```bash
poetry run pytest
```

### Running the examples locally

Install the [Flow CLI](https://docs.onflow.org/flow-cli).

Start the Flow Emulator in the `examples` directory of this repository (tha is where the `flow.json` is).

- `flow emulator start`
- `poetry install`
- `poetry build` (only the first time)
- `poetry run examples`

## Roadmap to MVP

### Docs

- [ ] Create docs folder
- [ ] Usage example docs:
    - [ ] using the emulator
    - [ ] create account
- [ ] contribution docs

### Examples

- [ ] move examples folder to root folder
- [ ] make each example runnable separately
- [ ] write instructions for running examples
- [ ] add more comments to examples
- [x] add examples to ci
- [ ] add more examples

### Tests

- [ ] add cadence decode/encode tests
- [ ] add more tests
- [x] add CI for tests

### CI

- [ ] release automation

### Implementation

- [ ] decode event payload from grpc
- [ ] implement TODOs in cadence decode/encode
- [ ] add an easy way to subscribe to blockchain events

