Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs cleanup #30

Merged
merged 3 commits into from
Nov 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions CHANGELOG.md

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) [year] [fullname]
Copyright (c) [2021] [janezpodhostnik]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ title: Flow Python SDK
description: Packages for Python developers to build applications that interact with the Flow network
contentType: INTRO
---

The Flow Python SDK provides a set of packages for Python developers to build applications that interact with the Flow network.

[![PyPI](https://img.shields.io/pypi/v/flow-py-sdk.svg)](https://pypi.org/project/flow-py-sdk/)
[![codecov](https://codecov.io/gh/janezpodhostnik/flow-py-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/codecov/example-go)


See the [DOCS](https://janezpodhostnik.github.io/flow-py-sdk)!
See the [guide](https://janezpodhostnik.github.io/flow-py-sdk)!


Note: This SDK is also fully compatible with the Flow Emulator and can be used for local development.
Expand All @@ -24,22 +25,14 @@ pip install flow-py-sdk

or if using poetry:

`poetry add flow-py-sdk`

## Run examples

To run example first you need to install flow emulator and run it locally.

[go step-by-step based on your OS](https://github.com/onflow/flow-cli#flow-cli)

then install dependencies. to install dependencies of flow SDk run:

`poetry install`

after that run flow emulator in example directory, using:
```sh
poetry add flow-py-sdk
```

`flow emulator`
## Contributors

and then you can run examples using:
<a href="https://github.com/janezpodhostnik/flow-py-sdk/graphs/contributors">
<img src="https://contrib.rocks/image?repo=janezpodhostnik/flow-py-sdk" />
</a>

`poetry run examples`
Made with [contrib.rocks](https://contrib.rocks).
234 changes: 0 additions & 234 deletions docs/account_&_contract.mdx

This file was deleted.

55 changes: 55 additions & 0 deletions docs/api_docs/client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Client API Docs

## Create a flow client

::: flow_py_sdk.flow_client

## Query Blocks

::: flow_py_sdk.AccessAPI.get_latest_block_header

::: flow_py_sdk.AccessAPI.get_block_header_by_i_d

::: flow_py_sdk.AccessAPI.get_block_header_by_height

::: flow_py_sdk.AccessAPI.get_latest_block

::: flow_py_sdk.AccessAPI.get_block_by_i_d

::: flow_py_sdk.AccessAPI.get_block_by_height

## Accounts

::: flow_py_sdk.AccessAPI.get_account

::: flow_py_sdk.AccessAPI.get_account_at_latest_block

::: flow_py_sdk.AccessAPI.get_account_at_block_height

## Transactions

::: flow_py_sdk.AccessAPI.get_transaction_result

::: flow_py_sdk.AccessAPI.get_transaction

::: flow_py_sdk.AccessAPI.execute_transaction

::: flow_py_sdk.AccessAPI.send_transaction

## Events

::: flow_py_sdk.AccessAPI.get_events_for_height_range

::: flow_py_sdk.AccessAPI.get_events_for_block_i_ds

## Collections

::: flow_py_sdk.AccessAPI.get_collection_by_i_d

## Scripts

::: flow_py_sdk.AccessAPI.execute_script_at_latest_block

::: flow_py_sdk.AccessAPI.execute_script_at_block_i_d

::: flow_py_sdk.AccessAPI.execute_script_at_block_height
5 changes: 5 additions & 0 deletions docs/api_docs/keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Keys

## Generate new keys

::: flow_py_sdk.AccountKey.from_seed
9 changes: 9 additions & 0 deletions docs/api_docs/signer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Signer

## Signer Base Class

::: flow_py_sdk.Signer

## In Memory signer Implementation

::: flow_py_sdk.InMemorySigner
Loading