traps.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# How to run\n",
    "\n",
    "You can run each cell in order with shift+enter, or run the whole thing at once by using the Kernel menu up above and hitting 'Restart & Run All'\n",
    "\n",
    "This notebook expects a folder structure as follows\n",
    "```\n",
    "---\n",
    " | traps.ipynb\n",
    " |-data\\Orcus - Traps.xlsx\n",
    " |-output\n",
    "```\n",
    "\n",
    "and will take data\\Orcus - Traps.xlsx and create a markdown file output\\traps.md\n",
    "\n",
    "We use Pandas to read in the excel spreadsheet, and define a function which takes a row in the Pandas DataFrame and puts all the values in the right place (with a little logic to handle fields which aren't always there) to create a markdown formatted string.\n",
    "\n",
    "It's pretty similar to what the existing Mail Merge does, but we have complete control over how we build the string and map values. The key Pythonic bit is the curly braces {} and the `**dict`. Curly braces indicate a place that we want to input a value in a string with a **key**, and ** takes a dictionary and puts the values with the proper keys in the proper place.  \n",
    "\n",
    "```\n",
    "'{hello}'.format(**{'hello':'world', 'not_needed':'mars'})\n",
    "evaluates to\n",
    "'world'\n",
    "```\n",
    "\n",
    "\n",
    "Then we join that list of strings and save a file.  For more on Python, I recommend [Automate the Boring Stuff with Python](https://automatetheboringstuff.com/)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "# cell 0, standard imports\n",
    "\n",
    "import pandas as pd\n",
    "import os\n",
    "\n",
    "dot  = '●'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Name</th>\n",
       "      <th>Description</th>\n",
       "      <th>Level</th>\n",
       "      <th>Role</th>\n",
       "      <th>Type</th>\n",
       "      <th>XP</th>\n",
       "      <th>Skill</th>\n",
       "      <th>Notice</th>\n",
       "      <th>Trigger</th>\n",
       "      <th>Countermeasures</th>\n",
       "      <th>...</th>\n",
       "      <th>Attack - Tags</th>\n",
       "      <th>Attack - Type</th>\n",
       "      <th>Attack - Range</th>\n",
       "      <th>Target</th>\n",
       "      <th>Attack - Attack Bonus</th>\n",
       "      <th>Attack - Defense</th>\n",
       "      <th>Attack - Hit</th>\n",
       "      <th>Attack - Miss</th>\n",
       "      <th>Attack - Effect</th>\n",
       "      <th>Special</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>...</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "      <td>a</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Cinder Trap</td>\n",
       "      <td>One sconce is set up to launch its torch at a ...</td>\n",
       "      <td>1</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Warning</td>\n",
       "      <td>25</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 12: The character notices the slow-burning ...</td>\n",
       "      <td>The trap attacks when a character comes into c...</td>\n",
       "      <td>An adjacent character can disable the trap wit...</td>\n",
       "      <td>...</td>\n",
       "      <td>Fire</td>\n",
       "      <td>Ranged</td>\n",
       "      <td>Ranged 5</td>\n",
       "      <td>The creature that triggers the trap.</td>\n",
       "      <td>4</td>\n",
       "      <td>Reflex</td>\n",
       "      <td>1d6+1 fire damage.</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>Simple Spear Trap</td>\n",
       "      <td>A spear shoots out from a hole near to the tri...</td>\n",
       "      <td>1</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Warning</td>\n",
       "      <td>25</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 12: The character notices the mechanism tha...</td>\n",
       "      <td>The trap attacks when a character comes into c...</td>\n",
       "      <td>An adjacent character can disable the spear tr...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td>Melee</td>\n",
       "      <td></td>\n",
       "      <td>The creature that triggers the trap.</td>\n",
       "      <td>4</td>\n",
       "      <td>AC</td>\n",
       "      <td>1d8+3 damage.</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Whistling Staircase</td>\n",
       "      <td>A staircase where the stairs are attached by a...</td>\n",
       "      <td>1</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Warning</td>\n",
       "      <td>25</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 12: The character notices the cords running...</td>\n",
       "      <td>The trap is triggered when a Medium or larger ...</td>\n",
       "      <td>An adjacent character can disable the whistlin...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td>The trapped stairs make a terrible racket, ale...</td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>Quicksand</td>\n",
       "      <td>A patch of quicksand across one or several squ...</td>\n",
       "      <td>1</td>\n",
       "      <td>Hazard</td>\n",
       "      <td>Blocker</td>\n",
       "      <td>50</td>\n",
       "      <td>Nature</td>\n",
       "      <td>DC 18: The character notices that the ground a...</td>\n",
       "      <td>The trap attacks when a character enters one o...</td>\n",
       "      <td>A character in the pit can rise 1 square as a ...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td>Melee</td>\n",
       "      <td></td>\n",
       "      <td>The creature that entered the trigger square.</td>\n",
       "      <td>4</td>\n",
       "      <td>Reflex</td>\n",
       "      <td>The target falls into the pit and sinks 1 squa...</td>\n",
       "      <td>Target returns to last square it occupied and ...</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 23 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                  Name                                        Description  \\\n",
       "0                    a                                                  a   \n",
       "1          Cinder Trap  One sconce is set up to launch its torch at a ...   \n",
       "2    Simple Spear Trap  A spear shoots out from a hole near to the tri...   \n",
       "3  Whistling Staircase  A staircase where the stairs are attached by a...   \n",
       "4            Quicksand  A patch of quicksand across one or several squ...   \n",
       "\n",
       "  Level     Role     Type  XP       Skill  \\\n",
       "0     a        a        a   a           a   \n",
       "1     1  One-Off  Warning  25  Perception   \n",
       "2     1  One-Off  Warning  25  Perception   \n",
       "3     1  One-Off  Warning  25  Perception   \n",
       "4     1   Hazard  Blocker  50      Nature   \n",
       "\n",
       "                                              Notice  \\\n",
       "0                                                  a   \n",
       "1  DC 12: The character notices the slow-burning ...   \n",
       "2  DC 12: The character notices the mechanism tha...   \n",
       "3  DC 12: The character notices the cords running...   \n",
       "4  DC 18: The character notices that the ground a...   \n",
       "\n",
       "                                             Trigger  \\\n",
       "0                                                  a   \n",
       "1  The trap attacks when a character comes into c...   \n",
       "2  The trap attacks when a character comes into c...   \n",
       "3  The trap is triggered when a Medium or larger ...   \n",
       "4  The trap attacks when a character enters one o...   \n",
       "\n",
       "                                     Countermeasures  ... Attack - Tags  \\\n",
       "0                                                  a  ...             a   \n",
       "1  An adjacent character can disable the trap wit...  ...          Fire   \n",
       "2  An adjacent character can disable the spear tr...  ...                 \n",
       "3  An adjacent character can disable the whistlin...  ...                 \n",
       "4  A character in the pit can rise 1 square as a ...  ...                 \n",
       "\n",
       "  Attack - Type Attack - Range                                         Target  \\\n",
       "0             a              a                                              a   \n",
       "1        Ranged       Ranged 5           The creature that triggers the trap.   \n",
       "2         Melee                          The creature that triggers the trap.   \n",
       "3                                                                               \n",
       "4         Melee                 The creature that entered the trigger square.   \n",
       "\n",
       "  Attack - Attack Bonus Attack - Defense  \\\n",
       "0                     a                a   \n",
       "1                     4           Reflex   \n",
       "2                     4               AC   \n",
       "3                                          \n",
       "4                     4           Reflex   \n",
       "\n",
       "                                        Attack - Hit  \\\n",
       "0                                                  a   \n",
       "1                                 1d6+1 fire damage.   \n",
       "2                                      1d8+3 damage.   \n",
       "3                                                      \n",
       "4  The target falls into the pit and sinks 1 squa...   \n",
       "\n",
       "                                       Attack - Miss  \\\n",
       "0                                                  a   \n",
       "1                                                      \n",
       "2                                                      \n",
       "3                                                      \n",
       "4  Target returns to last square it occupied and ...   \n",
       "\n",
       "                                     Attack - Effect Special  \n",
       "0                                                  a       a  \n",
       "1                                                             \n",
       "2                                                             \n",
       "3  The trapped stairs make a terrible racket, ale...          \n",
       "4                                                             \n",
       "\n",
       "[5 rows x 23 columns]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "#cell 1, read in data from filename\n",
    "\n",
    "filename = 'Orcus - Traps.xlsx'\n",
    "\n",
    "#by default Pandas loads missing values with ugly NaNs, so we replace those with the empty string ''\n",
    "data = pd.read_excel(os.path.join('data', filename)).fillna('')\n",
    "data.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Name</th>\n",
       "      <th>Description</th>\n",
       "      <th>Level</th>\n",
       "      <th>Role</th>\n",
       "      <th>Type</th>\n",
       "      <th>XP</th>\n",
       "      <th>Skill</th>\n",
       "      <th>Notice</th>\n",
       "      <th>Trigger</th>\n",
       "      <th>Countermeasures</th>\n",
       "      <th>...</th>\n",
       "      <th>Attack - Tags</th>\n",
       "      <th>Attack - Type</th>\n",
       "      <th>Attack - Range</th>\n",
       "      <th>Target</th>\n",
       "      <th>Attack - Attack Bonus</th>\n",
       "      <th>Attack - Defense</th>\n",
       "      <th>Attack - Hit</th>\n",
       "      <th>Attack - Miss</th>\n",
       "      <th>Attack - Effect</th>\n",
       "      <th>Special</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Cinder Trap</td>\n",
       "      <td>One sconce is set up to launch its torch at a ...</td>\n",
       "      <td>1</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Warning</td>\n",
       "      <td>25</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 12: The character notices the slow-burning ...</td>\n",
       "      <td>The trap attacks when a character comes into c...</td>\n",
       "      <td>An adjacent character can disable the trap wit...</td>\n",
       "      <td>...</td>\n",
       "      <td>Fire</td>\n",
       "      <td>Ranged</td>\n",
       "      <td>Ranged 5</td>\n",
       "      <td>The creature that triggers the trap.</td>\n",
       "      <td>4</td>\n",
       "      <td>Reflex</td>\n",
       "      <td>1d6+1 fire damage.</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>17</th>\n",
       "      <td>Rusty Water Tower</td>\n",
       "      <td>A fragile water tower will collapse if disturb...</td>\n",
       "      <td>5</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Elite Assassin</td>\n",
       "      <td>100</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 15: The character notices that the water to...</td>\n",
       "      <td>The trap is triggered by any attack directly a...</td>\n",
       "      <td>A character can trigger the scaffolding from f...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td>Near</td>\n",
       "      <td>Near burst 5</td>\n",
       "      <td>All creatures.</td>\n",
       "      <td>8</td>\n",
       "      <td>Reflex</td>\n",
       "      <td>3d8+4 damage,  and the target is knocked prone.</td>\n",
       "      <td>Half damage.</td>\n",
       "      <td>All squares in the burst become difficult terr...</td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>Scythe Trap</td>\n",
       "      <td>A scythe swings out from the ceiling to attack...</td>\n",
       "      <td>2</td>\n",
       "      <td>One-Off</td>\n",
       "      <td>Warning</td>\n",
       "      <td>31</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 13: The character notices the scythe blade ...</td>\n",
       "      <td>The trap attacks when a character comes into c...</td>\n",
       "      <td>An adjacent character can disable the scythe b...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td>Melee</td>\n",
       "      <td></td>\n",
       "      <td>The creature that triggers the trap.</td>\n",
       "      <td>5</td>\n",
       "      <td>AC</td>\n",
       "      <td>1d10+3 damage.</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>10</th>\n",
       "      <td>Gate Spikes</td>\n",
       "      <td>When disturbed, spikes shoot out of the top of...</td>\n",
       "      <td>2</td>\n",
       "      <td>Hazard</td>\n",
       "      <td>Assassin</td>\n",
       "      <td>63</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 13: The character notices the hidden mechan...</td>\n",
       "      <td>The trap is triggered when a character attempt...</td>\n",
       "      <td>An adjacent character can disable the spears w...</td>\n",
       "      <td>...</td>\n",
       "      <td></td>\n",
       "      <td>Melee</td>\n",
       "      <td></td>\n",
       "      <td>The creature climbing over the gate.</td>\n",
       "      <td>7</td>\n",
       "      <td>AC</td>\n",
       "      <td>1d8+3 damage.</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>11</th>\n",
       "      <td>Zombie Breakout</td>\n",
       "      <td>The arms and heads protuding of several zombie...</td>\n",
       "      <td>2</td>\n",
       "      <td>Hazard</td>\n",
       "      <td>Blocker</td>\n",
       "      <td>63</td>\n",
       "      <td>Perception</td>\n",
       "      <td>DC 13: The character notices the zombie’s head...</td>\n",
       "      <td>The trap is triggered when a creature enters o...</td>\n",
       "      <td>A character can make a DC 15 (or 30 without an...</td>\n",
       "      <td>...</td>\n",
       "      <td>Necrotic</td>\n",
       "      <td>Melee</td>\n",
       "      <td></td>\n",
       "      <td>The creature in the zombie’s square.</td>\n",
       "      <td>4</td>\n",
       "      <td>AC</td>\n",
       "      <td>2d6+2 necrotic damage, and the target falls pr...</td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "      <td></td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 23 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                 Name                                        Description  \\\n",
       "1         Cinder Trap  One sconce is set up to launch its torch at a ...   \n",
       "17  Rusty Water Tower  A fragile water tower will collapse if disturb...   \n",
       "8         Scythe Trap  A scythe swings out from the ceiling to attack...   \n",
       "10        Gate Spikes  When disturbed, spikes shoot out of the top of...   \n",
       "11    Zombie Breakout  The arms and heads protuding of several zombie...   \n",
       "\n",
       "   Level     Role            Type   XP       Skill  \\\n",
       "1      1  One-Off         Warning   25  Perception   \n",
       "17     5  One-Off  Elite Assassin  100  Perception   \n",
       "8      2  One-Off         Warning   31  Perception   \n",
       "10     2   Hazard        Assassin   63  Perception   \n",
       "11     2   Hazard         Blocker   63  Perception   \n",
       "\n",
       "                                               Notice  \\\n",
       "1   DC 12: The character notices the slow-burning ...   \n",
       "17  DC 15: The character notices that the water to...   \n",
       "8   DC 13: The character notices the scythe blade ...   \n",
       "10  DC 13: The character notices the hidden mechan...   \n",
       "11  DC 13: The character notices the zombie’s head...   \n",
       "\n",
       "                                              Trigger  \\\n",
       "1   The trap attacks when a character comes into c...   \n",
       "17  The trap is triggered by any attack directly a...   \n",
       "8   The trap attacks when a character comes into c...   \n",
       "10  The trap is triggered when a character attempt...   \n",
       "11  The trap is triggered when a creature enters o...   \n",
       "\n",
       "                                      Countermeasures  ... Attack - Tags  \\\n",
       "1   An adjacent character can disable the trap wit...  ...          Fire   \n",
       "17  A character can trigger the scaffolding from f...  ...                 \n",
       "8   An adjacent character can disable the scythe b...  ...                 \n",
       "10  An adjacent character can disable the spears w...  ...                 \n",
       "11  A character can make a DC 15 (or 30 without an...  ...      Necrotic   \n",
       "\n",
       "   Attack - Type Attack - Range                                Target  \\\n",
       "1         Ranged       Ranged 5  The creature that triggers the trap.   \n",
       "17          Near   Near burst 5                        All creatures.   \n",
       "8          Melee                 The creature that triggers the trap.   \n",
       "10         Melee                 The creature climbing over the gate.   \n",
       "11         Melee                 The creature in the zombie’s square.   \n",
       "\n",
       "   Attack - Attack Bonus Attack - Defense  \\\n",
       "1                      4           Reflex   \n",
       "17                     8           Reflex   \n",
       "8                      5               AC   \n",
       "10                     7               AC   \n",
       "11                     4               AC   \n",
       "\n",
       "                                         Attack - Hit Attack - Miss  \\\n",
       "1                                  1d6+1 fire damage.                 \n",
       "17    3d8+4 damage,  and the target is knocked prone.  Half damage.   \n",
       "8                                     1d10+3 damage.                  \n",
       "10                                      1d8+3 damage.                 \n",
       "11  2d6+2 necrotic damage, and the target falls pr...                 \n",
       "\n",
       "                                      Attack - Effect Special  \n",
       "1                                                              \n",
       "17  All squares in the burst become difficult terr...          \n",
       "8                                                              \n",
       "10                                                             \n",
       "11                                                             \n",
       "\n",
       "[5 rows x 23 columns]"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "#cell 2, examine 5 random traps\n",
    "\n",
    "data.sample(5)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [],
   "source": [
    "#cell 3\n",
    "#we define a function which takes in a row of this trap dataframe and returns an md string\n",
    "\n",
    "def trap_to_md(row):\n",
    "    \n",
    "    #converting the row to a dictionary let's use do some cool stuff with placing values in strings using .format(**row_dict)\n",
    "    row_dict = dict(row)\n",
    "    \n",
    "    #remove leading and trailing whitespace\n",
    "    for k, v in row_dict.items():\n",
    "        row_dict[k] = str(v).strip()\n",
    "    \n",
    "    # we use completion to check a few edge cases\n",
    "    completion = dict()\n",
    "    for key,value in row.items():\n",
    "        if value:\n",
    "            completion[key] = value\n",
    "    \n",
    "    if row_dict.get('Name') == 'Chapter':\n",
    "        md = '# {List}  '.format(**row_dict)\n",
    "#        if row['Details']:\n",
    "#            md += \"\\n\\n{Details}  \".format(**row_dict)\n",
    "        return md\n",
    "    \n",
    "   \n",
    "    # we check if nothing is filling in and return an empty row\n",
    "    if list(completion.keys()) == []:\n",
    "        md = ''\n",
    "        return md\n",
    "    \n",
    "    #start with name. md is the string we'll be outputing\n",
    "    md = \"### {Name}  \".format(**row_dict)\n",
    "    \n",
    "    #add flavor if it exists\n",
    "    \n",
    "    if row['Description']:\n",
    "        md += '\\n*{Description}*  '.format(**row_dict)\n",
    "    \n",
    "    #'\\n' is Python for new line\n",
    "    if row['Level']:\n",
    "        md += \"\\n\\n**Level {Level} {Role} {Type}** ({XP} XP Trap)  \".format(**row_dict)\n",
    "        \n",
    "    #modify tags a little, since they aren't always present    \n",
    "    if row_dict.get('Tags'):\n",
    "        row_dict['Tags'] = '● **{Tags}**'.format(**row_dict)\n",
    "    \n",
    "    if row['Skill']:\n",
    "        md += '\\n\\n{Skill} {Notice}  '.format(**row_dict)\n",
    "    \n",
    "    #if a field exists, we add it\n",
    "    if row['Trigger']:\n",
    "        md += '\\n\\n**Trigger** {Trigger}  '.format(**row_dict)\n",
    "                \n",
    "    if row['Target']:\n",
    "        md += '\\n**Target** {Target}  '.format(**row_dict)\n",
    "\n",
    "            \n",
    "    if row_dict.get('Attack - Tags'):\n",
    "        row_dict['Attack - Tags'] = '● **{Attack - Tags}**'.format(**row_dict)\n",
    "        \n",
    "    if row_dict.get('Attack - Range'):\n",
    "        row_dict['Attack - Range'] = '{Attack - Range}; '.format(**row_dict)\n",
    "    \n",
    "    if row_dict.get('Attack - Attack Bonus'):\n",
    "        row_dict['Attack - Attack Bonus'] = '+{Attack - Attack Bonus}'.format(**row_dict)\n",
    "        \n",
    "    # Need to untangle so Rider displayed regardless of Defense existing\n",
    "    \n",
    "    if row_dict.get('Attack - Type') == 'Melee':\n",
    "        row_dict['Attack - Type'] = '†\t'.format(**row_dict)\n",
    " \n",
    "    if row_dict.get('Attack - Type') == 'Basic Melee':\n",
    "        row_dict['Attack - Type'] = '‡\t'.format(**row_dict)\n",
    "\n",
    "    if row_dict.get('Attack - Type') == 'Ranged':\n",
    "        row_dict['Attack - Type'] = '↗\t'.format(**row_dict)\n",
    " \n",
    "    if row_dict.get('Attack - Type') == 'Basic Ranged':\n",
    "        row_dict['Attack - Type'] = '⤢\t'.format(**row_dict)\n",
    "\n",
    "    if row_dict.get('Attack - Type') == 'Near':\n",
    "        row_dict['Attack - Type'] = '∢\t'.format(**row_dict)\n",
    "\n",
    "    if row_dict.get('Attack - Type') == 'Far':\n",
    "        row_dict['Attack - Type'] = '⋇\t'.format(**row_dict)\n",
    "        \n",
    "    if row['Attack - Name']:\n",
    "        md += \"\"\"\\n\\n{Attack - Type}**{Attack - Name}**\"\"\".format(**row_dict)\n",
    "        \n",
    "    if row['Attack - Name']:\n",
    "        md += \"\"\" {Attack - Tags}  \"\"\".format(**row_dict)\n",
    "        md += \"\"\"\\n{Attack - Range}{Attack - Attack Bonus}\"\"\".format(**row_dict)\n",
    "    \n",
    "    if row['Attack - Defense']:\n",
    "        md += \"\"\" vs {Attack - Defense}\"\"\".format(**row_dict)\n",
    "\n",
    "    md += '  '.format(**row_dict)\n",
    "    \n",
    "    if row['Attack - Hit']:\n",
    "        md += \"\"\"\\n*Hit* {Attack - Hit}  \"\"\".format(**row_dict)\n",
    "    \n",
    "    if row['Attack - Miss']:\n",
    "        md += \"\"\"\\n*Miss* {Attack - Miss}  \"\"\".format(**row_dict)\n",
    "    \n",
    "    if row['Attack - Effect']:\n",
    "        md += \"\"\"\\n*Effect* {Attack - Effect}  \"\"\".format(**row_dict)\n",
    "    \n",
    "    if row['Special']:\n",
    "        md += '\\n\\n**Special** {Special}  '.format(**row_dict)\n",
    "        \n",
    "    if row['Countermeasures']:\n",
    "        md += '\\n\\n**Countermeasures** \\n{Countermeasures}  '.format(**row_dict)\n",
    "        \n",
    "    #finally we remove the empty tags\n",
    "    return md.replace('****','')\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "#cell 4\n",
    "#this cell converts the dataframe into a list of markdown formatted strings using the function defined above\n",
    "\n",
    "output = []\n",
    "\n",
    "for idx, row in data.iterrows():\n",
    "    md = trap_to_md(row)\n",
    "    if md: #this removes empty lines, which you may not want\n",
    "        output.append(md)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "#cell 5\n",
    "#we can look at elements here using Python list slicing\n",
    "\n",
    "for elem in output[100:110]:\n",
    "    print(elem)\n",
    "    print('')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [],
   "source": [
    "#cell 6\n",
    "# now we have to save to disk\n",
    "\n",
    "fname =  'Orcus Traps.md'\n",
    "\n",
    "with open(os.path.join('output', fname), 'w', encoding='utf-8') as f:\n",
    "    f.write('\\n\\n'.join(output))"
   ]
  }
 ],
 "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.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}