Skip to content

Commit 220816e

Browse files
committed
Merge branch 'main' of https://github.com/krunch3r76/gc__listoffers into main
2 parents 107cbcf + 0d4ebad commit 220816e

File tree

1 file changed

+28
-36
lines changed

1 file changed

+28
-36
lines changed

README.md

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,56 +16,35 @@ https://user-images.githubusercontent.com/46289600/145339421-674182ae-457d-4111-
1616

1717

1818

19-
20-
# how to interpet the interface
21-
if name or address headings are clicked on, sorting is strictly on either of these. however, if you click any of the other columns, sorting occurs from left to right, first sorting on the far left, then next level on the right, and so on.
22-
23-
24-
25-
# requirements
26-
27-
yapapi must be installed
28-
29-
for systems that do not allow https outbound connection, either yagna or golemsp must be running and the app-key should be in the environment (see section on app-key for details)
30-
31-
_python should have been compiled with Tcl support_. this is the default on Windows. this is available as a package on ubuntu. see below.
32-
19+
# usage
20+
## ensure python3-tk is installed
3321
```bash
3422
(ubuntu) $ sudo apt-get install python3-tk
35-
$ pip install yapapi -U
36-
# start yagna or golemsp
37-
$ yagna service run
38-
$ # golemsp run
3923
```
40-
41-
42-
# usage
43-
first clone it:
24+
## clone, setup python environment, and run
4425
```bash
4526
$ git clone https://github.com/krunch3r76/gc__listoffers.git
4627
$ cd gc__listoffers
4728
$ git checkout v0.1.13
4829
$ python3 -m venv myvenv
4930
$ . myvenv/bin/activate
5031
(myvenv) $ pip install yapapi
51-
52-
```
53-
54-
## starting
55-
### starting locally
56-
```bash
57-
# export YAGNA_APPKEY=<appkey> # if not already done. see section "what is an app key?" below on getting it
5832
(myvenv) $ python3 application.py
5933
```
6034

61-
### starting for remote interaction
62-
```bash
63-
# on the machine running yagna/golemsp, e.g. in docker, wsl, vmware
64-
(server) ./gc__listoffers (myvenv) $ python3 application.py serve localhost 8000
35+
# how to interpet the interface
36+
if name or address headings are clicked on, sorting is strictly on either of these. however, if you click any of the other columns, sorting occurs from left to right, first sorting on the far left, then next level on the right, and so on.
37+
38+
# requirements
39+
40+
yapapi must be installed
41+
42+
for systems that do not allow https outbound connection, either yagna or golemsp must be running and the app-key should be in the environment (see section on app-key for details)
43+
44+
_python should have been compiled with Tcl support_. this is the default on Windows. this is available as a package on ubuntu. see below.
45+
46+
**if https connections are not allowed on your machine, it is necessary to be running yagna or golemsp, see the advanced section for this**
6547

66-
# on the remote machine (Windows okay)
67-
(client) ./gc__listoffers $ python3 application.py client <ip-address-of-server> 8000
68-
```
6948

7049
## usage tips
7150
touch the radio button pertaining to the subnet of interest
@@ -80,6 +59,19 @@ the total number of offers is listed in large digits near the right
8059

8160
see offer details via the contextual menu system!
8261

62+
63+
64+
# advanced
65+
### starting for remote interaction (for systems without internet connectivity besides golem)
66+
```bash
67+
# on the machine running yagna/golemsp, e.g. in docker, wsl, vmware
68+
$ export YAGNA_APPKEY=<appkey> # if not already done. see section "what is an app key?" below on getting it
69+
(server) ./gc__listoffers (myvenv) $ python3 application.py serve localhost 8000
70+
71+
# on the remote machine (Windows okay)
72+
(client) ./gc__listoffers $ python3 application.py client <ip-address-of-server> 8000
73+
```
74+
8375
## what is an app key?
8476
an app key is what requestors use to run requests. to find and set your app key before running gc__listoffers and looking up the pertinent name:
8577
```bash

0 commit comments

Comments
 (0)