mention Py 3.10 is required and tweak Markdown formatting

This commit is contained in:
Kenneth Bingham 2023-10-18 13:28:29 -04:00
parent e1f6e1866a
commit 58c8292c88
No known key found for this signature in database
GPG Key ID: 31709281860130B6

View File

@ -1,36 +1,55 @@
# zrok Pastebin
This example shows the use of the zrok SDK spinning up a simple pastebin command.
## Setup :wrench:
Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok environment needed for this example.
## Self-hosting Setup :wrench:
You don't need this section if you're using hosted zrok from NetFoundry (https://api.zrok.io/).
Refer to the [setup guide](../../../docs/guides/self-hosting/self_hosting_guide.md) for details on setting up your zrok
environment if you're self-hosting zrok.
### Install Python Requirements
The zrok SDK requires Python 3.10 or later.
If you haven't already installed them, you'll need the dependent libraries used in the examples.
```bash
pip install -r ../requirements
```
```bash
pip install -r ./sdk/python/examples/requirements.txt
```
## Running the Example :arrow_forward:
This example contains a `copyto` server portion and `pastefrom` client portion.
This example contains a `copyto` server portion and `pastefrom` client portion.
### copyto
The server portion expects to get data you want to send via stdin. It can be evoked by:
```shell
```bash
echo "this is a cool test" | python pastebin.py copyto
```
You should see some helpful info printed out to your terminal:
```shell
```bash
access your pastebin using 'pastebin.py pastefrom vp0xgmknvisu'
```
The last token in that line is your share token. We'll use that in the pastefrom command to access our data.
### pastefrom
The `pastefrom` client expects the share token as an argument.
If we envoke it using the same token as above:
```shell
```bash
python pastebin.py pastefrom vp0xgmknvisu
```
we see the data we had piped into the `copyto` server:
```
```text
this is a cool test
```
```