To build a data connector between a FastAPI service and the Data management system that needs to be built using Frappe

[KaranrajM]

Description

There is a need to store data into a management system from a FastAPI service. The management system should be built using the Frappe framework to store data seamlessly. Write a Frappe connector that connects with the FastAPI service (which provides data) to store the data into the management system.

Goal

To create a generic connector that helps to transfer and store data into a management system built using Frappe.

Expected Outcome

FastAPI Service

• To send the input JSON object

Frappe Setup

• To receive data through an API and store it into the database in a generic way so that it can be displayed on the dashboard (for now in a basic table format).

Acceptance Criteria

Context-specific details triggered from the API are to be stored in the database and visualized on the Dashboard page built using Frappe.

Implementation Details

1. Build a FastAPI service that can send a JSON object to any open API service.
2. Set up Frappe on a local machine using the guide here:
   • Frappe GitHub Repository
   • Frappe Setup Guide
3. Store the details into the database (preferably PostgreSQL) based on the following details:
   • context_title: Represents the table name in the database
   • context_details: Represents the column names and values within the table
4. Build a dashboard in Frappe that shows the context-specific details in a table format.

For Example

Below are the sample JSON objects sent from the FastAPI Service to Frappe API.

Example 1

{
  "context_title": "user_details",
  "context_details": {
    "Name": "XYZ",
    "Age": 28,
    "Gender": "Male"
  }
}

Example 2

{
  "context_title": "user_details",
  "context_details": {
     "query": "ABC",
     "phone_no": 28231231,
     "rti_pdf": "abc.pdf"
  }
}

The Dashboard should look something like below [Please note that the given data stored in a generic way as in the user can display the data in chart form as well]-

User Details

Name	Age	Gender
XYZ	28	Male

RTI Details

Query	PhoneNo	RTI_pdf
ABC	281819111	abc.pdf

Mockups/Wireframes

NOT APPLICABLE

Product Name

Jugalbandi

Organisation Name

OpenNyAI

Domain

Legal

Tech Skills Needed

• Python
• Frappe

Complexity

Medium

Category

Backend

[NEGRAH-S]

Hello @KaranrajM , @Lekhanrao , I am interested to work on this issue .

[Savio629]

Hi team, is there any additional briefing or context about the issue that I should keep in mind? Also, thank you for shortlisting me through the process!

[Lekhanrao]

@Savio629, Assigned this ticket to you.
@KaranrajM will help you with Technical details.

[Lekhanrao]

@Savio629, Karan will reach out to you for a quick Intro call this week. And then we plan to have a weekly connect call as well.
@KaranrajM