Initial Commit of the PDM project (ready for DWS migration)

helpers/samples/README.md

@@ -0,0 +1,42 @@
+# Input File Format Reference
+
+The actual input CSVs under `helpers/` are gitignored (they are environment-specific
+and often large). These samples document the expected format for each script so you
+don't have to guess next time.
+
+All sample files use a minimal set of example rows. **No headers**, **UTF-8** (with or
+without BOM). Empty lines are skipped.
+
+## Full-path format
+
+Used by `batch_workflows_paths.py` and any script whose CLI takes `--csv` / `-c` and
+operates on files already inside the vault.
+
+- One full Windows vault path per line.
+- Path must match what `IEdmVault5.GetFileFromPath` expects — i.e. the real location
+  inside the vault's local view (e.g. `C:\PDM\<VaultName>\...`).
+- Extension-sensitive: `.SLDPRT`, `.SLDDRW`, `.SLDASM`, `.pdf`, etc. all count as
+  distinct files.
+
+See `sample_full_paths.csv`.
+
+## Part-number format
+
+Used by `batch_copy_tree.py` (and other scripts that resolve files by part/document
+number rather than path).
+
+- One part number per line.
+- No extension, no path.
+- Case and dashes/underscores should match the vault's stored value.
+
+See `sample_part_numbers.csv`.
+
+## Filename-only format
+
+Used by older helpers (e.g. the `Code15*.csv` family) that match by filename across
+the vault rather than by full path.
+
+- One filename per line, with extension.
+- No directory component.
+
+See `sample_filenames.csv`.