https://github.com/timmoth/epochflow-toolkit

Repo containing public tools & samples for EpochFlow
https://github.com/timmoth/epochflow-toolkit

Last synced: 21 days ago
JSON representation

Repo containing public tools & samples for EpochFlow

• Host: GitHub
• URL: https://github.com/timmoth/epochflow-toolkit
• Owner: Timmoth
• License: mit
• Created: 2024-02-21T17:15:56.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-12T20:34:50.000Z (8 months ago)
• Last Synced: 2024-05-13T20:57:18.835Z (8 months ago)
• Language: C#
• Size: 141 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# epochflow-toolkit

Repo containing public tools & samples for EpochFlow

## Links

[App](https://app.epochflow.io/) • [Docs](https://docs.epochflow.io/) • [Swagger Api](https://api.epochflow.io/swagger/index.html)

## Emulator

This [docker image](https://hub.docker.com/r/aptacode/epochflow-emulator) provides a light weight in memory emulator for the API which can be easily ran locally for development or part of your CICD pipeline for integration tests.

```

docker run -p 8085:8080 aptacode/epochflow:latest

Emulator web ui: https://localhost:8085

Emulator Swagger docs: https://localhost:8085/swagger

```

## Nuget package

This [nuget package](https://www.nuget.org/packages/Epochflow/) contains all the classes needed to integrate Epoch flow into your dotnet Api.

### Install the nuget package

```bash

dotnet add package epochflow

```

### Configure services

```csharp

var apiKey = "";

var accountId = "";

var apiUrl = "";

services.AddEpochFlowV1(apiKey, accountId, apiUrl);

```

### Make requests

```csharp

private readonly IEpochFlowV1 _epochflow;

public async Task Load(){

  var setId = "";

  var result = await _epochflow.GetSet(setId);

  if(!result.IsSuccessStatusCode){

    return;

  }

  var set = result.Content;

}

```

Alternatively, if you don't want to configure DI

```csharp

var httpClient = new HttpClient();

httpClient.BaseAddress = new Uri(EpochFlowApiUrl);

httpClient.DefaultRequestHeaders.Add("X-API-Key'", EpochFlowApiKey);

httpClient.DefaultRequestHeaders.Add("X-Account-Id", EpochFlowAccountId);

var epochFlowApi = RestService.For(httpClient);

var result = await epochFlowApi.PostDataPoints(EpochFlowSetId, measurements);

```

## Using the CLI toolkit

[Download the latest release for Windows, Linux or Osx](https://github.com/Timmoth/epochflow-toolkit/releases)

### Configuration

If you want to target the local emulator specify the '--emulator true' flag.

```bash

./epoch get-account --emulator true

```

If you want to target the real api you must configure the cli toolkit with the api url, your account id and api key, there are two ways to do this:

#### Parameters

Each command takes the following parameters:

```bash

--url "https://api.epochflow.io/"

--account ""

--key ""

```

#### Environment variables

Windows:

```powershell

setx epochflow_url "https://api.epochflow.io/"

setx epochflow_account ""

setx epochflow_key ""

Open a new terminal so the environment variables are updated.

```

Linux / Osx:

```bash

export epochflow_url="https://api.epochflow.io/"

export epochflow_account=""

export epochflow_key=""

```

### Usage

```bash

# Accounts

./epoch get-account

# Sets

./epoch create-set --name "" --collision-mode ""

./epoch list-sets

./epoch get-set --id ""

./epoch delete-set --id ""

# Tags

./epoch list-tags --id ""

./epoch delete-tag --id "" --tag ""

# Data

./epoch get-data --id "" --tag ""

# Api Keys

./epoch create-key --name "" --expiry "" --admin "" --all_set_operations "" --permissions "set_1_id;tag1,tag2;read,write&set_2_id;all;read"

./epoch get-key --id ""

./epoch list-keys

./epoch enable-key --id ""

./epoch disable-key --id ""

./epoch delete-key --id ""

```