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
- Build a FastAPI service that can send a JSON object to any open API service.
- Set up Frappe on a local machine using the guide here:
- Store the details into the database (preferably PostgreSQL) based on the following details:
context_title: Represents the table name in the databasecontext_details: Represents the column names and values within the table
- 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
Complexity
Medium
Category
Backend
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
Frappe Setup
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
context_title: Represents the table name in the databasecontext_details: Represents the column names and values within the tableFor 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
RTI Details
Mockups/Wireframes
NOT APPLICABLE
Product Name
Jugalbandi
Organisation Name
OpenNyAI
Domain
Legal
Tech Skills Needed
Complexity
Medium
Category
Backend