makefile 1st draft

Author: ltsaprounis

Makefile

@@ -0,0 +1,29 @@
+.PHONY: all lint test install environment
+
+lint: 
+	flake8 examplepackage
+	pydocstyle examplepackage
+
+test:
+	pytest examplepackage
+
+install:
+	pip install -r requirements.dev.txt
+	pip install -e .
+
+environment:
+	(\
+		python -m venv .venv; \
+		source .venv/bin/activate; \
+		pip install -r requirements.dev.txt; \
+		pip install -e .; \
+		python -m ipykernel install --name=examplepackage; \
+		jupyter kernelspec list; \
+		pre-commit install; \
+	)
+
+clean:
+	echo "> Removing virtual environment"
+	rm -r .venv
+	echo "> Uninstalling from jupyter"
+	jupyter kernelspec uninstall examplepackage

notebooks/example.ipynb

@@ -5,12 +5,37 @@
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "from examplepackage.examplemodule import example_function"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(example_function(1))"
+   ]
   }
  ],
  "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.5"
   }
  },
  "nbformat": 4,

requirements.dev.txt

@@ -2,3 +2,5 @@ flake8
 black
 pytest
 pydocstyle
+pre-commit
+ipykernel