Skip to content

Commit

Permalink
installation doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jake authored and jake committed Dec 27, 2023
1 parent d59083b commit 3f75dfa
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can install this module via pip:

.. code:: bash
$ pip install internetarchive
$ python3 -m pip install internetarchive
Binaries of the command-line tool are also available:

Expand Down
23 changes: 22 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,35 @@ System-Wide Installation
-------------------------

Installing the ``internetarchive`` library globally on your system can be done with `pip <http://www.pip-installer.org/>`_.
This is the recommended method for installing ``internetarchive`` (`see below <installation.html#installing-pip>`_ for details on installing pip)::
This is the recommended method for installing ``internetarchive`` (`see below <installation.html#installing-pip>`_ for details on installing pip).
If you are on Mac OS X, refer to the `Mac OS X section <installation.html#mac-os-x>`_ below before proceeding.
Once you're ready to install, run the following command::

$ sudo python3 -m pip install internetarchive

Updating Your $PATH
~~~~~~~~~~~~~~~~~~~

Once you have successfully installed ``internetarchive``, you may need to update your ``$PATH`` (e.g. if running ``ia`` in your terminal returns an error).
If you receive a command not found error, run the following command to update your ``$PATH``::

$ echo "$(python3 -m site --user-base)/bin" | sudo tee -a /etc/paths

Updating ia
~~~~~~~~~~~

To update, you can run the following command::

$ sudo python3 -m pip install --upgrade internetarchive

Mac OS X
~~~~~~~~

While newer versions Mac OS X ship with Python 3 installed, it is recommended to install an updated version of Python 3.
You can do so with `Homebrew <https://brew.sh/#install>`_::

$ brew install python3

Installing Pip
~~~~~~~~~~~~~~

Expand Down

0 comments on commit 3f75dfa

Please sign in to comment.