issue #98 removed DTTD Python Package notebook

See merge request CMSE/datatools_tutorial_demo!115

DTTD_Python_Package.ipynb

-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0dec5833",
-   "metadata": {},
-   "source": [
-    "## Creating a Python Package ##\n",
-    "\n",
-    "### By: QSIDE JUSTFAIR 2023\n",
-    "\n",
-    "----------------------------------------------------"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0c128f8e",
-   "metadata": {},
-   "source": [
-    "## Introduction\n",
-    "\n",
-    "Have you ever made a bunch of cool Python functions, but find yourself copying your code over and over again onto new documents?  You can solve this problem by creating a Python package. In this tutorial, we’ll walk you through how to create your own Python package!"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3d3bf097",
-   "metadata": {},
-   "source": [
-    "### Step 1: Creating Your File Structure\n",
-    "\n",
-    "The basic file structure for creating a package is as follows:\n",
-    "\n",
-    "* Create your setup.py\n",
-    "\n",
-    "    * This file is used to install your package\n",
-    "\n",
-    "* Create a folder with your package name\n",
-    "\n",
-    "    * Inside the folder, have the following python files:\n",
-    "\n",
-    "        * __init__.py()\n",
-    "\n",
-    "            * This file sets up your package\n",
-    "\n",
-    "        * Python_files_you_want.py\n",
-    "\n",
-    "            * You can have any number of other .py files\n",
-    "\n",
-    "Here's a useful exampe:\n",
-    "\n",
-    "            https://github.com/colbrydi/CMSE802_Project_Template"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ff0a6055",
-   "metadata": {},
-   "source": [
-    "### Step 2: Creating setup.py\n",
-    "\n",
-    "Setup.py is one of the essential Python files for a package to work.  The important things to do here are declare the name of your package and all packages that are used by your package (for example, if you use numpy in one of your .py files, you’ll need to add numpy to your install_requires list."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "d71d545b",
-   "metadata": {},
-   "source": [
-    "Here's an example of how to create a setup.py:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "bb4e68e3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "python\n",
-    "from setuptools import setup\n",
-    "\n",
-    "setup(\n",
-    "\n",
-    "    name='JUSTFAIR_Tools',\n",
-    "\n",
-    "    version='0.1dev',\n",
-    "\n",
-    "    packages= ['JUSTFAIR_Tools'],\n",
-    "\n",
-    "    license='General Public License 3.0',\n",
-    "\n",
-    "    install_requires = ['matplotlib', 'pandas', 'numpy']\n",
-    "\n",
-    "    #long_description=open('README.md').read(),\n",
-    "\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "12822d98",
-   "metadata": {},
-   "source": [
-    "***OPTIONAL: there is another way to create the environment with a makefile and an environment.yml, the Github example link does this***"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "42b6e46b",
-   "metadata": {},
-   "source": [
-    "### Step 3: Creating an init.py\n",
-    "\n",
-    "\n",
-    "Next, we’ll need to enter our package folder and create the __init__.py.  This file can be blank, but if you want some of your python files to come pre-loaded, import them here with\n",
-    "\n",
-    "* From package_name.file_name import function_name\n",
-    "\n",
-    "    * you can do import * for all functions in the file\n",
-    "\n",
-    "    * Additionally, you can import files in your document as well if not done in the init file."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "408b017b",
-   "metadata": {},
-   "source": [
-    "##### That’s it!  All you need to do now is impoort your package with  \n",
-    "\n",
-    "**import packagename**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9b96dae7",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.12"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}