Skip to content

Commit 781f34f

Browse files
author
James McKinney
committed
Add frequently asked questions / issues to top of readme
1 parent 6802d6f commit 781f34f

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,21 @@ csvkit is a suite of command-line tools for converting to and working with CSV,
2626

2727
It is inspired by pdftk, GDAL and the original csvcut tool by Joe Germuska and Aaron Bycoffe.
2828

29-
If you need to do more complex data analysis than csvkit can handle, use `agate <https://github.com/wireservice/agate>`_.
29+
.. note::
30+
31+
If you need to do more complex data analysis than csvkit can handle, use `agate <https://github.com/wireservice/agate>`_.
32+
33+
.. note::
34+
35+
Remember that to change the field separator, line terminator, etc. of the **output**, you must use :doc:`/scripts/csvformat`.
36+
37+
.. note::
38+
39+
csvkit, by default, `sniffs <https://docs.python.org/3.5/library/csv.html#csv.Sniffer>`_ CSV formats (it deduces whether commas, tabs or spaces delimit fields, for example), and performs type inference (it converts text to numbers, dates, booleans, etc.). These features are useful and work well in most cases, but occasional errors occur. If you don't need these features, set :code:`--snifflimit 0` (:code:`-y 0`) and :code:`--no-inference` (:code:`-I`).
40+
41+
.. note::
42+
43+
If you need csvkit to be faster or to handle larger files, you may be reaching the limits of csvkit.
3044

3145
Important links:
3246

docs/tricks.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ csvkit is supported on:
5252

5353
It is tested on macOS, and has also been used on Linux and Windows.
5454

55+
If installing on macOS, you may need to install Homebrew first::
56+
57+
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
58+
brew install python
59+
pip install csvkit
60+
5561
If installing on Ubuntu, you may need to install Python's development headers first::
5662

5763
sudo apt-get install python-dev python-pip python-setuptools build-essential
@@ -101,7 +107,7 @@ For some data, type inference can be error prone. If necessary you can disable i
101107
Slow performance
102108
----------------
103109

104-
csvkit's tools fall into two categories: Those that load an entire CSV into memory (e.g. :doc:`/scripts/csvstat`) and those that only read data one row at a time (e.g. :doc:`/scripts/csvcut`). Those that stream results will generally be very fast. For those that buffer the entire file, the slowest part of that process is typically the "type inference" described in the previous section.
110+
csvkit's tools fall into two categories: Those that load an entire CSV into memory (e.g. :doc:`/scripts/csvstat`) and those that only read data one row at a time (e.g. :doc:`/scripts/csvcut`). Those that stream results will generally be very fast. See :doc:`contributing` for a full list. For those that buffer the entire file, the slowest part of that process is typically the "type inference" described in the previous section.
105111

106112
If a tool is too slow to be practical for your data try setting the :code:`--snifflimit` option or using the :code:`--no-inference`.
107113

0 commit comments

Comments
 (0)