mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-09-11 11:04:10 +02:00
Added installation instructions, closes #286
This commit is contained in:
parent
933be66eba
commit
dbcba6c597
2 changed files with 41 additions and 0 deletions
|
|
@ -29,6 +29,7 @@ Contents
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
|
installation
|
||||||
cli
|
cli
|
||||||
python-api
|
python-api
|
||||||
changelog
|
changelog
|
||||||
|
|
|
||||||
40
docs/installation.rst
Normal file
40
docs/installation.rst
Normal file
|
|
@ -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 <cli>` 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 <https://pypi.org/project/sqlite-utils/>`__ on PyPI includes both the :ref:`sqlite_utils Python library <python_api>` and the ``sqlite-utils`` command-line tool. You can install them using ``pip`` like so::
|
||||||
|
|
||||||
|
pip install sqlite-utils
|
||||||
|
|
||||||
|
.. _installation_pipx:
|
||||||
|
|
||||||
|
Using pipx
|
||||||
|
==========
|
||||||
|
|
||||||
|
`pipx <https://pypi.org/project/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
|
||||||
Loading…
Add table
Add a link
Reference in a new issue