Skip to content

Commit c44b4ba

Browse files
docs: add running instructions to readme
1 parent 27d2c03 commit c44b4ba

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
11
# OC4IDS Datastore Pipeline
22

3-
## Run linting
3+
A Python application to validate and store published OC4IDS datasets.
4+
5+
## Local Development
6+
7+
### Prerequisites
8+
9+
- Python 3.12
10+
11+
### Install Python requirements
12+
13+
```
14+
python -m venv .venv
15+
source .venv/bin/activate
16+
pip install -r requirements_dev.txt
17+
```
18+
19+
### Run app
20+
21+
```
22+
pip install -e .
23+
oc4ids-datastore-pipeline
24+
```
25+
26+
### Run linting and type checking
427

528
```
629
black oc4ids_datastore_pipeline/
730
isort oc4ids_datastore_pipeline/
831
flake8 oc4ids_datastore_pipeline/
932
mypy oc4ids_datastore_pipeline/
1033
```
34+
35+
### Run tests
36+
37+
```
38+
pytest
39+
```

0 commit comments

Comments
 (0)