From b48248c143cc279ffa4cdfcde3048722ccee09e8 Mon Sep 17 00:00:00 2001
From: ok300 <106775972+ok300@users.noreply.github.com>
Date: Mon, 13 Nov 2023 12:20:57 +0100
Subject: [PATCH] Add README.md

---
 snippets/python_snippets/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 snippets/python_snippets/README.md

diff --git a/snippets/python_snippets/README.md b/snippets/python_snippets/README.md
new file mode 100644
index 0000000..1b98ed2
--- /dev/null
+++ b/snippets/python_snippets/README.md
@@ -0,0 +1,27 @@
+## Steps to run locally
+
+To check the syntax:
+
+```bash
+cd snippets/python_snippets
+python3 -m compileall src
+```
+
+To check the snippet formatting:
+
+```bash
+cd snippets/python_snippets/src
+ruff --ignore F841 --ignore F401 --output-format=github .
+```
+
+To execute the snippets locally, in order to check for type correctness:
+
+```bash
+#!/bin/bash
+
+export API_KEY="..."
+export MNEMONIC="..."
+
+cd snippets/python_snippets
+python main.py $API_KEY $MNEMONIC
+```
\ No newline at end of file