Skip to content

Commit

Permalink
docs: Mention Homebrew install
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Mar 28, 2024
1 parent 59fbd6d commit 7fa346f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 17 deletions.
8 changes: 1 addition & 7 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,15 @@ We seek contributions from developers and non-developers of all skill levels. We

Before making any changes or additions to csvkit, please be sure to read the rest of this document, especially the "Principles of development" section.

Getting Started
Getting started
===============

Set up your environment for development:

.. code-block:: bash
git clone git://github.com/wireservice/csvkit.git
cd csvkit
mkvirtualenv csvkit
pip install -e .[test]
python setup.py develop
Principles of development
=========================

Expand Down
8 changes: 4 additions & 4 deletions docs/tricks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,21 @@ Processes running in a crontab `will not have a tty allocated <https://github.co
# works fine
0 0 * * * /usr/bin/csvsql --query 'select max(time) from temp' -d ';' --tables temp < /my/csv/file.csv
.. _troubleshooting:

Troubleshooting
===============

Installation
------------

csvkit is supported on non-end-of-life versions of Python.

It is tested on macOS, and has also been used on Linux and Windows.
csvkit is supported on non-end-of-life versions of Python on Linux, macOS and Windows.

If installing on macOS, you may need to install Homebrew first:

.. code-block:: bash
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install python
pip install csvkit
Expand Down
16 changes: 10 additions & 6 deletions docs/tutorial/1_getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,27 @@ This tutorial assumes you have some basic familiarity with the command line. If
Installing csvkit
=================

Installing csvkit is easy:
.. note::

It's best to install csvkit in a `virtual environment <https://docs.python.org/3/library/venv.html>`_.

.. code-block:: bash
sudo pip install csvkit
pip install csvkit
If you have problems installing, look for help in the :doc:`../tricks` section of the documentation.
Not working? Check :ref:`troubleshooting`.

If you need to work with `Zstandard <https://facebook.github.io/zstd/>`_ files with the ``.zst`` extension, install Zstandard support:

.. code-block:: bash
sudo pip install csvkit[zstandard]
pip install csvkit[zstandard]
.. note::
Do you use Homebrew? You can `install csvkit system-wide <https://formulae.brew.sh/formula/csvkit>`_ with:

.. code-block:: bash
If you're familiar with `virtualenv <https://virtualenv.readthedocs.org/en/latest/>`_, it is better to install csvkit in its own environment. If you are doing this, then you should leave off the ``sudo`` in the previous command.
brew install csvkit
Getting the data
================
Expand Down

0 comments on commit 7fa346f

Please sign in to comment.