diff --git a/docs/index.rst b/docs/index.rst index 571020f..b1bfc0e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ Contents .. toctree:: :maxdepth: 3 + installation cli python-api changelog diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..099dd16 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,40 @@ +.. _installation: + +============== + Installation +============== + +``sqlite-utils`` is tested on Linux, macOS and Windows. + +.. _installation_homebrew: + +Using Homebrew +============== + +The :ref:`sqlite-utils commad-line tool ` can be installed on macOS using Homebrew:: + + brew install sqlite-utils + +If you have it installed and want to upgrade to the most recent release, you ran run:: + + brew upgrade sqlite-utils + +Then run ``sqlite-utils --version`` to confirm the installed version. + +.. _installation_pip: + +Using pip +========= + +The `sqlite-utils package `__ on PyPI includes both the :ref:`sqlite_utils Python library ` and the ``sqlite-utils`` command-line tool. You can install them using ``pip`` like so:: + + pip install sqlite-utils + +.. _installation_pipx: + +Using pipx +========== + +`pipx `__ is a tool for installing Python command-line applications in their own isolated environments. You can use ``pipx`` to install the ``sqlite-utils`` command-line tool like this:: + + pipx install sqlite-utils