Merge pull request snychka#5 from pluralsight-projects/module1

Module1

Author: hugo-valle

README.md

@@ -4,6 +4,7 @@
   - [Status](#status)
   - [Overview](#overview)
   - [Installation](#installation)
+    - [Verify Local Environment](#verify-local-environment)
     - [Windows](#windows)
     - [macOS](#macos)
     - [About pip](#about-pip)
@@ -20,6 +21,8 @@ This project is design to be completed on [Pluralsight](https://pluralsight.com)
 
 ## Installation
 
+### Verify Local Environment
+
 ### Windows
 
 Open a command prompt or powershell and run the following commands, replacing 'project-root' with the path to the root folder of the project.
@@ -37,25 +40,29 @@ Open a terminal and run the following commands, replacing 'project-root' with th
 
 ```bash
 > cd 'project-root'
-$ python3 -m venv venv
-$ source venv/bin/activate
-$ pip install -r requirements.txt
+> python3 -m venv venv
+> source venv/bin/activate
+> pip install -r requirements.txt
 ```
 
 *Note: If you've installed Python 3 using a method other than Homebrew, you might need to type `python` in the second command instead of `python3`.*
 
 ### About pip
 
-Versions pip updates frequently, but versions greater than 10.x.x should work with this project.
+`pip` updates frequently, but versions greater than 10.x.x should work with this project.
 
 ## Verify Setup
 
 In order to verify that everything is setup correctly, run the following command from the project root.
 
 ```bash
-> pytest
+pytest
 ```
 
-You should see that all the tests are failing. This is good! We’ll be fixing these tests once we jump into the build step. Every time you want to check your work locally you can type that command, and it will report the status of every task in the project.
+You should see that all the tests are failing. This is good! We’ll be fixing these tests once we jump into the build step.
+
+Every time you want to check your work locally you can type that command, and it will report the status of every task in the project.
 
 ## Previewing Your Work
+
+You can preview your work by opening a terminal, changing to the project root, activating the virtual environment, and executing the appropriate python script. For example `python sensor/sensor.py`.

sensor/load_data.py

@@ -5,3 +5,16 @@
 
 def load_sensor_data():
     sensor_data = []
+
+    sensor_files = glob.glob(os.path.join(os.getcwd(), 'datasets', '*.csv'))
+
+    # Loop over list of files
+    for sensor_file in sensor_files:
+        with open(sensor_file ) as data_file:
+            # Create a csv.DictReader
+            data_reader = csv.DictReader(data_file, delimiter=',')
+            # Loop over each row dictionary
+            for row in data_reader:
+                # Create a list of dictionaries
+                sensor_data.append(row)
+    return sensor_data

sensor/sensor.py

@@ -0,0 +1,6 @@
+# Runner script for all modules
+from load_data import load_sensor_data          # module 2
+
+data = load_sensor_data()
+# print(f"Loaded records {len(data)}")
+print("Loaded records {}".format(len(data)))

sensor/sensor_app.py

@@ -5,6 +5,8 @@
   - [Module 1: Load Sensor Data From Files](#module-1-load-sensor-data-from-files)
     - [Task 1: Import os, glob, and csv](#task-1-import-os-glob-and-csv)
     - [Task 2: Create a Function to parse the data](#task-2-create-a-function-to-parse-the-data)
+    - [Task 3: Set Python File Management](#task-3-set-python-file-management)
+    - [Task 4: Read CSV Files](#task-4-read-csv-files)
   - [Module 2: Create a Class HomeData](#module-2-create-a-class-homedata)
   - [Module 3: Analyze Temperature Data](#module-3-analyze-temperature-data)
   - [Module 4: Analyze Humidity Data](#module-4-analyze-humidity-data)
@@ -21,30 +23,32 @@ Draft.
 
 [//]:# (@pytest.mark.test_load_data_function_module1)
 
-```python
-import os
-import glob
-import csv
-```
-
 The dataset for this project is stored in several CSV files found in the `dataset` folder. It represents the data collected from a device with multiple sensors. The records include measurements of temperature, humidity, energy consumption, and particle count in the air over a given area. The data is collected over a period of 24 hours.  
 
 To start, open the file called `load_data.py` in the `sensor` folder - the rest of the tasks in this module happen in this same file.
 
 At the top of the file create three import statements for `os`, `glob`, and `csv`. These libraries will allow us to work with a collection of files.
 
-### Task 2: Create a Function to parse the data 
+### Task 2: Create a Function to parse the data
 
 [//]:# (@pytest.mark.test_load_data_load_sensor_func_module1)
 
-```python
-def load_sensor_data():
-  # create a list to store data
-  sensor_data = []
-```
-
 Create a method called `load_sensor_data` that takes no arguments.
-In the body of the `load_sensor_data` function, create variable called `sensor_data` and set it as an empty `list`.
+In the body of the `load_sensor_data` function, create variable called `sensor_data` and set it as an empty `list` - the rest of the tasks in this module happen in this function.
+
+### Task 3: Set Python File Management
+
+[//]:# (@pytest.mark.test_load_data_sensor_files_module1)
+
+Below the `sensor_data` variable create another variable called `sensor_files` that is set to a call to the `glob.glob()` function.
+
+Pass `glob` function a single argument, a call to the `os.path.join()` function. In turn pass `os.path.join()` three arguments: `os.getcwd()`, `datasets`, and `*.csv`.
+
+The `datasets` argument corresponds to the folder with your sensor data. The data files are in `csv` format. You may open them and explore the content of the records in them.
+
+### Task 4: Read CSV Files
+
+[//]:# (@pytest.mark.test_load_data_load_sensor_func_module1)
 
 ## Module 2: Create a Class HomeData