An open API service indexing awesome lists of open source software.

https://github.com/gkamboj/cdc-uploading-tool

Flask web application - SAP Customer Data Cloud (CDC) plugin to provide add-on features.
https://github.com/gkamboj/cdc-uploading-tool

csv-export flask genai-hub langchain openai python rag sap-cdc

Last synced: 3 months ago
JSON representation

Flask web application - SAP Customer Data Cloud (CDC) plugin to provide add-on features.

Awesome Lists containing this project

README

          

# cdc-uploading-tool

This is a Flask-based web application designed as a plugin for SAP Customer Data Cloud (CDC), offering additional features.

## Table of Contents
- [Setup Instructions](#setup-instructions)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [License](#license)

## Setup Instructions

After cloning the repository, follow these steps to set up the project:

1. **Set up local environment**:
- Download and install JetBrains PyCharm IDE or your preferred IDE.
- The following instructions will focus on PyCharm, but most IDEs provide similar features.

2. **Open the project**:
- In PyCharm, navigate to `File -> Open` and select the cloned repository folder.

3. **Set Up a local virtual environment**:
- Go to `Settings` > `Project: finance-gpt` > `Python Interpreter` > `Add Interpreter`.
- Choose `Add Local Interpreter` > `Virtualenv Environment`.
1. Select `Environment` -> `New`.
2. Set `Base Interpreter` to your installed Python version (e.g., Python 3.x).
3. Click `OK`.

4. **Install dependencies**:
- Install required dependencies by running the following command in terminal through IDE:
```bash
pip install -r requirements.txt
```
- If AI language translation is required through SAP Gen AI Hub, run following command:
```bash
pip install "generative-ai-hub-sdk[all]==1.2.2" --extra-index-url https://int.repositories.cloud.sap/artifactory/api/pypi/proxy-deploy-releases-hyperspace-pypi/simple/
```
- If you prefer to connect directly to the LLM via OpenAI instead of using the SAP proxy, you can skip the installation of `generative-ai-hub-sdk` and install required LangChain libraries instead.

5. **Local configuration setup**:
In properties.yml, set SAP Gen AI hub credentials or OpenAI key (if AI based language translation is required)

6. **Run the Application**:
```bash
python app.py
```

7. **Access the user interface**:
Open your web browser and navigate to [http://localhost:5001/](http://localhost:5001/) (or the appropriate port if different).

## Usage
- Once the application is running, you can use various features from interactive UI.
- To access Swagger UI, go to [http://localhost:5001/ui](http://localhost:5001/ui)

## Screenshots
Here are some screenshots showcasing working deployments of the application.
- Home page:
1_home

- Set configuration credentials:
2_config

- Filled template downloaded from _Template Creation_ page:
3_filled_template

- _Upload Excel_ page:
4_upload

- Response for uploaded data, with success as well as error scenarios:
5_upload_response

- Excel exported for upload response data:
6_response_export

- Generative AI based language translation:
7_ai_translate

## License
This project is licensed under the MIT License. See the LICENSE file for more details.