csvjson(1)

manual page for csvjson 1.0.7

Section 1 csvkit bookworm source

Description

CSVJSON

NAME

csvjson - manual page for csvjson 1.0.7

DESCRIPTION

usage: csvjson [-h] [-d DELIMITER] [-t] [-q QUOTECHAR] [-u {0,1,2,3}] [-b]

[-p ESCAPECHAR] [-z FIELD_SIZE_LIMIT] [-e ENCODING] [-L LOCALE] [-S] [--blanks] [--date-format DATE_FORMAT] [--datetime-format DATETIME_FORMAT] [-H] [-K SKIP_LINES] [-v] [-l] [--zero] [-V] [-i INDENT] [-k KEY] [--lat LAT] [--lon LON] [--type TYPE] [--geometry GEOMETRY] [--crs CRS] [--no-bbox] [--stream] [-y SNIFF_LIMIT] [-I] [FILE]

Convert a CSV file into JSON (or GeoJSON).

positional arguments:

FILE

The CSV file to operate on. If omitted, will accept input as piped data via STDIN.

optional arguments:

-h, --help

show this help message and exit

-d DELIMITER, --delimiter DELIMITER

Delimiting character of the input CSV file.

-t, --tabs

Specify that the input CSV file is delimited with tabs. Overrides "-d".

-q QUOTECHAR, --quotechar QUOTECHAR

Character used to quote strings in the input CSV file.

-u {0,1,2,3}, --quoting {0,1,2,3}

Quoting style used in the input CSV file. 0 = Quote Minimal, 1 = Quote All, 2 = Quote Non-numeric, 3 = Quote None.

-b, --no-doublequote

Whether or not double quotes are doubled in the input CSV file.

-p ESCAPECHAR, --escapechar ESCAPECHAR

Character used to escape the delimiter if --quoting 3 ("Quote None") is specified and to escape the QUOTECHAR if --no-doublequote is specified.

-z FIELD_SIZE_LIMIT, --maxfieldsize FIELD_SIZE_LIMIT

Maximum length of a single field in the input CSV file.

-e ENCODING, --encoding ENCODING

Specify the encoding of the input CSV file.

-L LOCALE, --locale LOCALE

Specify the locale (en_US) of any formatted numbers.

-S, --skipinitialspace

Ignore whitespace immediately following the delimiter.

--blanks

Do not convert "", "na", "n/a", "none", "null", "." to NULL.

--date-format DATE_FORMAT

Specify a strptime date format string like "%m/%d/%Y".

--datetime-format DATETIME_FORMAT

Specify a strptime datetime format string like "%m/%d/%Y %I:%M %p".

-H, --no-header-row

Specify that the input CSV file has no header row. Will create default headers (a,b,c,...).

-K SKIP_LINES, --skip-lines SKIP_LINES

Specify the number of initial lines to skip before the header row (e.g. comments, copyright notices, empty rows).

-v, --verbose

Print detailed tracebacks when errors occur.

-l, --linenumbers

Insert a column of line numbers at the front of the output. Useful when piping to grep or as a simple primary key.

--zero

When interpreting or displaying column numbers, use zero-based numbering instead of the default 1-based numbering.

-V, --version

Display version information and exit.

-i INDENT, --indent INDENT

Indent the output JSON this many spaces. Disabled by default.

-k KEY, --key KEY

Output JSON as an object keyed by a given column, KEY, rather than as an array. All column values must be unique. If --lat and --lon are specified, this column is used as the GeoJSON Feature ID.

--lat LAT

A column index or name containing a latitude. Output will be GeoJSON instead of JSON. Requires --lon.

--lon LON

A column index or name containing a longitude. Output will be GeoJSON instead of JSON. Requires --lat.

--type TYPE

A column index or name containing a GeoJSON type. Output will be GeoJSON instead of JSON. Requires --lat and --lon.

--geometry GEOMETRY

A column index or name containing a GeoJSON geometry. Output will be GeoJSON instead of JSON. Requires --lat and --lon.

--crs CRS

A coordinate reference system string to be included with GeoJSON output. Requires --lat and --lon.

--no-bbox

Disable the calculation of a bounding box.

--stream

Output JSON as a stream of newline-separated objects, rather than an as an array.

-y SNIFF_LIMIT, --snifflimit SNIFF_LIMIT

Limit CSV dialect sniffing to the specified number of bytes. Specify "0" to disable sniffing entirely, or "-1" to sniff the entire file.

-I, --no-inference

Disable type inference (and --locale, --date-format, --datetime-format) when parsing CSV input.

SEE ALSO

The full documentation for csvjson is maintained as a Texinfo manual. If the info and csvjson programs are properly installed at your site, the command

info csvjson

should give you access to the complete manual.