Skip to content

Commit 7085b91

Browse files
committed
Update VS Code settings and enhance README for Dev Container usage
1 parent 4957986 commit 7085b91

2 files changed

Lines changed: 9 additions & 12 deletions

File tree

.vscode/settings.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
"python.testing.autoTestDiscoverOnSaveEnabled": true,
1212
"python.testing.pytestPath": "${workspaceFolder}/.venv/bin/pytest",
1313
"python.testing.cwd": "${workspaceFolder}",
14-
"python-envs.pythonProjects": [],
1514

1615
// Code formatting - use ruff for both linting and formatting
1716
"[python]": {
@@ -49,5 +48,5 @@
4948
],
5049
"pylint.importStrategy": "fromEnvironment",
5150

52-
"python-envs.defaultEnvManager": "ms-python.python:venv"
51+
"python-envs.defaultEnvManager": "ms-python.python:system"
5352
}

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ This repository contains the **SQL-to-ARC Converter**, a core component of the F
1414

1515
## 🚀 Getting Started (Development)
1616

17-
This project uses [uv](https://github.com/astral-sh/uv) for dependency management and workspace orchestration.
17+
The preferred method for working with this repository is using the **Dev Container** (VS Code).
1818

19-
### 1. Prerequisites
19+
While it is possible to develop without the Dev Container (see prerequisites below), this approach is not tested and is therefore neither documented nor officially supported.
20+
21+
### 1. Prerequisites (for manual setups only)
2022

2123
- **Python 3.12+**
24+
- **[uv](https://github.com/astral-sh/uv)** (Dependency Management & Workspace Orchestration)
2225
- **Docker & Docker Compose**
2326
- **Git LFS** (installed via `./scripts/setup-git-lfs.sh`)
2427

@@ -32,14 +35,9 @@ uv sync --all-packages
3235

3336
### 3. Start Local Development Environment
3437

35-
The `dev_environment` folder provides a full stack including a PostgreSQL database pre-filled with edaphobase data:
36-
37-
```bash
38-
cd dev_environment
39-
./start.sh --build
40-
```
38+
The `dev_environment` folder provides a full stack including a PostgreSQL database pre-filled with edaphobase data.
4139

42-
This will start the database and run a test iteration of the converter.
40+
Please refer to the **[Development Environment README](dev_environment/README.md)** for detailed instructions on prerequisites (like secret management and mTLS keys), setup, and usage.
4341

4442
## 🔧 Component Documentation
4543

@@ -62,5 +60,5 @@ uv run pytest middleware/sql_to_arc/tests/
6260
```
6361

6462
---
65-
**Maintained by:** FAIRagro Middleware Team
63+
**Maintained by:** FAIRagro Middleware Team
6664
**License:** [LICENSE](LICENSE)

0 commit comments

Comments
 (0)