/v-user

User micro-service

Primary LanguagePython

About

  • v-user is User related micro-service.
  • It uses Django default user module for user realted operations.
  • However some changes are made in in-built user module by extending it.

Prerequisites

Environment Variables :

  • DATABASE_NAME_USER
  • DATABASE_USER
  • DATABASE_PASSWORD
  • DATABASE_HOST
  • DATABASE_PORT
  • SECRET_KEY
  • AM_SERVER_URL
  • ORGANIZATION_IDENTIFIER
    • value: organization
  • VRT_IDENTIFIER
    • value: runtime

Micro-service :

  • AM server must be hosted & running and add its accessible url in above AM_SERVER_URL environment variable.

Rules OR Conditions

  • Some Rules or Assumptions are made here which are as follows :

    1 ) Email is our main primary contact (Cannot be updated normally, To Update some steps must be followed which are not decided yet).

    2 ) A UUId will be issued to every user, which will be distributed to other services in order to make any relation with user (user primary key will not be disclosed)

Installation :

1 ) Clone this repo

2 ) Setup virtual environment

cd <path-to-repo>/v-user/

virtualenv -p /usr/bin/python3 env

3 ) Activate Virtual environment

source env/bin/activate

4 ) Install requirements

  • Base Requirements
pip install -r requirements/base.txt
  • Testing Requirements
pip install -r requirements/test.txt
  • Local requirements
pip install -r requirements/local.txt
  • Production requirements
pip install -r requirements/production.txt

5 ) Prerequisites

  • Makes sure above Prerequisites we mentioned above must be defined and fulfilled.

6 ) Run Server

python manage.py runserver

API Reference :

  • API documentation is hosted on Swagger hub and is public.

Signals :

1 ) Add User Policies on AM server.

Tests :

  • Run tests using
make test