Merge pull request #5 from UBC-MDS/check-csv

Add function for checking csv
UBC-MDS · Jan 9, 2025 · 7251338 · 7251338
2 parents 81d6802 + 79c0207
commit 7251338
Show file tree

Hide file tree

Showing 7 changed files with 260 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,12 @@ A python package to support exploratory data analysis!
 ## Contributors
 Catherine Meng, Jessie Zhang, Zheng He
 
+## Functions
+- **`check_csv`**  
+    Check if the given file is a CSV file by its extension.
+- **`missing_value_summary`**   
+- **`get_summary_statistics`**   
+
 ## Installation
 
 ```bash
@@ -13,7 +19,6 @@ $ pip install pyeda
 
 ## Usage
 
-- TODO
 
 ## Contributing
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -9,6 +9,10 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.9"
 
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.4"
+pytest-cov = "^6.0.0"
+
 [tool.semantic_release]
 version_toml = [
     "pyproject.toml:tool.poetry.version",

diff --git a/src/pyeda/check_csv.py b/src/pyeda/check_csv.py
@@ -0,0 +1,11 @@
+def check_csv(file_path):
+    """
+    Check if the given file is a CSV file by its extension.
+
+    Args:
+    file_path (str): Path to the file.
+
+    Returns:
+    bool: True if the file is a CSV file, False otherwise.
+    """
+    pass
diff --git a/src/pyeda/pyeda.py b/src/pyeda/pyeda.py
diff --git a/tests/test_check_csv.py b/tests/test_check_csv.py
@@ -0,0 +1 @@
+from pyeda import check_csv
diff --git a/tests/test_pyeda.py b/tests/test_pyeda.py