From e8fc9005e19178d102b2c67b932d4459b038f260 Mon Sep 17 00:00:00 2001
From: Noam Nol <nnol@infinidat.com>
Date: Mon, 9 Sep 2024 14:57:10 +0300
Subject: [PATCH] Add Development Guide

---
 README.md           |  6 ++++++
 docs/development.md | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 docs/development.md

diff --git a/README.md b/README.md
index f31778f..4d2e860 100644
--- a/README.md
+++ b/README.md
@@ -170,3 +170,9 @@ Feedback
 --------
 
 Open a ticket / fork the project on [GitHub](http://github.com/Infinidat/munch).
+
+
+Development
+--------
+
+See [Development Guide](docs/development.md)
diff --git a/docs/development.md b/docs/development.md
new file mode 100644
index 0000000..b453aa9
--- /dev/null
+++ b/docs/development.md
@@ -0,0 +1,34 @@
+# Development Guide
+
+Use python 3.10:
+
+```
+pyenv local 3.10
+```
+
+Create a virtual environment:
+
+```
+python -m venv .env
+source .env/bin/activate
+```
+
+Install dependencies:
+
+```
+pip install --upgrade pip
+pip install --upgrade build wheel setuptools pytest
+pip install --use-pep517 ".[testing,yaml]"
+```
+
+Test:
+
+```
+pytest
+```
+
+Lint:
+
+```
+pylint munch setup.py tests
+```