updated dotfmp conf notebook

Author: davidhamann

examples/conf_dotfmp_2018.ipynb

@@ -16,6 +16,26 @@
     "No need to worry about manually requesting access tokens, setting the right http headers, parsing responses, ..."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Use cases"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Some things you may use the python-fmrest library for:\n",
+    "\n",
+    "- Build a backend for a web app that works with FileMaker data\n",
+    "- Use python-fmrest together with a rest framework to build your own data API as middleware  \n",
+    " (so that you don't expose the whole FM data API to a third party, but only allowed endpoints/actions)\n",
+    "- Explore your FileMaker data with data analysis tools from the Python ecosystem\n",
+    "- Anything else you could do in the past with the CWP/XML API"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -179,39 +199,40 @@
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "code",
+   "execution_count": null,
    "metadata": {},
+   "outputs": [],
    "source": [
-    "Look at (some of) the moons of Jupiter (list records of a portal)"
+    "type(planets), planets"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
    "source": [
-    "record = fms.get_record(5, portals=[{'name': 'moons', 'limit': 5}])\n",
-    "\n",
-    "portal = record['portal_moons']\n",
-    "portal"
+    "Look at (some of) the moons of Jupiter (list records of a portal)"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "scrolled": true
+   },
    "outputs": [],
    "source": [
-    "for row in portal:\n",
-    "    print(row['Moons::name'])"
+    "record = fms.get_record(5, portals=[{'name': 'moons', 'limit': 5}])\n",
+    "\n",
+    "portal = record['portal_moons']\n",
+    "record, portal"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Fetching a record always gives you a Record instance:"
+    "Fetching a record always gives you a Record instance. The portal rows, however, are returned as a Foundset."
    ]
   },
   {
@@ -220,7 +241,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "record"
+    "for row in portal:\n",
+    "    print(row['Moons::name'])"
    ]
   },
   {
@@ -273,6 +295,13 @@
     "record.name, record['atmosphere']"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "So far we have seen Server, Foundset, Record. These are the main classes you need to be aware of when working with the library."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -458,6 +487,23 @@
     "Image(response.content)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Exceptions"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "find_request = [{'name': 'something that doesn\\'t exist'}]\n",
+    "foundset = fms.find(query=find_request)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -469,7 +515,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Turn Foundset into a Pandas DataFrame to analyse your dataset."
+    "Turn Foundset into a Pandas DataFrame to do statistical analyses on your dataset, work with missing data, reshape/pivot, perform joins/merges, plot with matplotlib, export, etc."
    ]
   },
   {
@@ -480,7 +526,16 @@
    "source": [
     "foundset = fms.get_records()\n",
     "df = foundset.to_df()\n",
-    "df"
+    "df.loc[:, df.columns != 'image']"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "df[['name', 'atmosphere', 'rings', 'confirmed_moons', 'mass']].set_index('name').T"
    ]
   },
   {
@@ -548,7 +603,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "- **Examples**: https://github.com/davidhamann/python-fmrest/tree/master/examples\n",
+    "- **More examples**: https://github.com/davidhamann/python-fmrest/tree/master/examples\n",
     "- GitHub: https://github.com/davidhamann/python-fmrest (MIT License)\n",
     "- v16 to v17 switch: https://davidhamann.de/2018/05/15/python-fmrest-and-filemaker-17-data-api/\n",
     "- Support and issues: https://github.com/davidhamann/python-fmrest/issues"