kosanamsandeep / personify-service

A server developed keeping the user application domain in mind for high scalability

Personify Service

Introduction

A proof of concept of a highly scalable Personal Server. The application was developed keeping a personal utility of a user domain in mind, but the principles used can easily be applied to design software solutions for any domain. One of the primary challenges for a user application domain is the ability to expand as per requirement, giving the ability to explore more on top of existing. To do so, we have to architect the application supporting the scale. After understanding several different system architectures, a Domain-Driven Design was considered to meet the requirement. This approach holds Framework-Agnositic Design, PostgreSQL, MongoDB and Test Driven Development.

Development Environment

At the bare minimum you'll need the following for your development environment:

1. Python
2. PostgreSQL
3. MongoDB

It is strongly recommended also to install and use the following tools:

1. virtualenv

Local Setup

I have included the following for you to assume that you have all of the recommended tools listed above installed.

Clone the project:

$ git clone https://github.com/gnknithin/Personify-Service.git
$ cd Personify-Service

Create and initialize virtualenv for the project:

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip3 install -r requirements.txt

Running the entire application stack

If you have docker-compose installed and docker running; it is really simple to spin up the entire application stack or use docker-compose as shown below.

Make sure you are in the root directory of the repository where the docker-compose file is.

Expected Environment Variables

All the environment variables for the application need to be specified in the docker-compose file, this allows us to separate environment configuration concerns from our application code meaning it can easily spin up for local, development and production environments with different db credentials, ports etc.

Create a .env as following

POSTGRES_HOST=localhost
POSTGRES_USER=personifydev
POSTGRES_PASSWORD=testenv@123
POSTGRES_DATABASE=personify
APPLY_MIGRATIONS=1
ALEMBIC_CONFIG=src/infra/data/migrations/alembic.ini
MONGODB_HOST=localhost
MONGODB_USERNAME=personifydev
MONGODB_PASSWORD=testenv@123
MONGODB_DATABASE=personify

Up Infrastructure:

docker-compose -f ./docker-compose.dev.yml up -d --force-recreate --renew-anon-volumes

To Run Server:

python3 src/server.py -p 8888 -c ./configs/development.yaml -d

To Stop Run Server:

press Cntrl + c

To Stop

docker-compose -f ./docker-compose.dev.yml down --remove-orphans

Tests and Code Coverage

Installing Dependencies and checking

pip3 install pytest pytest-asyncio pytest-cov pytest-dotenv

Unit Tests and Code Coverage

pytest -vv --cov --cov-report=term-missing ./tests/unit

Integration Tests and Code Coverage

pytest -vv --cov --cov-report=term-missing ./tests/integration

End2End Tests and Code Coverage

pytest -vv --cov --cov-report=term-missing ./tests/e2e

Code Coverage

pytest -vv --cov --cov-report=term-missing

Linting

Installing Dependencies and checking

pip3 install ruff
ruff check .

Type Checking

Installing Dependencies and checking

pip3 install mypy
mypy .

Working Features

Once you run the entire application stack using docker-compose, you should be able to access the public routes below:

Feature	Type	Route	Access
Health Check	GET	http://localhost:8888/health	Public
Add a new user	POST	http://localhost:8888/api/v1/signup	Public
Authenticate a user	POST	http://localhost:8888/api/v1/signup	Public
Get all contacts	GET	http://localhost:8888/api/v1/contact	Protected
Add a new contact	POST	http://localhost:8888/api/v1/contact	Protected
Get a specific contact	GET	http://localhost:8888/api/v1/contact/{contact_id}	Protected
Update a specific contact	PUT	http://localhost:8888/api/v1/contact/{contact_id}	Protected
Delete a specific contact	DELETE	http://localhost:8888/api/v1/contact/{contact_id}	Protected

Highlights

• Documentation - Swagger
• Code Coverage
• Markdown Diagrams
• Ruff Linting
• MyPy Typing
• Testing
  • Unit Testing
  • Integration Testing
  • End2End Testing
  • Postman
• Deployment Solution and Documentation
• Final: Production READY

Project Links

• Issues: https://github.com/gnknithin/Personify-Service/issues

License

GNU General Public License v3.0. See the bundled LICENSE file for more details.