Skip to content

Environment variable documentation mismatch: CSV_EDITOR_ vs DATABEAK_ prefixes #3

@jonpspri

Description

@jonpspri

Problem

The README.md documents environment variables with the CSV_EDITOR_ prefix, but the actual codebase uses DATABEAK_ prefixes, causing configuration to fail.

Inconsistent Section

README.md lines 287-294 documents:

| Variable | Default | Description |
|----------|---------|-------------|
| `CSV_EDITOR_MAX_FILE_SIZE_MB` | 1024 | Maximum file size in MB |
| `CSV_EDITOR_CSV_HISTORY_DIR` | "." | History directory path |
| `CSV_EDITOR_SESSION_TIMEOUT` | 3600 | Session timeout in seconds |
| `CSV_EDITOR_CHUNK_SIZE` | 10000 | Processing chunk size |
| `CSV_EDITOR_AUTO_SAVE` | true | Enable auto-save |

README.md lines 62-64 shows example with old prefixes:

"env": {
  "CSV_EDITOR_MAX_FILE_SIZE_MB": "1024",
  "CSV_EDITOR_CSV_HISTORY_DIR": "/tmp/csv_history"
}

Authoritative Section

src/databeak/models/csv_session.py line 232:

model_config = {"env_prefix": "DATABEAK_", "case_sensitive": False}

This means the actual environment variables are:

  • DATABEAK_MAX_FILE_SIZE_MB
  • DATABEAK_CSV_HISTORY_DIR
  • DATABEAK_SESSION_TIMEOUT
  • DATABEAK_CHUNK_SIZE
  • DATABEAK_AUTO_SAVE

Why This Should Be Corrected

  1. Configuration Failure: Users following README instructions will have their environment variables ignored
  2. Brand Consistency: The project has been renamed from csv-editor to DataBeak
  3. Support Issues: Users will report "configuration not working" when following documented examples
  4. Installation Problems: MCP server configurations in README will not apply settings correctly

Recommended Action

Update all environment variable references in README.md to use DATABEAK_ prefix instead of CSV_EDITOR_ prefix.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions