From d5316be0437b626f5655203601c87b3a248efedd Mon Sep 17 00:00:00 2001
From: Jan Range <range.jan@web.de>
Date: Sun, 12 May 2024 01:37:11 +0200
Subject: [PATCH] add dev instructions

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/README.md b/README.md
index 6daf483..2dfdf04 100644
--- a/README.md
+++ b/README.md
@@ -114,3 +114,48 @@ The `config` file can then be used as follows:
 ```bash
 dvuploader --config-path config.yml
 ```
+
+## Development
+
+To install the development dependencies, run the following command:
+
+```bash
+pip install poetry
+poetry install --with test
+```
+
+### Running tests locally
+
+In order to test the DVUploader, you need to have a Dataverse instance running. You can start a local Dataverse instance by following these steps:
+
+**1. Start the Dataverse instance**
+
+```bash
+docker compose \
+    -f ./docker/docker-compose-base.yml \
+    --env-file local-test.env \
+    up -d
+```
+
+**2. Set up the environment variables**
+
+```bash
+export BASE_URL=http://localhost:8080
+export $(grep "API_TOKEN" "dv/bootstrap.exposed.env")
+export DVUPLOADER_TESTING=true
+```
+
+**3. Run the test(s) with pytest**
+
+```bash
+python -m pytest -v
+```
+
+### Linting
+
+This repository uses `ruff` to lint the code and `codespell` to check for spelling mistakes. You can run the linters with the following command:
+
+```bash
+python -m ruff
+python -m codespell --check-filenames
+```