1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CSVPY" "1" "Aug 16, 2024" "2.2.0" "csvkit"
.SH NAME
csvpy \- csvpy Documentation
.SH DESCRIPTION
.sp
Loads a CSV file into a \fBagate.csv.Reader\fP object and then drops into a Python shell so the user can inspect the data however they see fit:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: csvpy [\-h] [\-d DELIMITER] [\-t] [\-q QUOTECHAR] [\-u {0,1,2,3}] [\-b]
[\-p ESCAPECHAR] [\-z FIELD_SIZE_LIMIT] [\-e ENCODING] [\-L LOCALE]
[\-S] [\-\-blanks] [\-\-null\-value NULL_VALUES [NULL_VALUES ...]]
[\-\-date\-format DATE_FORMAT] [\-\-datetime\-format DATETIME_FORMAT]
[\-H] [\-K SKIP_LINES] [\-v] [\-l] [\-\-zero] [\-V] [\-\-dict] [\-\-agate]
[\-\-no\-number\-ellipsis] [\-y SNIFF_LIMIT] [\-I]
[FILE]
Load a CSV file into a CSV reader and then drop into a Python shell.
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
\-\-dict Load the CSV file into a DictReader.
\-\-agate Load the CSV file into an agate table.
\-\-no\-number\-ellipsis Disable the ellipsis if the max precision is exceeded.
\-y SNIFF_LIMIT, \-\-snifflimit SNIFF_LIMIT
Limit CSV dialect sniffing to the specified number of
bytes. Specify \(dq0\(dq to disable sniffing entirely, or
\(dq\-1\(dq to sniff the entire file.
\-I, \-\-no\-inference Disable type inference (and \-\-locale, \-\-date\-format,
\-\-datetime\-format, \-\-no\-leading\-zeroes) when parsing
the input.
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This tool will automatically use the IPython shell if it is installed, otherwise it will use the running Python shell.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Due to platform limitations, csvpy does not accept file input as piped data via STDIN.
.UNINDENT
.UNINDENT
.sp
See also: \fI\%Arguments common to all tools\fP\&.
.SH EXAMPLES
.sp
Basic use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B $ csvpy examples/dummy.csv
Welcome! \(dqexamples/dummy.csv\(dq has been loaded in a reader object named \(dqreader\(dq.
>>> next(reader)
[\(aqa\(aq, \(aqb\(aq, \(aqc\(aq]
.UNINDENT
.sp
As a dictionary:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ csvpy \-\-dict examples/dummy.csv
Welcome! \(dqexamples/dummy.csv\(dq has been loaded in a DictReader object named \(dqreader\(dq.
>>> next(reader)
{\(aqa\(aq: \(aq1\(aq, \(aqc\(aq: \(aq3\(aq, \(aqb\(aq: \(aq2\(aq}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As an agate table:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ csvpy \-\-agate examples/dummy.csv
Welcome! \(dqexamples/dummy.csv\(dq has been loaded in a from_csv object named \(dqreader\(dq.
>>> reader.print_table()
| a | b | c |
| \-\-\-\- | \- | \- |
| True | 2 | 3 |
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Christopher Groskopf and contributors
.SH COPYRIGHT
2016, Christopher Groskopf and James McKinney
.\" Generated by docutils manpage writer.
.
|
