Skip to content

Commit

Permalink
docs: add running instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tillywoodfield committed Jan 29, 2025
1 parent 27d2c03 commit c44b4ba
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,39 @@
# OC4IDS Datastore Pipeline

## Run linting
A Python application to validate and store published OC4IDS datasets.

## Local Development

### Prerequisites

- Python 3.12

### Install Python requirements

```
python -m venv .venv
source .venv/bin/activate
pip install -r requirements_dev.txt
```

### Run app

```
pip install -e .
oc4ids-datastore-pipeline
```

### Run linting and type checking

```
black oc4ids_datastore_pipeline/
isort oc4ids_datastore_pipeline/
flake8 oc4ids_datastore_pipeline/
mypy oc4ids_datastore_pipeline/
```

### Run tests

```
pytest
```

0 comments on commit c44b4ba

Please sign in to comment.