From 7fa346fbb77aa9ddd07bcac34d599c94212e57f5 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Thu, 28 Mar 2024 11:24:25 -0400 Subject: [PATCH] docs: Mention Homebrew install --- docs/contributing.rst | 8 +------- docs/tricks.rst | 8 ++++---- docs/tutorial/1_getting_started.rst | 16 ++++++++++------ 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index f3419e4cb..b16825ff9 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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 ========================= diff --git a/docs/tricks.rst b/docs/tricks.rst index 4e0c42b02..c198227b1 100644 --- a/docs/tricks.rst +++ b/docs/tricks.rst @@ -54,21 +54,21 @@ Processes running in a crontab `will not have a tty allocated `_. .. 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 `_ 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 `_ with: + +.. code-block:: bash - If you're familiar with `virtualenv `_, 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 ================