juusoautiosalo/twinbase-api

Developing an HTTP API for Twinbase

Twinbase API

Developing an HTTP API for Twinbase

Setup

Clone and move to repository

git clone https://gitlab.com/JuusoAut/privacy-preserving-self-sovereign-identities.git

git clone https://github.com/juusoautiosalo/twinbase-api.git

cd twinbase-api

Deployment (with SSI-proxy)

Prerequisites

• Docker and Docker compose

Set environment variables

Configure environment variables or .env file to match environment variables used in docker-compose.yml (${}).

nano .env

Example contents:

TWINBASE_API_TWINBASE_REPO_URL="https://github.com/juusoautiosalo/twinbase-smart-city"
TWINBASE_API_GITHUB_TOKEN=github_pat_1234567890qwerty
TWINBASE_API_GITHUB_USERNAME=juusoautiosalo
IAA_OWNER_DID=did:key:z6Mkk4YdpLxAxWkDULdBVifCjVDPh3WvhbkDL1W4miwoHEQb

Explanations:

• TWINBASE_API_TWINBASE_REPO_URL: The url of the repository you want to host the SSI API for
• TWINBASE_API_GITHUB_TOKEN: Create a fine-grained access token at https://github.com/settings/personal-access-tokens/new
  • Repository access => Only select repsitories => [Your Twinbase instance repository]
  • Permissions => Repository permissions => Contents => Access: Read and write
  • Press "Generate token" and copy the token to the variable
• TWINBASE_API_GITHUB_USERNAME: The username associated with TWINBASE_API_GITHUB_TOKEN
• IAA_OWNER_DID: Create an owner DID according to instructions at https://gitlab.com/JuusoAut/privacy-preserving-self-sovereign-identities

Start services

docker compose up --build --detach

See Swagger documentation at http://localhost:9000/docs

• Requests via the swagger interface don't work.
• Set up DIDs, credentials, tokens, and headers according to these instructions to send requests: https://gitlab.com/JuusoAut/privacy-preserving-self-sovereign-identities

Update IAA configuration and reboot SSI-proxy

Run following on host machine:

make update-iaa

Stop services

docker compose down

Remove all unused docker images

docker image prune --all

Development

Prerequisites

• Python 3.7 or above
• make
  • If make is not available you may check Makefile for the commands

Create virtual environment and install requirements

# Create and activate virtual environment (recommended)
python3 -m venv venv
source venv/bin/activate

# Install pip-tools to manage requirements
make pip-tools

# Install requirements to virtual enviroment with pip-tools
make sync

Build and run Twinbase API with docker

docker compose build twinbase-api && docker compose run --rm twinbase-api

Edit python library requirements

Edit the requirements in requirements.in

# Update requirement files
make requirements

# Install requirements
make sync

Add any necessary environment variables

See the code (main.py) to see what you need: os.getenv('ENV_VARIABLE_X') means the variable is used.

Run server

# Development:
uvicorn main:app --reload

# Production:
uvicorn main:app --host 0.0.0.0