G2P Bridge

Installation of G2P Bridge on a developer machine

Developers can set up and run the G2P Bridge on their local machines. This guide outlines the steps to install G2P Bridge on a Linux-based laptop or desktop.

Prerequisites

• Python3

• Git

• PostgreSQL

• Redis

• Celery

Installation of G2P Bridge

1. Update system packages

• Log in to your Linux server using SSH and update the package list and upgrade the existing packages:

sudo apt update
sudo apt upgrade -y

2. Install dependencies

sudo apt install -y python3-pip python3-dev build-essential

3. Install and configure PostgreSQL

• G2P Bridge requires PostgreSQL as the database engine. Install PostgreSQL and create a new database user for G2P Bridge.

  sudo apt install -y postgresql
  sudo su - postgres
  createuser --createdb --username postgres --no-createrole --no-superuser --pwprompt g2p_bridge_user
  exit

4. Clone the G2P Bridge Repository

• Clone the openg2p-g2p-bridge repository to your local machine.

  git clone https://github.com/OpenG2P/openg2p-g2p-bridge

5. Install Python Libraries and G2P Bridge Components

Bridge API

Setting up the Bridge API

• Make a new Python virtual environment.

  cd openg2p-g2p-bridge/openg2p-g2p-bridge-api
  python3 -m venv venv

• Activate the virtual environment.

  source venv/bin/activate

• Use pip to install the required Python packages, including the core libraries for the G2P Bridge.

  python3 -m pip install \
      openg2p-fastapi-common==1.1.0 \
      openg2p-fastapi-auth==1.1.0 \
      openg2p-g2pconnect-common-lib==1.1.0 \
      openg2p-g2p-bridge-models==1.0.0 \
      openg2p-g2p-bridge-api==1.0.0

• Update the .env

    G2P_BRIDGE_DB_DBNAME: openg2p_g2p_bridge_db
    G2P_BRIDGE_DB_HOSTNAME: localhost
    G2P_BRIDGE_DB_PASSWORD: password
    G2P_BRIDGE_DB_PORT: 5432
    G2P_BRIDGE_DB_USERNAME: bridgeuser
    G2P_BRIDGE_WORKER_TYPE: gunicorn
    G2P_BRIDGE_HOST: 0.0.0.0
    G2P_BRIDGE_PORT: '8000'
    G2P_BRIDGE_NO_OF_WORKERS: '1'
    G2P_BRIDGE_OPENAPI_ROOT_PATH: '/api/g2p-bridge'

• Migrate the database schema

  python3 main.py migrate; 

• Run the API server on 127.0.0.1:8000

  gunicorn "main:app" --workers 1 --worker-class uvicorn.workers.UvicornWorker --bind 127.0.0.1:8000

Bridge Celery Beat

Setting up the Bridge Celery Beat

• Make a new Python virtual environment.

  cd openg2p-g2p-bridge/openg2p-g2p-bridge-celery-beat-producers
  python3 -m venv venv

• Activate the virtual environment.

  source venv/bin/activate

• Use pip to install the required Python packages, including the core libraries for the G2P Bridge.

  python3 -m pip install \
      openg2p-fastapi-common==1.1.0 \
      openg2p-fastapi-auth==1.1.0 \
      openg2p-g2pconnect-common-lib==1.1.0 \
      openg2p-g2p-bridge-models==1.0.0 \
      openg2p-g2p-bridge-bank-connectors==1.0.0 \
      openg2p-g2p-bridge-celery-beat-producers==1.0.0    

• Update the .env

      G2P_BRIDGE_CELERY_BEAT_MAPPER_RESOLVE_API_URL: 'http://spar-mapper-api/sync/resolve' # Update the Spar Mapper Resolve URL
      G2P_BRIDGE_CELERY_BEAT_DB_HOSTNAME: localhost
      G2P_BRIDGE_CELERY_BEAT_DB_PASSWORD: password
      G2P_BRIDGE_CELERY_BEAT_CELERY_BROKER_URL: redis://127.0.0.1:6379/0
      G2P_BRIDGE_CELERY_BEAT_CELERY_BACKEND_URL: redis://127.0.0.1:6379/0
      G2P_BRIDGE_CELERY_BEAT_BANK_FA_DECONSTRUCT_STRATEGY: ^account_number:(?P<account_number>.*)\.branch_code:(?P<branch_code>.*)\.bank_code:(?P<bank_code>.*)\.fa_type:(?P<fa_type>.*)$
      G2P_BRIDGE_CELERY_BEAT_MOBILE_WALLET_DECONSTRUCT_STRATEGY: ^mobile_number:(?P<mobile_number>.*)\.wallet_provider_name:(?P<wallet_provider_name>.*)\.wallet_provider_code:(?P<wallet_provider_code>.*)\.fa_type:(?P<fa_type>.*)$
      G2P_BRIDGE_CELERY_BEAT_EMAIL_WALLET_DECONSTRUCT_STRATEGY: ^email_address:(?P<email_address>.*)\.wallet_provider_name:(?P<wallet_provider_name>.*)\.wallet_provider_code:(?P<wallet_provider_code>.*)\.fa_type:(?P<fa_type>.*)$
      G2P_BRIDGE_CELERY_BEAT_MAPPER_RESOLVE_FREQUENCY: 60
      G2P_BRIDGE_CELERY_BEAT_FUNDS_AVAILABLE_CHECK_FREQUENCY: 60
      G2P_BRIDGE_CELERY_BEAT_FUNDS_BLOCKED_FREQUENCY: 60
      G2P_BRIDGE_CELERY_BEAT_FUNDS_DISBURSEMENT_FREQUENCY: 60
      G2P_BRIDGE_CELERY_BEAT_MT940_PROCESSOR_FREQUENCY: 60
      G2P_BRIDGE_CELERY_BEAT_PROCESS_FUTURE_DISBURSEMENT_SCHEDULES: true 

• Run redis-server

  bash sudo systemctl start redis

• Run the celery beat

  celery -A main.celery_app worker --beat --loglevel=info

Bridge Celery Worker

Setting up the Bridge Celery Worker

• Make a new Python virtual environment.

  cd openg2p-g2p-bridge/openg2p-g2p-bridge-celery-workers
  python3 -m venv venv

• Activate the virtual environment.

  source venv/bin/activate

• Use pip to install the required Python packages, including the core libraries for the G2P Bridge.

  python3 -m pip install \
      openg2p-fastapi-common==1.1.0 \
      openg2p-fastapi-auth==1.1.0 \
      openg2p-g2pconnect-common-lib==1.1.0 \
      openg2p-g2p-bridge-models==1.0.0 \
      openg2p-g2p-bridge-bank-connectors==1.0.0 \
      openg2p-g2p-bridge-celery-workers==1.0.0    

• Update the .env

    G2P_BRIDGE_CELERY_WORKERS_MAPPER_RESOLVE_API_URL: 'http://mapper/sync/resolve'
    G2P_BRIDGE_CELERY_WORKERS_MAPPER_RESOLVE_RETRY_DELAY: 5
    G2P_BRIDGE_CELERY_WORKERS_DB_DBNAME: openg2p_g2p_bridge_db
    G2P_BRIDGE_CELERY_WORKERS_DB_USERNAME: bridgeuser
    G2P_BRIDGE_CELERY_WORKERS_DB_PASSWORD: password
    G2P_BRIDGE_CELERY_WORKERS_DB_HOSTNAME: localhost
    G2P_BRIDGE_CELERY_WORKERS_BANK_FA_DECONSTRUCT_STRATEGY: bank_(?P<account_number>\d+)_(?P<bank_code>\d+)_(?P<branch_code>\d+)_(?P<account_type>\w+)
    G2P_BRIDGE_CELERY_WORKERS_MOBILE_WALLET_DECONSTRUCT_STRATEGY: mobile_(?P<mobile_number>\d+)_(?P<mobile_wallet_provider>\w+)
    G2P_BRIDGE_CELERY_WORKERS_EMAIL_WALLET_DECONSTRUCT_STRATEGY: email_(?P<email_address>\w+)_(?P<email_wallet_provider>\w+)
    G2P_BRIDGE_CELERY_PRODUCERS_FUNDS_AVAILABLE_CHECK_URL_EXAMPLE_BANK: http://127.0.0.1:8003/check_funds"
    G2P_BRIDGE_CELERY_PRODUCERS_FUNDS_BLOCK_URL_EXAMPLE_BANK: http://127.0.0.1:8003/block_funds"
    G2P_BRIDGE_CELERY_PRODUCERS_FUNDS_DISBURSEMENT_URL_EXAMPLE_BANK: http://127.0.0.1:8003/initiate_payment"
    G2P_BRIDGE_CELERY_WORKERS_CELERY_BROKER_URL: redis://127.0.0.1:6379/0
    G2P_BRIDGE_CELERY_WORKERS_CELERY_BACKEND_URL: redis://127.0.0.1:6379/0

• Run redis-server

  bash sudo systemctl start redis

• Run the celery beat

  celery -A main.celery_app worker -Q g2p_bridge_celery_worker_tasks --loglevel=info