csv-sanitizer-schema-validator 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- csv_sanitizer_schema_validator-0.1.0/.gitattributes +2 -0
- csv_sanitizer_schema_validator-0.1.0/.gitignore +186 -0
- csv_sanitizer_schema_validator-0.1.0/LICENSE +21 -0
- csv_sanitizer_schema_validator-0.1.0/PKG-INFO +97 -0
- csv_sanitizer_schema_validator-0.1.0/README.md +82 -0
- csv_sanitizer_schema_validator-0.1.0/SECURITY.md +28 -0
- csv_sanitizer_schema_validator-0.1.0/data/Input/dirty_data.csv +8 -0
- csv_sanitizer_schema_validator-0.1.0/data/Output/clean_data.csv +6 -0
- csv_sanitizer_schema_validator-0.1.0/pyproject.toml +32 -0
- csv_sanitizer_schema_validator-0.1.0/requirements.txt +8 -0
- csv_sanitizer_schema_validator-0.1.0/src/CSV_Sanitizer/__init__.py +0 -0
- csv_sanitizer_schema_validator-0.1.0/src/CSV_Sanitizer/cli.py +80 -0
- csv_sanitizer_schema_validator-0.1.0/src/CSV_Sanitizer/core.py +94 -0
- csv_sanitizer_schema_validator-0.1.0/tests/__init__.py +0 -0
- csv_sanitizer_schema_validator-0.1.0/tests/test_main.py +63 -0
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# UV
|
|
98
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
99
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
100
|
+
# commonly ignored for libraries.
|
|
101
|
+
#uv.lock
|
|
102
|
+
|
|
103
|
+
# poetry
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
108
|
+
#poetry.lock
|
|
109
|
+
|
|
110
|
+
# pdm
|
|
111
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
112
|
+
#pdm.lock
|
|
113
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
114
|
+
# in version control.
|
|
115
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
|
116
|
+
.pdm.toml
|
|
117
|
+
.pdm-python
|
|
118
|
+
.pdm-build/
|
|
119
|
+
|
|
120
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
121
|
+
__pypackages__/
|
|
122
|
+
|
|
123
|
+
# Celery stuff
|
|
124
|
+
celerybeat-schedule
|
|
125
|
+
celerybeat.pid
|
|
126
|
+
|
|
127
|
+
# SageMath parsed files
|
|
128
|
+
*.sage.py
|
|
129
|
+
|
|
130
|
+
# Environments
|
|
131
|
+
.env
|
|
132
|
+
.venv
|
|
133
|
+
env/
|
|
134
|
+
venv/
|
|
135
|
+
ENV/
|
|
136
|
+
env.bak/
|
|
137
|
+
venv.bak/
|
|
138
|
+
|
|
139
|
+
# Spyder project settings
|
|
140
|
+
.spyderproject
|
|
141
|
+
.spyproject
|
|
142
|
+
|
|
143
|
+
# Rope project settings
|
|
144
|
+
.ropeproject
|
|
145
|
+
|
|
146
|
+
# mkdocs documentation
|
|
147
|
+
/site
|
|
148
|
+
|
|
149
|
+
# mypy
|
|
150
|
+
.mypy_cache/
|
|
151
|
+
.dmypy.json
|
|
152
|
+
dmypy.json
|
|
153
|
+
|
|
154
|
+
# Pyre type checker
|
|
155
|
+
.pyre/
|
|
156
|
+
|
|
157
|
+
# pytype static type analyzer
|
|
158
|
+
.pytype/
|
|
159
|
+
|
|
160
|
+
# Cython debug symbols
|
|
161
|
+
cython_debug/
|
|
162
|
+
|
|
163
|
+
# PyCharm
|
|
164
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
165
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
166
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
167
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
168
|
+
#.idea/
|
|
169
|
+
|
|
170
|
+
# Ruff stuff:
|
|
171
|
+
.ruff_cache/
|
|
172
|
+
|
|
173
|
+
# PyPI configuration file
|
|
174
|
+
.pypirc
|
|
175
|
+
|
|
176
|
+
# Cursor
|
|
177
|
+
# Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to
|
|
178
|
+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
|
|
179
|
+
# refer to https://docs.cursor.com/context/ignore-files
|
|
180
|
+
.cursorignore
|
|
181
|
+
.cursorindexingignore
|
|
182
|
+
|
|
183
|
+
# .gitignore
|
|
184
|
+
.env
|
|
185
|
+
__pycache__/
|
|
186
|
+
*.pyc
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 hgandhi2010
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: csv-sanitizer-schema-validator
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Stream, sanitize, and schema-validate messy CSV files
|
|
5
|
+
Project-URL: Homepage, https://github.com/hgandhi2010/CSV_Sanitizer_Schema_Validator
|
|
6
|
+
Author: Hemin Gandhi
|
|
7
|
+
License: MIT
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Python: >=3.9
|
|
10
|
+
Requires-Dist: python-dateutil==2.9.0.post0
|
|
11
|
+
Requires-Dist: python-dotenv==1.0.1
|
|
12
|
+
Provides-Extra: dev
|
|
13
|
+
Requires-Dist: pytest==8.2.2; extra == 'dev'
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
# Enterprise CSV Sanitizer & Schema Validator
|
|
17
|
+
|
|
18
|
+
A production-grade command-line interface (CLI) data engineering utility built to stream, scrub, and validate high-volume unstructured enterprise sheets and application logs cleanly without memory leaks or unhandled script execution crashes.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 🎯 Core Project Overview (STAR Metrics)
|
|
23
|
+
|
|
24
|
+
* **Situation:** Helpdesk systems and standard application roles regularly deal with corrupted data pipelines, downstream import rejections, and crashing analytics engines due to malformed, unescaped, and corrupt manual CSV exports from legacy corporate platforms.
|
|
25
|
+
|
|
26
|
+
* **Task:** Build a resilient, automated command-line sanitation workflow capable of operating completely isolated from system-level environment risks. It must stream arbitrary file volumes, standardize dynamic mixed date formats, isolate corrupt multi-column breaks, and strip invisible anomalies without processing loop disruptions.
|
|
27
|
+
|
|
28
|
+
* **Action:** Implemented a strict modular Python streaming engine. Wrapped processing iterations within isolated `try-except` data boundaries, enforced `python-dotenv` masking configurations to eliminate raw environment path leaks, integrated `python-dateutil` for automated timeline parsing, and diverted structural edge cases into isolated fault logs.
|
|
29
|
+
|
|
30
|
+
* **Result:** Achieved 100% crash-resilient streaming loops over highly asymmetric rows. Converts messy runtime string configurations into clean ISO 8601 formatting, intercepts operating system level directory faults safely, and scales gracefully across large data sheets with a flat horizontal memory allocation signature.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## ⚙️ Environment Setup & Installation
|
|
35
|
+
|
|
36
|
+
1. Initialize the Virtual Workspace
|
|
37
|
+
Isolate the project dependency layout from your global system environment:
|
|
38
|
+
|
|
39
|
+
```powershell
|
|
40
|
+
python -m venv .venv
|
|
41
|
+
.\.venv\Scripts\Activate.ps1
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
2. Dependency Ingestion
|
|
45
|
+
Install the concrete engine components into your active virtual bubble:
|
|
46
|
+
python -m pip install python-dotenv python-dateutil pytest
|
|
47
|
+
|
|
48
|
+
3. Environment Context
|
|
49
|
+
Create an .env file in the root workspace directory to configure engine file streams dynamically:
|
|
50
|
+
TARGET_INPUT_DIR=./data/Input
|
|
51
|
+
CLEAN_OUTPUT_DIR=./data/Output
|
|
52
|
+
ERROR_LOG_PATH=./data/Output/malformed_rows.log
|
|
53
|
+
|
|
54
|
+
🚀 Execution & Verification Pipelines
|
|
55
|
+
Core Pipeline Execution
|
|
56
|
+
To ingest, sanitize, and execute the core cleaning loops against your raw data targets:
|
|
57
|
+
python .\Src\main.py
|
|
58
|
+
|
|
59
|
+
Test Suite Validation
|
|
60
|
+
Execute full system assertion validations via the explicit Python module path layer:
|
|
61
|
+
python -m pytest -v
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
📊 Pipeline Architecture
|
|
65
|
+
The following data flow map demonstrates how data transitions through our validation layers cleanly:
|
|
66
|
+
|
|
67
|
+
```mermaid
|
|
68
|
+
graph TD
|
|
69
|
+
%% Base Color Layout Schemes
|
|
70
|
+
classDef input fill:#0d47a1,stroke:#1565c0,stroke-width:2px,color:#ffffff;
|
|
71
|
+
classDef process fill:#1e293b,stroke:#3b82f6,stroke-width:2px,color:#f8fafc;
|
|
72
|
+
classDef decision fill:#311b92,stroke:#673ab7,stroke-width:2px,color:#ffffff;
|
|
73
|
+
classDef success fill:#1b5e20,stroke:#2e7d32,stroke-width:2px,color:#ffffff;
|
|
74
|
+
classDef failure fill:#b71c1c,stroke:#c62828,stroke-width:2px,color:#ffffff;
|
|
75
|
+
|
|
76
|
+
%% Data Pipeline Node Tree Map
|
|
77
|
+
A([📥 Raw Dirty CSV Input Target]) --> B[⚙️ Load Environment Config via python-dotenv]
|
|
78
|
+
B --> C{🔍 Is Directory Valid?}
|
|
79
|
+
|
|
80
|
+
C -- Path Fault --> D[❌ Abort Loop & Log Configuration Fault]
|
|
81
|
+
C -- Valid Path --> E[🔄 Stream Row-by-Row Active Iterator]
|
|
82
|
+
|
|
83
|
+
E --> F{📐 Check Column Schema Dimensions}
|
|
84
|
+
|
|
85
|
+
F -- Size Mismatch --> G[⚠️ Route Malformed Row to Fault Log]
|
|
86
|
+
F -- Uniform Schema --> H[🪥 Clean Whitespace & Strip Hidden Bytes]
|
|
87
|
+
|
|
88
|
+
H --> I[📅 Standardize Mixed Timestamps to ISO 8601]
|
|
89
|
+
I --> J[📤 Commit Sanitized Payload to Stream Buffer]
|
|
90
|
+
J --> K([✨ Complete Production CSV File Pipeline])
|
|
91
|
+
|
|
92
|
+
%% Dynamic Class Injections
|
|
93
|
+
class A input;
|
|
94
|
+
class C,F decision;
|
|
95
|
+
class B,E,H,I,J process;
|
|
96
|
+
class D,G failure;
|
|
97
|
+
class K success;
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Enterprise CSV Sanitizer & Schema Validator
|
|
2
|
+
|
|
3
|
+
A production-grade command-line interface (CLI) data engineering utility built to stream, scrub, and validate high-volume unstructured enterprise sheets and application logs cleanly without memory leaks or unhandled script execution crashes.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 🎯 Core Project Overview (STAR Metrics)
|
|
8
|
+
|
|
9
|
+
* **Situation:** Helpdesk systems and standard application roles regularly deal with corrupted data pipelines, downstream import rejections, and crashing analytics engines due to malformed, unescaped, and corrupt manual CSV exports from legacy corporate platforms.
|
|
10
|
+
|
|
11
|
+
* **Task:** Build a resilient, automated command-line sanitation workflow capable of operating completely isolated from system-level environment risks. It must stream arbitrary file volumes, standardize dynamic mixed date formats, isolate corrupt multi-column breaks, and strip invisible anomalies without processing loop disruptions.
|
|
12
|
+
|
|
13
|
+
* **Action:** Implemented a strict modular Python streaming engine. Wrapped processing iterations within isolated `try-except` data boundaries, enforced `python-dotenv` masking configurations to eliminate raw environment path leaks, integrated `python-dateutil` for automated timeline parsing, and diverted structural edge cases into isolated fault logs.
|
|
14
|
+
|
|
15
|
+
* **Result:** Achieved 100% crash-resilient streaming loops over highly asymmetric rows. Converts messy runtime string configurations into clean ISO 8601 formatting, intercepts operating system level directory faults safely, and scales gracefully across large data sheets with a flat horizontal memory allocation signature.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## ⚙️ Environment Setup & Installation
|
|
20
|
+
|
|
21
|
+
1. Initialize the Virtual Workspace
|
|
22
|
+
Isolate the project dependency layout from your global system environment:
|
|
23
|
+
|
|
24
|
+
```powershell
|
|
25
|
+
python -m venv .venv
|
|
26
|
+
.\.venv\Scripts\Activate.ps1
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
2. Dependency Ingestion
|
|
30
|
+
Install the concrete engine components into your active virtual bubble:
|
|
31
|
+
python -m pip install python-dotenv python-dateutil pytest
|
|
32
|
+
|
|
33
|
+
3. Environment Context
|
|
34
|
+
Create an .env file in the root workspace directory to configure engine file streams dynamically:
|
|
35
|
+
TARGET_INPUT_DIR=./data/Input
|
|
36
|
+
CLEAN_OUTPUT_DIR=./data/Output
|
|
37
|
+
ERROR_LOG_PATH=./data/Output/malformed_rows.log
|
|
38
|
+
|
|
39
|
+
🚀 Execution & Verification Pipelines
|
|
40
|
+
Core Pipeline Execution
|
|
41
|
+
To ingest, sanitize, and execute the core cleaning loops against your raw data targets:
|
|
42
|
+
python .\Src\main.py
|
|
43
|
+
|
|
44
|
+
Test Suite Validation
|
|
45
|
+
Execute full system assertion validations via the explicit Python module path layer:
|
|
46
|
+
python -m pytest -v
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
📊 Pipeline Architecture
|
|
50
|
+
The following data flow map demonstrates how data transitions through our validation layers cleanly:
|
|
51
|
+
|
|
52
|
+
```mermaid
|
|
53
|
+
graph TD
|
|
54
|
+
%% Base Color Layout Schemes
|
|
55
|
+
classDef input fill:#0d47a1,stroke:#1565c0,stroke-width:2px,color:#ffffff;
|
|
56
|
+
classDef process fill:#1e293b,stroke:#3b82f6,stroke-width:2px,color:#f8fafc;
|
|
57
|
+
classDef decision fill:#311b92,stroke:#673ab7,stroke-width:2px,color:#ffffff;
|
|
58
|
+
classDef success fill:#1b5e20,stroke:#2e7d32,stroke-width:2px,color:#ffffff;
|
|
59
|
+
classDef failure fill:#b71c1c,stroke:#c62828,stroke-width:2px,color:#ffffff;
|
|
60
|
+
|
|
61
|
+
%% Data Pipeline Node Tree Map
|
|
62
|
+
A([📥 Raw Dirty CSV Input Target]) --> B[⚙️ Load Environment Config via python-dotenv]
|
|
63
|
+
B --> C{🔍 Is Directory Valid?}
|
|
64
|
+
|
|
65
|
+
C -- Path Fault --> D[❌ Abort Loop & Log Configuration Fault]
|
|
66
|
+
C -- Valid Path --> E[🔄 Stream Row-by-Row Active Iterator]
|
|
67
|
+
|
|
68
|
+
E --> F{📐 Check Column Schema Dimensions}
|
|
69
|
+
|
|
70
|
+
F -- Size Mismatch --> G[⚠️ Route Malformed Row to Fault Log]
|
|
71
|
+
F -- Uniform Schema --> H[🪥 Clean Whitespace & Strip Hidden Bytes]
|
|
72
|
+
|
|
73
|
+
H --> I[📅 Standardize Mixed Timestamps to ISO 8601]
|
|
74
|
+
I --> J[📤 Commit Sanitized Payload to Stream Buffer]
|
|
75
|
+
J --> K([✨ Complete Production CSV File Pipeline])
|
|
76
|
+
|
|
77
|
+
%% Dynamic Class Injections
|
|
78
|
+
class A input;
|
|
79
|
+
class C,F decision;
|
|
80
|
+
class B,E,H,I,J process;
|
|
81
|
+
class D,G failure;
|
|
82
|
+
class K success;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
We actively monitor and patch the core components of the CSV Sanitizer pipeline. Please ensure you are running the latest version to prevent unhandled script execution bugs.
|
|
6
|
+
|
|
7
|
+
| Version | Supported |
|
|
8
|
+
| ------- | ------------------ |
|
|
9
|
+
| v1.0.x | ✅ Supported |
|
|
10
|
+
| < v1.0 | ❌ Not Supported |
|
|
11
|
+
|
|
12
|
+
## Reporting a Vulnerability
|
|
13
|
+
|
|
14
|
+
We take the security and integrity of data processing pipelines seriously. If you discover a security vulnerability (such as an environment path traversal risk, data leakage exploit, or memory exhaustion vector), please do not open a public GitHub issue.
|
|
15
|
+
|
|
16
|
+
Instead, please report it through the following process:
|
|
17
|
+
|
|
18
|
+
1. **Email the Maintainer:** Send a detailed report to your-email@example.com (replace with your actual email).
|
|
19
|
+
2. **Include Details:** Provide a brief description of the vulnerability, a proof of concept (PoC), and an example of a malformed or malicious CSV row that triggers the exploit.
|
|
20
|
+
3. **Response Timeline:** You will receive an acknowledgment of your report within 48 hours, along with a timeline for a coordinated security patch release.
|
|
21
|
+
|
|
22
|
+
## Core Security Safeguards in This Project
|
|
23
|
+
|
|
24
|
+
This utility enforces a strict data isolation architecture to ensure enterprise compliance:
|
|
25
|
+
|
|
26
|
+
* **No Environment Path Leaks:** System-level paths and directory configurations are completely abstracted out of the codebase using localized `.env` configuration masks via `python-dotenv`.
|
|
27
|
+
* **Zero-Leak Memory Limits:** High-volume files are handled exclusively using row-by-row iterable streaming chunks. Large datasets never flood the system RAM, preventing Denial of Service (DoS) memory exhaustion crashes.
|
|
28
|
+
* **Malicious Row Isolation:** Any structurally compromised, misaligned, or unescaped rows are instantly diverted out of the primary runtime execution bubble into an isolated, local error log folder (`/data/Output/malformed_rows.log`) to keep downstream production servers safe.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
transaction_id,customer_name,join_date,account_role
|
|
2
|
+
TXN001, Hemin Gandhi\t ,07/11/2026,Admin
|
|
3
|
+
TXN002,Alice Smith,2026-07-11 09:25:00,User
|
|
4
|
+
TXN003,Corrupt Line Break,11-07-2026
|
|
5
|
+
TXN004, Bob Jones ,2026/07/11,Moderator
|
|
6
|
+
TXN005,Exploit,Malformed,Row,Data,2026-07-11,User
|
|
7
|
+
TXN006,\ufeffCharlie Brown,07/11/2026,User
|
|
8
|
+
TXN007, Diana Prince ,11-07-2026,Guest
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "csv-sanitizer-schema-validator"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Stream, sanitize, and schema-validate messy CSV files"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = {text = "MIT"}
|
|
11
|
+
requires-python = ">=3.9"
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "Hemin Gandhi"}
|
|
14
|
+
]
|
|
15
|
+
dependencies = [
|
|
16
|
+
"python-dateutil==2.9.0.post0",
|
|
17
|
+
"python-dotenv==1.0.1",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project.optional-dependencies]
|
|
21
|
+
dev = [
|
|
22
|
+
"pytest==8.2.2",
|
|
23
|
+
]
|
|
24
|
+
|
|
25
|
+
[project.scripts]
|
|
26
|
+
csv-sanitizer = "CSV_Sanitizer.cli:main"
|
|
27
|
+
|
|
28
|
+
[project.urls]
|
|
29
|
+
Homepage = "https://github.com/hgandhi2010/CSV_Sanitizer_Schema_Validator"
|
|
30
|
+
|
|
31
|
+
[tool.hatch.build.targets.wheel]
|
|
32
|
+
packages = ["src/CSV_Sanitizer"]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Production Core
|
|
2
|
+
python-dotenv==1.0.1 # Masking your directory configurations safely out of the code.
|
|
3
|
+
# Defensive Parsing Utilities
|
|
4
|
+
python-dateutil==2.9.0.post0 # A lightweight helper library that can smart-parse almost any messy dynamic date
|
|
5
|
+
# string into a clean ISO 8601 format without requiring complex regex.
|
|
6
|
+
|
|
7
|
+
# Tiny Testing Suite
|
|
8
|
+
pytest==8.2.2 # The ultra-clean, industry-standard lightweight framework for testing your isolated edge-case functions.
|
|
File without changes
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
"""Command-line entry point for csv-sanitizer."""
|
|
2
|
+
|
|
3
|
+
import argparse
|
|
4
|
+
import os
|
|
5
|
+
import sys
|
|
6
|
+
from pathlib import Path
|
|
7
|
+
|
|
8
|
+
from dotenv import load_dotenv
|
|
9
|
+
|
|
10
|
+
from .core import sanitize_csv
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def get_enterprise_paths():
|
|
14
|
+
"""Legacy .env fallback: TARGET_INPUT_DIR / CLEAN_OUTPUT_DIR / ERROR_LOG_PATH."""
|
|
15
|
+
BASE_DIR = Path(__file__).resolve().parent.parent.parent
|
|
16
|
+
load_dotenv(dotenv_path=BASE_DIR / ".env", override=True)
|
|
17
|
+
|
|
18
|
+
input_dir = os.getenv("TARGET_INPUT_DIR")
|
|
19
|
+
output_dir = os.getenv("CLEAN_OUTPUT_DIR")
|
|
20
|
+
log_path = os.getenv("ERROR_LOG_PATH")
|
|
21
|
+
|
|
22
|
+
if not input_dir or not output_dir:
|
|
23
|
+
raise EnvironmentError(
|
|
24
|
+
"TARGET_INPUT_DIR and CLEAN_OUTPUT_DIR must be set in .env"
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
input_csv = Path(input_dir) / "dirty_data.csv"
|
|
28
|
+
output_csv = Path(output_dir) / "clean_data.csv"
|
|
29
|
+
return str(input_csv), str(output_csv), log_path
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def build_parser():
|
|
33
|
+
parser = argparse.ArgumentParser(
|
|
34
|
+
prog="csv-sanitizer",
|
|
35
|
+
description="Stream, sanitize, and schema-validate a messy CSV file.",
|
|
36
|
+
)
|
|
37
|
+
parser.add_argument(
|
|
38
|
+
"input", nargs="?", default=None, help="Path to the dirty input CSV file"
|
|
39
|
+
)
|
|
40
|
+
parser.add_argument(
|
|
41
|
+
"output", nargs="?", default=None, help="Path to write the cleaned CSV file"
|
|
42
|
+
)
|
|
43
|
+
parser.add_argument(
|
|
44
|
+
"--log",
|
|
45
|
+
dest="log_path",
|
|
46
|
+
default=None,
|
|
47
|
+
help="Optional path for a log of skipped rows",
|
|
48
|
+
)
|
|
49
|
+
return parser
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def main(argv=None) -> int:
|
|
53
|
+
args = build_parser().parse_args(argv)
|
|
54
|
+
input_path, output_path, log_path = args.input, args.output, args.log_path
|
|
55
|
+
|
|
56
|
+
if not input_path or not output_path:
|
|
57
|
+
try:
|
|
58
|
+
input_path, output_path, env_log_path = get_enterprise_paths()
|
|
59
|
+
log_path = log_path or env_log_path
|
|
60
|
+
except EnvironmentError as e:
|
|
61
|
+
print(
|
|
62
|
+
f"Error: no input/output given, and no .env fallback found.\n {e}",
|
|
63
|
+
file=sys.stderr,
|
|
64
|
+
)
|
|
65
|
+
return 1
|
|
66
|
+
|
|
67
|
+
try:
|
|
68
|
+
stats = sanitize_csv(input_path, output_path, log_path)
|
|
69
|
+
except FileNotFoundError:
|
|
70
|
+
print(f"Error: input file not found: {input_path}", file=sys.stderr)
|
|
71
|
+
return 1
|
|
72
|
+
|
|
73
|
+
print(
|
|
74
|
+
f"Done. {stats['rows_written']} rows written, {stats['rows_skipped']} rows skipped."
|
|
75
|
+
)
|
|
76
|
+
return 0
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
if __name__ == "__main__":
|
|
80
|
+
sys.exit(main())
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
"""Core CSV sanitization and schema-validation logic.
|
|
2
|
+
|
|
3
|
+
Nothing in this file runs on import — everything happens inside sanitize_csv().
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
import logging
|
|
7
|
+
from pathlib import Path
|
|
8
|
+
|
|
9
|
+
from dateutil import parser
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def clean_whitespace(dirty_input: str) -> str:
|
|
13
|
+
if not isinstance(dirty_input, str):
|
|
14
|
+
return ""
|
|
15
|
+
cleaned_string = dirty_input.replace("\ufeff", "")
|
|
16
|
+
return cleaned_string.strip()
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def parse_to_iso_8601(date_str: str) -> str:
|
|
20
|
+
parsed_date = parser.parse(date_str)
|
|
21
|
+
clean_date = parsed_date.date().isoformat()
|
|
22
|
+
return clean_date
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def validate_row_schema(row: list, expected_length: int) -> bool:
|
|
26
|
+
return len(row) == expected_length
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
def sanitize_csv(input_path, output_path, log_path=None) -> dict:
|
|
30
|
+
"""Reads input_path, writes a cleaned CSV to output_path.
|
|
31
|
+
|
|
32
|
+
Returns {"rows_written": int, "rows_skipped": int}.
|
|
33
|
+
"""
|
|
34
|
+
input_path = Path(input_path)
|
|
35
|
+
output_path = Path(output_path)
|
|
36
|
+
output_path.parent.mkdir(parents=True, exist_ok=True)
|
|
37
|
+
|
|
38
|
+
if log_path:
|
|
39
|
+
log_path = Path(log_path)
|
|
40
|
+
log_path.parent.mkdir(parents=True, exist_ok=True)
|
|
41
|
+
logging.basicConfig(
|
|
42
|
+
filename=str(log_path),
|
|
43
|
+
filemode="a",
|
|
44
|
+
level=logging.INFO,
|
|
45
|
+
format="%(asctime)s - %(levelname)s - %(message)s",
|
|
46
|
+
force=True,
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
rows_written = 0
|
|
50
|
+
rows_skipped = 0
|
|
51
|
+
|
|
52
|
+
with (
|
|
53
|
+
open(input_path, "r", encoding="utf-8") as file,
|
|
54
|
+
open(output_path, "w", encoding="utf-8") as cleaned_file,
|
|
55
|
+
):
|
|
56
|
+
row_headings = file.readline()
|
|
57
|
+
header_list = [clean_whitespace(h) for h in row_headings.split(",")]
|
|
58
|
+
expected_length = len(header_list)
|
|
59
|
+
|
|
60
|
+
clean_headings = ",".join(header_list) + "\n"
|
|
61
|
+
cleaned_file.write(clean_headings)
|
|
62
|
+
|
|
63
|
+
for line in file:
|
|
64
|
+
cleaned_line = line.strip()
|
|
65
|
+
if not cleaned_line:
|
|
66
|
+
continue
|
|
67
|
+
|
|
68
|
+
raw_row = cleaned_line.split(",")
|
|
69
|
+
|
|
70
|
+
if not validate_row_schema(raw_row, expected_length):
|
|
71
|
+
logging.warning(f"MALFORMED ROW ISOLATED (COLUMN MISMATCH): {raw_row}")
|
|
72
|
+
rows_skipped += 1
|
|
73
|
+
continue
|
|
74
|
+
|
|
75
|
+
try:
|
|
76
|
+
cleaned_id = clean_whitespace(raw_row[0])
|
|
77
|
+
cleaned_name = clean_whitespace(raw_row[1])
|
|
78
|
+
cleaned_date = parse_to_iso_8601(raw_row[2])
|
|
79
|
+
cleaned_role = clean_whitespace(raw_row[3])
|
|
80
|
+
|
|
81
|
+
clean_line = (
|
|
82
|
+
f"{cleaned_id},{cleaned_name},{cleaned_date},{cleaned_role}\n"
|
|
83
|
+
)
|
|
84
|
+
cleaned_file.write(clean_line)
|
|
85
|
+
rows_written += 1
|
|
86
|
+
|
|
87
|
+
except Exception as parsing_err:
|
|
88
|
+
logging.warning(
|
|
89
|
+
f"MALFORMED ROW ISOLATED (PARSING ERROR): {raw_row} | Reason: {parsing_err}"
|
|
90
|
+
)
|
|
91
|
+
rows_skipped += 1
|
|
92
|
+
continue
|
|
93
|
+
|
|
94
|
+
return {"rows_written": rows_written, "rows_skipped": rows_skipped}
|
|
File without changes
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import pytest
|
|
2
|
+
from CSV_Sanitizer.core import clean_whitespace, parse_to_iso_8601, validate_row_schema
|
|
3
|
+
|
|
4
|
+
# ==============================================================================
|
|
5
|
+
# 1. TESTING WHITESPACE SANITIZATION
|
|
6
|
+
# ==============================================================================
|
|
7
|
+
def test_clean_whitespace_strips_hidden_characters():
|
|
8
|
+
"""Ensure leading, trailing, and hidden whitespace tabs are cleanly stripped."""
|
|
9
|
+
dirty_input = " Hemin Gandhi\t "
|
|
10
|
+
expected_output = "Hemin Gandhi"
|
|
11
|
+
assert clean_whitespace(dirty_input) == expected_output
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# ==============================================================================
|
|
15
|
+
# 2. TESTING DYNAMIC DATE TIMELINE PARSING
|
|
16
|
+
# ==============================================================================
|
|
17
|
+
@pytest.mark.parametrize(
|
|
18
|
+
"dirty_date, expected_iso",
|
|
19
|
+
[
|
|
20
|
+
("07/11/2026", "2026-07-11"), # US Standard
|
|
21
|
+
pytest.param(
|
|
22
|
+
"11-07-2026",
|
|
23
|
+
"2026-07-11",
|
|
24
|
+
marks=pytest.mark.xfail(
|
|
25
|
+
reason=(
|
|
26
|
+
"dateutil.parser.parse() defaults to month-first, so it can't "
|
|
27
|
+
"tell US vs. European day/month order apart from format alone. "
|
|
28
|
+
"Needs explicit dayfirst handling to actually support this."
|
|
29
|
+
)
|
|
30
|
+
),
|
|
31
|
+
), # European Standard — known limitation, see reason above
|
|
32
|
+
("2026/07/11", "2026-07-11"), # Alternative Slash Standard
|
|
33
|
+
("2026-07-11 09:25:00", "2026-07-11"), # Timestamp Standard — time is dropped by design
|
|
34
|
+
],
|
|
35
|
+
)
|
|
36
|
+
def test_parse_to_iso_8601_handles_mixed_formats(dirty_date, expected_iso):
|
|
37
|
+
"""Ensure python-dateutil correctly standardizes dynamic enterprise date expressions."""
|
|
38
|
+
assert parse_to_iso_8601(dirty_date) == expected_iso
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
# ==============================================================================
|
|
42
|
+
# 3. TESTING SCHEMA & COLUMN BOUNDARIES
|
|
43
|
+
# ==============================================================================
|
|
44
|
+
def test_validate_row_schema_detects_malformed_columns():
|
|
45
|
+
"""Ensure rows that deviate from the expected column length trigger an error flag."""
|
|
46
|
+
expected_header_length = 4 # e.g., [id, name, date, role]
|
|
47
|
+
|
|
48
|
+
good_row = ["1", "Hemin", "2026-07-11", "Admin"]
|
|
49
|
+
bad_row_short = ["2", "Corrupt Line", "2026-07-11"] # Missing role
|
|
50
|
+
bad_row_long = [
|
|
51
|
+
"3",
|
|
52
|
+
"Exploit",
|
|
53
|
+
"Comma, Break",
|
|
54
|
+
"2026-07-11",
|
|
55
|
+
"User",
|
|
56
|
+
] # Too many items
|
|
57
|
+
|
|
58
|
+
# A good row should validate successfully (True)
|
|
59
|
+
assert validate_row_schema(good_row, expected_header_length) is True
|
|
60
|
+
|
|
61
|
+
# Broken asymmetric rows should fail validation (False) instead of throwing an index crash
|
|
62
|
+
assert validate_row_schema(bad_row_short, expected_header_length) is False
|
|
63
|
+
assert validate_row_schema(bad_row_long, expected_header_length) is False
|