adding the actual custom_modules notebook...

Author: William Glass

content/good_practice/custom_modules.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Packages"
+    "# Custom Modules"
    ]
   },
   {
@@ -16,7 +16,7 @@
     "* functions\n",
     "* types\n",
     "* collections\n",
-    "* loops"
+    "* packages"
    ]
   },
   {
@@ -25,16 +25,21 @@
    "source": [
     "# Modules\n",
     "\n",
-    "Before describing what a Python package is, we must first understand Python modules. We are now comfortable with writing simple Python code and may now want to write our first dedicated program. But what is the best way to set out our code? One of the key concepts in programming is the creation of simple and easy to maintain code, this is where modules come in. \n",
-    "\n",
-    "Instead of creating one large piece of code that can often be unwieldy we can break it up into smaller chunks, or modules. Each module has a specific functionality that allows it to be reused without the need for duplicating code."
+    "Instead of creating one large piece of code that can often be unwieldy we can break it up into smaller chunks, or modules. Modules can be accessed through installed packages or they can written by the user. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Custom Modules"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Below is an example module called `print_things.py`:"
+    "Below is an example of a custom module (i.e. one we have writeen ourselves) called `print_things.py`:"
    ]
   },
   {
@@ -100,15 +105,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "output_type": "stream",
-     "name": "stdout",
-     "text": "Hydrogen\nHelium\nLithium\nKey: Hydrogen, Value: 1\nKey: Helium, Value: 2\nKey: Lithium, Value: 3\n"
-    }
-   ],
+   "outputs": [],
    "source": [
     "import print_things\n",
     "\n",
@@ -121,13 +120,6 @@
     "print_things.print_dictionary(element_protons)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Using `from`"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -137,15 +129,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "output_type": "stream",
-     "name": "stdout",
-     "text": "Hydrogen\nHelium\nLithium\n"
-    }
-   ],
+   "outputs": [],
    "source": [
     "from print_things import print_names\n",
     "\n",
@@ -170,16 +156,16 @@
     "Another useful way to use both the `import` / `from` statements is to `import` modules and use an alternative name:\n",
     "\n",
     "```python\n",
-    "from print_things import print_names as pn #  import print_names from the print_things module \n",
-    "import print_things as pt  # import the whole print_things module\n",
+    "from print_things import print_names as pn #  Import print_names from the print_things module \n",
+    "import print_things as pt  # Import the whole print_things module\n",
     "``` "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Packages"
+    "## Organising Modules: Packages"
    ]
   },
   {
@@ -221,24 +207,6 @@
     "\n",
     "Luckily we usually don't need to worry about where packages are as we can use a dedicated package manager to automatically take care of their location for us. These managers are useful and contain a huge variety of different packages that aren't included within Python as standard. For example, packages such as `NumPy` are commonly retrieved this way. \n"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Python Package Managers"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "TODO\n",
-    "\n",
-    "pip\n",
-    "\n",
-    "conda\n"
-   ]
   }
  ],
  "metadata": {