Skip to content

Commit

Permalink
remove sub-sections
Browse files Browse the repository at this point in the history
  • Loading branch information
m-yahya committed Aug 23, 2023
1 parent cdae37f commit 11a3449
Showing 1 changed file with 21 additions and 32 deletions.
53 changes: 21 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,13 @@ Use `Pyo3` Lib to wrap the `integritee-cli` into a Python lib.

- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Updating Git Submodules](#updating-git-submodules)
- [Creating and Activating venv](#creating-and-activating-venv)
- [Managing Environment Variables](#managing-environment-variables)
- [Installing Dependencies](#installing-dependencies)
- [Development](#development)
- [Using maturin](#using-maturin)
- [Usage](#usage)
- [Running the Client](#running-the-client)
- [Available Commands](#available-commands)
- [Updating Git Submodules](#updating-git-submodules)
- [Creating and Activating venv](#creating-and-activating-venv)
- [Managing Environment Variables](#managing-environment-variables)
- [Installing Dependencies](#installing-dependencies)
- [Using maturin](#using-maturin)
- [Run as Command Line Tool](#run-as-command-line-tool)
- [Available Commands](#available-commands)
- [Troubleshooting](#troubleshooting)

## Getting Started
Expand All @@ -31,9 +28,7 @@ to be setup beforehand:
$ rustup override set nightly
```

## Installation

### Updating Git Submodules
## Updating Git Submodules

`Cargo.toml` states the relative dependencies at the `shared` folder.
The submodules have to be initialized and updated before building:
Expand All @@ -42,7 +37,7 @@ The submodules have to be initialized and updated before building:
$ git submodule update --init --recursive
```

### Creating and Activating venv
## Creating and Activating venv

Install `integritee_cli_py` as lib into virtual environment:

Expand All @@ -53,7 +48,7 @@ $ source venv/bin/activate
$ conda deactivate
```

### Managing Environment Variables
## Managing Environment Variables

Please follow these steps to set up and use environment variables:

Expand All @@ -65,41 +60,35 @@ $ cp .env.example .env

2. Open the `.env` file and provide values for the environment variables.

### Installing Dependencies
## Installing Dependencies

Install the necessary dependencies using the provided `requirements.txt` file:

```bash
$ pip install -r requirements.txt
```

## Development

### Using maturin
## Using maturin

To install the lib to your current python environment use:

```
$ maturin develop
```

## Usage

Here's how you can make the most of our project!

### Run as Command Line Tool
## Run as Command Line Tool

Test import and execution of `integritee_cli_py` in python:

```
$ python run_integritee_cli.py --command <COMMAND-NAME> --params <PARAMETER-NAME>
```

### Available Commands
## Available Commands

The `integritee-cli-py` provides the following CLI commands:

#### Get help:
### Get help:

**Syntax:**

Expand All @@ -123,23 +112,23 @@ options:
Parameters for the command
```
#### Create a new account:
### Create a new account:
**Syntax:**
```bash
$ python3 run_integritee_cli.py --command new_account_cmd
```
#### Create a new trusted account:
### Create a new trusted account:
**Syntax:**
```bash
$ python3 run_integritee_cli.py --command new_trusted_account_cmd --params <MRENCLAVE>
```
#### Pay As Bid:
### Pay As Bid:
**Syntax:**
Expand All @@ -153,7 +142,7 @@ $ python3 run_integritee_cli.py --command pay_as_bid_cmd --params <MRENCLAVE> <A
$ python3 run_integritee_cli.py --command pay_as_bid_cmd --params 9PPeGELLdD9Uw1mVJbUGTeRpGzPBGb1bdEk6TCL4pPCE 5Dsni69ozXZZwpxyCGjLq8KQnBpGrtPnbykepgst2Tbh7NuY "[{\"id\":0,\"order_type\":\"ask\",\"time_slot\":\"2022-10-04T05:06:07+00:00\",\"actor_id\":\"actor_0\",\"cluster_index\":0,\"energy_kwh\":5,\"price_euro_per_kwh\":0.19},{\"id\":1,\"order_type\":\"bid\",\"time_slot\":\"2022-10-04T05:06:07+00:00\",\"actor_id\":\"actor_1\",\"cluster_index\":0,\"energy_kwh\":8.8,\"price_euro_per_kwh\":0.23}]"
```
#### Get Market Results:
### Get Market Results:
**Syntax:**
Expand All @@ -167,7 +156,7 @@ $ python3 run_integritee_cli.py --command get_market_results_cmd --params <MRENC
$ python3 run_integritee_cli.py --command get_market_results_cmd --params 9PPeGELLdD9Uw1mVJbUGTeRpGzPBGb1bdEk6TCL4pPCE 5Dsni69ozXZZwpxyCGjLq8KQnBpGrtPnbykepgst2Tbh7NuY 2022-10-04T05:06:07+00:00
```
#### Get Bid Proof:
### Get Bid Proof:
**Syntax:**
Expand All @@ -181,7 +170,7 @@ $ python3 run_integritee_cli.py --command pay_as_bid_proof_cmd --params <MRENCLA
$ python3 run_integritee_cli.py --command pay_as_bid_proof_cmd --params 9PPeGELLdD9Uw1mVJbUGTeRpGzPBGb1bdEk6TCL4pPCE 5Dsni69ozXZZwpxyCGjLq8KQnBpGrtPnbykepgst2Tbh7NuY 2022-10-04T05:06:07+00:00 actor_0
```
#### Verify Proof:
### Verify Proof:
**Syntax:**
Expand Down

0 comments on commit 11a3449

Please sign in to comment.