Add CI workflow for running unit tests and enhance README with badges

- Created a GitHub Actions workflow to run unit tests on push events.
- Updated .gitignore to exclude additional generated files.
- Enhanced README with badges for Python, NumPy, Pandas, GitHub Actions, and CodeCov.
- Added pandas to requirements.txt for data manipulation.
- Implemented data loading and validation tests for car dataset.

Author: gsaini

.github/workflows/run-tests.yml

@@ -0,0 +1,33 @@
+name: Run Unit Tests
+
+on:
+  push:
+    branches:
+      - main
+      - '**' # Runs on all branches
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the repository
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    # Set up Python
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11' # Specify the Python version
+
+    # Install dependencies
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    # Run tests with coverage
+    - name: Run tests
+      run: |
+        pytest -v --cov=src/problem_solving_questions --cov-report=html --cov-report=term tests/

.gitignore

@@ -9,3 +9,6 @@ venv/
 .vscode/
 
 logs/
+.pytest_cache/
+htmlcov/
+__pycache__/

README.md

@@ -1,5 +1,13 @@
 # Hack Complex Problems Together
 
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+![Streamlit](https://img.shields.io/badge/Streamlit-%23FE4B4B.svg?style=for-the-badge&logo=streamlit&logoColor=white)
+![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)
+![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
+![CodeCov](https://img.shields.io/badge/codecov-%23ff0077.svg?style=for-the-badge&logo=codecov&logoColor=white)
+
+
 ## To install project dependencies..
 ```
 pip install -r requirement.txt

requirements.txt

@@ -1,2 +1,3 @@
 pytest
+pandas
 pytest-cov

src/datamanipulation/add_cars_column_names.py

@@ -0,0 +1,10 @@
+import pandas as pd
+
+# Define column names
+column_names = ['mpg', 'cylinders', 'displacement', 'horsepower', 'weight', 'acceleration', 'model year', 'origin', 'car name']
+
+# Import the dataset and assign column names
+cars_data = pd.read_csv('data/auto-mpg-data.txt', sep='\s+', header=None, names=column_names)
+
+# Display the first few rows of the dataset
+print(cars_data.head().to_string())

tests/test_add_cars_column_names.py

@@ -0,0 +1,22 @@
+import pandas as pd
+import pytest
+
+# Define the test function
+def test_cars_data_loading():
+    # Define column names
+    column_names = ['mpg', 'cylinders', 'displacement', 'horsepower', 'weight', 'acceleration', 'model year', 'origin', 'car name']
+    
+    # Load the dataset
+    cars_data = pd.read_csv('data/auto-mpg-data.txt', sep='\s+', header=None, names=column_names)
+    
+    # Assert that the dataset is not empty
+    assert not cars_data.empty, "The dataset should not be empty."
+    
+    # Assert that the column names are correctly assigned
+    assert list(cars_data.columns) == column_names, "Column names do not match the expected names."
+    
+    # Assert that the dataset has the correct number of columns
+    assert cars_data.shape[1] == len(column_names), "The dataset should have exactly 9 columns."
+    
+    # Assert that the dataset has rows
+    assert cars_data.shape[0] > 0, "The dataset should have at least one row."