Skip to content

Commit 213001c

Browse files
committed
Refactor project structure: update README for local development, remove FastAPI app, and clean up dependencies in pyproject.toml
1 parent d95f421 commit 213001c

4 files changed

Lines changed: 33 additions & 48 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
11
# 🧩 Dataset Quality Scoring Engine — System Framework (Markdown)
22

3+
## Local Development Split
4+
5+
The repository now separates responsibilities:
6+
7+
- `dsqus/engine`: core Python package code (no FastAPI).
8+
- `backend`: FastAPI service that imports and calls the core package.
9+
- `ui`: browser frontend that uploads files to the backend.
10+
11+
### Run Upload Flow End-to-End
12+
13+
From repository root:
14+
15+
```bash
16+
python -m venv .venv
17+
source .venv/bin/activate
18+
pip install -e .
19+
pip install -r backend/requirements.txt
20+
uvicorn backend.app:app --reload
21+
```
22+
23+
From `ui` in another terminal:
24+
25+
```bash
26+
npm install
27+
npm run dev
28+
```
29+
30+
Then open the Vite URL (typically `http://localhost:5173`) and upload a CSV/XLS/XLSX file.
31+
332
#️⃣ 1. Overview
433

534
The Dataset Quality Scoring Engine (DQS) evaluates the quality of any dataset using automated, model-agnostic metrics.

dsqus/engine/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
"""Engine package for the dsqus backend service."""
1+
"""Core engine package for dsqus."""
22

3-
from .app import app
3+
from .file_parser import parse_uploaded_file
44

5-
__all__ = ["app"]
5+
__all__ = ["parse_uploaded_file"]

dsqus/engine/app.py

Lines changed: 0 additions & 38 deletions
This file was deleted.

pyproject.toml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ authors = [
1212
{ name = "Sanjog Sigdel" }
1313
]
1414
dependencies = [
15-
"fastapi>=0.115",
16-
"uvicorn[standard]>=0.30",
17-
"python-multipart>=0.0.9",
1815
"pandas>=2.2",
1916
"openpyxl>=3.1",
2017
]
@@ -23,8 +20,5 @@ dependencies = [
2320
Homepage = "https://github.com/sigdelsanjog/dsqus"
2421
Repository = "https://github.com/sigdelsanjog/dsqus"
2522

26-
[tool.setuptools]
27-
package-dir = {"" = "dsqus"}
28-
2923
[tool.setuptools.packages.find]
30-
where = ["dsqus"]
24+
include = ["dsqus*"]

0 commit comments

Comments
 (0)