demodataset

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2026 License: MIT Imports: 1 Imported by: 0

README

Demo dataset (public “golden” fixture)

Reminder: Update docs/index.md if you add, rename, or remove documents.

Purpose

  • This folder contains a synthetic/anonymized dataset that is safe to ship publicly.
  • It serves as a single canonical fixture for:
    • Go unit tests (TDD)
    • the hosted static dashboard “demo mode”

Safety + anonymization checklist

  • Owners: synthetic labels (OWNER A, OWNER B), not real names.
  • Merchants / Detail: synthetic merchant strings (SUPERMARKET DEMO, etc.).
  • Card numbers: fake and obviously not real (0000, 1111, 2222).
  • No sensitive identifiers: no addresses, emails, phone numbers, account numbers.

Files

  • extracted.csv
    • Semicolon-separated (;) to match the CLI output.
    • Header must match the extracted CSV schema exactly.
      • Do not hardcode the full header in this README; it is enforced by Go tests.
  • mappings.v1.json
    • Minimal exact-match mappings used by the dashboard.

What this dataset should cover (intentionally, but not rigidly)

  • Multiple statement months (at least 2 different CloseDate months).
  • Installments (at least one CardMovement with CurrentInstallment/TotalInstallments set).
  • Refund pairs:
    • one matching positive/negative pair across different months, and
    • one matching positive/negative pair within the same month.
  • Mapping gaps (to feed DQ):
    • at least one unmapped category, and
    • at least one unmapped owner.

Note: Parse-invalid fixtures (bad date formats, invalid MovementType strings, etc.) should live as additional files in this folder (e.g. extracted.invalid_*.csv) so the main demo dataset stays usable for the hosted demo.

Planned simple additions (keep each addition small and purposeful)

  • USD examples (at least one CardMovement with AmountUSD != 0).
  • More banks/card companies (additional CardCompany / Bank combinations).
  • Optional-field edge cases (missing receipt/date, blank card fields on non-card movements).
  • Whitespace quirks in Detail to make normalization value visible.
  • A “clean” month with zero DQ issues so the demo looks good.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ExtractedCSV is a synthetic/anonymized extracted CSV fixture.
	//
	//go:embed extracted.csv
	ExtractedCSV string

	// MappingsV1JSON is a minimal mappings fixture consumed by the dashboard.
	//
	//go:embed mappings.v1.json
	MappingsV1JSON string
)

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL