readme

README.md

@@ -1 +1,26 @@
-This file will be overwritten by `index.ipynb`
+# Sugar SDK
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Getting started
+
+### Set up and acivate python virtual env
+
+``` bash
+python3 -m venv env
+source env/bin/activate
+```
+
+### Install dependencies
+
+``` bash
+pip install nbdev pre-commit
+pip install -e '.[dev]'
+```
+
+### Install pre-commit hooks for nbdev prep and cleanup
+
+``` bash
+pre-commit install
+```

settings.ini

@@ -9,7 +9,7 @@ version = 0.0.1
 
 ### OPTIONAL ###
 
-requirements = python-dotenv fastcore
+requirements = python-dotenv
 # dev_requirements = 
 # console_scripts =
 

src/index.ipynb

@@ -0,0 +1,49 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Sugar SDK\n",
+    "\n",
+    "> Python SDK for sugar"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Getting started\n",
+    "\n",
+    "### Set up and acivate python virtual env\n",
+    "\n",
+    "```bash\n",
+    "python3 -m venv env\n",
+    "source env/bin/activate\n",
+    "```\n",
+    "\n",
+    "### Install dependencies \n",
+    "\n",
+    "```bash\n",
+    "pip install nbdev pre-commit\n",
+    "pip install -e '.[dev]'\n",
+    "```\n",
+    "\n",
+    "### Install pre-commit hooks for nbdev prep and cleanup\n",
+    "\n",
+    "```bash\n",
+    "pre-commit install\n",
+    "```"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "python3",
+   "language": "python",
+   "name": "python3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}