Skip to content

Guides

Step-by-step documentation for every major feature. Start with Getting started if you are new to csvdir.

Core workflows

Guide Topics
Iteration read_dir, CsvDir, with_names, with_paths, file order
Headers Set vs sequence headers (read_dir vs CsvDirFile), strict_headers, expected_headers, on_mismatch
Chunking chunksize ≥ 1, read_dir_chunks, column chunks
Columns iter_column, select_columns, labels

Files and formats

Guide Topics
Discovery recurse, extension, hidden files
Encodings BOM, sniffing, mixed encodings per file
Pandas CsvDirFile, read_csv, streaming

Reference

Page Topics
Configuration Full parameter tables
API reference Autodoc for all public symbols