sqlite-utils 4.0a1__tar.gz → 4.0rc1__tar.gz

{sqlite_utils-4.0a1/sqlite_utils.egg-info → sqlite_utils-4.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlite-utils
-Version: 4.0a1
+Version: 4.0rc1
 Summary: CLI tool and Python library for manipulating SQLite databases
 Author: Simon Willison
 License-Expression: Apache-2.0
@@ -22,34 +22,13 @@ Classifier: Topic :: Database
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click
+Requires-Dist: click>=8.3.1
 Requires-Dist: click-default-group>=1.2.3
 Requires-Dist: pluggy
 Requires-Dist: python-dateutil
 Requires-Dist: sqlite-fts4
 Requires-Dist: tabulate
-Provides-Extra: test
-Requires-Dist: black>=24.1.1; extra == "test"
-Requires-Dist: cogapp; extra == "test"
-Requires-Dist: hypothesis; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Provides-Extra: docs
-Requires-Dist: beanbag-docutils>=2.0; extra == "docs"
-Requires-Dist: codespell; extra == "docs"
-Requires-Dist: furo; extra == "docs"
-Requires-Dist: pygments-csv-lexer; extra == "docs"
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinx-copybutton; extra == "docs"
-Provides-Extra: mypy
-Requires-Dist: data-science-types; extra == "mypy"
-Requires-Dist: mypy; extra == "mypy"
-Requires-Dist: types-click; extra == "mypy"
-Requires-Dist: types-pluggy; extra == "mypy"
-Requires-Dist: types-python-dateutil; extra == "mypy"
-Requires-Dist: types-tabulate; extra == "mypy"
-Provides-Extra: flake8
-Requires-Dist: flake8; extra == "flake8"
-Requires-Dist: flake8-pyproject; extra == "flake8"
+Requires-Dist: pip
 Dynamic: license-file
 
 # sqlite-utils

{sqlite_utils-4.0a1 → sqlite_utils-4.0rc1}/docs/changelog.rst

@@ -4,6 +4,32 @@
  Changelog
 ===========
 
+.. _v4_0rc1:
+
+4.0rc1 (2026-06-21)
+-------------------
+
+- New :ref:`database migrations system <migrations>`, incorporating functionality that was previously provided by the separate `sqlite-migrate <https://github.com/simonw/sqlite-migrate>`__ plugin. Define migration sets using the new :class:`sqlite_utils.Migrations` class and apply them using the ``sqlite-utils migrate`` command or the :ref:`migrations Python API <migrations_python>`. (:issue:`752`)
+- New ``db.atomic()`` :ref:`context manager providing nested transaction support <python_api_atomic>` using SQLite transactions and savepoints. Internal multi-step operations such as ``table.transform()`` now use this mechanism to avoid unexpectedly committing an existing transaction. (:issue:`755`)
+- ``Database`` objects can now be :ref:`used as context managers <python_api_close>`, automatically closing the connection when the ``with`` block exits. The CLI also now closes database and file handles more reliably, resolving a number of ``ResourceWarning`` warnings. (:issue:`692`)
+- The ``sqlite-utils convert`` command can now accept a direct callable reference such as ``r.parsedate`` or ``json.loads --import json`` as the conversion code, as an alternative to calling it explicitly with ``r.parsedate(value)``. (:issue:`686`)
+- Fixed a bug where CSV or TSV files with only a header row could crash ``sqlite-utils insert`` and ``sqlite-utils memory`` when type detection was enabled. Thanks, `Rami Abdelrazzaq <https://github.com/RamiNoodle733>`__. (:issue:`702`, `#707 <https://github.com/simonw/sqlite-utils/pull/707>`__)
+- Fixed a bug where installed plugins could be loaded while running the test suite, despite the test-mode safeguard that disables plugin loading. Thanks, `Rami Abdelrazzaq <https://github.com/RamiNoodle733>`__. (:issue:`713`, `#719 <https://github.com/simonw/sqlite-utils/pull/719>`__)
+- ``table.detect_fts()`` now recognizes legacy FTS virtual tables that quote the ``content=`` table name using square brackets, allowing ``table.enable_fts(..., replace=True)`` to replace them correctly. (:issue:`694`)
+- Now depends on Click 8.3.1 or later, removing compatibility workarounds for Click's ``Sentinel`` default values. (:issue:`666`)
+- Improved type annotations throughout the package, with ``ty`` now run in CI. (:issue:`697`)
+- Development tooling now uses ``uv`` dependency groups, with separate ``dev`` and ``docs`` groups. (:issue:`691`)
+- The test suite now runs against Python 3.15-dev. (:issue:`738`)
+
+.. _v3_39:
+
+3.39 (2025-11-24)
+-----------------
+
+- Fixed a bug with ``sqlite-utils install`` when the tool had been installed using ``uv``. (:issue:`687`)
+- The ``--functions`` argument now optionally accepts a path to a Python file as an alternative to a string full of code, and can be specified multiple times - see :ref:`cli_query_functions`. (:issue:`659`)
+- ``sqlite-utils`` now requires Python 3.10 or higher.
+
 .. _v4_0a1:
 
 4.0a1 (2025-11-23)
@@ -173,7 +199,7 @@ This release introduces a new :ref:`plugin system <plugins>`. Read more about th
 - Conversion functions passed to :ref:`table.convert(...) <python_api_convert>` can now return lists or dictionaries, which will be inserted into the database as JSON strings. (:issue:`495`)
 - ``sqlite-utils install`` and ``sqlite-utils uninstall`` commands for installing packages into the same virtual environment as ``sqlite-utils``, :ref:`described here <cli_install>`. (:issue:`483`)
 - New :ref:`sqlite_utils.utils.flatten() <reference_utils_flatten>` utility function. (:issue:`500`)
-- Documentation on :ref:`using Just <contributing_just>` to run tests, linters and build documentation. 
+- Documentation on :ref:`using Just <contributing_just>` to run tests, linters and build documentation.
 - Documentation now covers the :ref:`release_process` for this package.
 
 .. _v3_29:

{sqlite_utils-4.0a1 → sqlite_utils-4.0rc1}/docs/cli-reference.rst

@@ -20,7 +20,7 @@ This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
         "query", "memory", "insert", "upsert", "bulk", "search", "transform", "extract",
         "schema", "insert-files", "analyze-tables", "convert", "tables", "views", "rows",
         "triggers", "indexes", "create-database", "create-table", "create-index",
-        "enable-fts", "populate-fts", "rebuild-fts", "disable-fts"
+        "migrate", "enable-fts", "populate-fts", "rebuild-fts", "disable-fts"
     ]
     refs = {
         "query": "cli_query",
@@ -49,6 +49,7 @@ This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
         "enable-wal": "cli_wal",
         "enable-counts": "cli_enable_counts",
         "bulk": "cli_bulk",
+        "migrate": "cli_migrate",
         "create-database": "cli_create_database",
         "create-table": "cli_create_table",
         "drop-table": "cli_drop_table",
@@ -117,15 +118,15 @@ See :ref:`cli_query`.
       --tsv                       Output TSV
       --no-headers                Omit CSV headers
       -t, --table                 Output as a formatted table
-      --fmt TEXT                  Table format - one of asciidoc, double_grid,
-                                  double_outline, fancy_grid, fancy_outline, github,
-                                  grid, heavy_grid, heavy_outline, html, jira,
-                                  latex, latex_booktabs, latex_longtable, latex_raw,
-                                  mediawiki, mixed_grid, mixed_outline, moinmoin,
-                                  orgtbl, outline, pipe, plain, presto, pretty,
-                                  psql, rounded_grid, rounded_outline, rst, simple,
-                                  simple_grid, simple_outline, textile, tsv,
-                                  unsafehtml, youtrack
+      --fmt TEXT                  Table format - one of asciidoc, colon_grid,
+                                  double_grid, double_outline, fancy_grid,
+                                  fancy_outline, github, grid, heavy_grid,
+                                  heavy_outline, html, jira, latex, latex_booktabs,
+                                  latex_longtable, latex_raw, mediawiki, mixed_grid,
+                                  mixed_outline, moinmoin, orgtbl, outline, pipe,
+                                  plain, presto, pretty, psql, rounded_grid,
+                                  rounded_outline, rst, simple, simple_grid,
+                                  simple_outline, textile, tsv, unsafehtml, youtrack
       --json-cols                 Detect JSON cols and output them as JSON, not
                                   escaped strings
       -r, --raw                   Raw output, first column of first row
@@ -186,15 +187,15 @@ See :ref:`cli_memory`.
       --tsv                       Output TSV
       --no-headers                Omit CSV headers
       -t, --table                 Output as a formatted table
-      --fmt TEXT                  Table format - one of asciidoc, double_grid,
-                                  double_outline, fancy_grid, fancy_outline, github,
-                                  grid, heavy_grid, heavy_outline, html, jira,
-                                  latex, latex_booktabs, latex_longtable, latex_raw,
-                                  mediawiki, mixed_grid, mixed_outline, moinmoin,
-                                  orgtbl, outline, pipe, plain, presto, pretty,
-                                  psql, rounded_grid, rounded_outline, rst, simple,
-                                  simple_grid, simple_outline, textile, tsv,
-                                  unsafehtml, youtrack
+      --fmt TEXT                  Table format - one of asciidoc, colon_grid,
+                                  double_grid, double_outline, fancy_grid,
+                                  fancy_outline, github, grid, heavy_grid,
+                                  heavy_outline, html, jira, latex, latex_booktabs,
+                                  latex_longtable, latex_raw, mediawiki, mixed_grid,
+                                  mixed_outline, moinmoin, orgtbl, outline, pipe,
+                                  plain, presto, pretty, psql, rounded_grid,
+                                  rounded_outline, rst, simple, simple_grid,
+                                  simple_outline, textile, tsv, unsafehtml, youtrack
       --json-cols                 Detect JSON cols and output them as JSON, not
                                   escaped strings
       -r, --raw                   Raw output, first column of first row
@@ -425,14 +426,15 @@ See :ref:`cli_search`.
       --tsv                  Output TSV
       --no-headers           Omit CSV headers
       -t, --table            Output as a formatted table
-      --fmt TEXT             Table format - one of asciidoc, double_grid,
-                             double_outline, fancy_grid, fancy_outline, github,
-                             grid, heavy_grid, heavy_outline, html, jira, latex,
-                             latex_booktabs, latex_longtable, latex_raw, mediawiki,
-                             mixed_grid, mixed_outline, moinmoin, orgtbl, outline,
-                             pipe, plain, presto, pretty, psql, rounded_grid,
-                             rounded_outline, rst, simple, simple_grid,
-                             simple_outline, textile, tsv, unsafehtml, youtrack
+      --fmt TEXT             Table format - one of asciidoc, colon_grid,
+                             double_grid, double_outline, fancy_grid, fancy_outline,
+                             github, grid, heavy_grid, heavy_outline, html, jira,
+                             latex, latex_booktabs, latex_longtable, latex_raw,
+                             mediawiki, mixed_grid, mixed_outline, moinmoin, orgtbl,
+                             outline, pipe, plain, presto, pretty, psql,
+                             rounded_grid, rounded_outline, rst, simple,
+                             simple_grid, simple_outline, textile, tsv, unsafehtml,
+                             youtrack
       --json-cols            Detect JSON cols and output them as JSON, not escaped
                              strings
       --load-extension TEXT  Path to SQLite extension, with optional :entrypoint
@@ -615,11 +617,13 @@ See :ref:`cli_convert`.
 
       The following common operations are available as recipe functions:
 
-      r.jsonsplit(value, delimiter=',', type=<class 'str'>)
+      r.jsonsplit(value: 'str', delimiter: 'str' = ',', type: 'Callable[[str],
+      object]' = <class 'str'>) -> 'str'
 
       Convert a string like a,b,c into a JSON array ["a", "b", "c"]
 
-      r.parsedate(value, dayfirst=False, yearfirst=False, errors=None)
+      r.parsedate(value: 'str', dayfirst: 'bool' = False, yearfirst: 'bool' = False,
+      errors: 'Optional[object]' = None) -> 'Optional[str]'
 
       Parse a date and convert it to ISO date format: yyyy-mm-dd
   
@@ -628,7 +632,8 @@ See :ref:`cli_convert`.
       - errors=r.IGNORE to ignore values that cannot be parsed
       - errors=r.SET_NULL to set values that cannot be parsed to null
 
-      r.parsedatetime(value, dayfirst=False, yearfirst=False, errors=None)
+      r.parsedatetime(value: 'str', dayfirst: 'bool' = False, yearfirst: 'bool' =
+      False, errors: 'Optional[object]' = None) -> 'Optional[str]'
 
       Parse a datetime and convert it to ISO datetime format: yyyy-mm-ddTHH:MM:SS
   
@@ -687,14 +692,15 @@ See :ref:`cli_tables`.
       --tsv                  Output TSV
       --no-headers           Omit CSV headers
       -t, --table            Output as a formatted table
-      --fmt TEXT             Table format - one of asciidoc, double_grid,
-                             double_outline, fancy_grid, fancy_outline, github,
-                             grid, heavy_grid, heavy_outline, html, jira, latex,
-                             latex_booktabs, latex_longtable, latex_raw, mediawiki,
-                             mixed_grid, mixed_outline, moinmoin, orgtbl, outline,
-                             pipe, plain, presto, pretty, psql, rounded_grid,
-                             rounded_outline, rst, simple, simple_grid,
-                             simple_outline, textile, tsv, unsafehtml, youtrack
+      --fmt TEXT             Table format - one of asciidoc, colon_grid,
+                             double_grid, double_outline, fancy_grid, fancy_outline,
+                             github, grid, heavy_grid, heavy_outline, html, jira,
+                             latex, latex_booktabs, latex_longtable, latex_raw,
+                             mediawiki, mixed_grid, mixed_outline, moinmoin, orgtbl,
+                             outline, pipe, plain, presto, pretty, psql,
+                             rounded_grid, rounded_outline, rst, simple,
+                             simple_grid, simple_outline, textile, tsv, unsafehtml,
+                             youtrack
       --json-cols            Detect JSON cols and output them as JSON, not escaped
                              strings
       --columns              Include list of columns for each table
@@ -728,14 +734,15 @@ See :ref:`cli_views`.
       --tsv                  Output TSV
       --no-headers           Omit CSV headers
       -t, --table            Output as a formatted table
-      --fmt TEXT             Table format - one of asciidoc, double_grid,
-                             double_outline, fancy_grid, fancy_outline, github,
-                             grid, heavy_grid, heavy_outline, html, jira, latex,
-                             latex_booktabs, latex_longtable, latex_raw, mediawiki,
-                             mixed_grid, mixed_outline, moinmoin, orgtbl, outline,
-                             pipe, plain, presto, pretty, psql, rounded_grid,
-                             rounded_outline, rst, simple, simple_grid,
-                             simple_outline, textile, tsv, unsafehtml, youtrack
+      --fmt TEXT             Table format - one of asciidoc, colon_grid,
+                             double_grid, double_outline, fancy_grid, fancy_outline,
+                             github, grid, heavy_grid, heavy_outline, html, jira,
+                             latex, latex_booktabs, latex_longtable, latex_raw,
+                             mediawiki, mixed_grid, mixed_outline, moinmoin, orgtbl,
+                             outline, pipe, plain, presto, pretty, psql,
+                             rounded_grid, rounded_outline, rst, simple,
+                             simple_grid, simple_outline, textile, tsv, unsafehtml,
+                             youtrack
       --json-cols            Detect JSON cols and output them as JSON, not escaped
                              strings
       --columns              Include list of columns for each view
@@ -774,15 +781,15 @@ See :ref:`cli_rows`.
       --tsv                       Output TSV
       --no-headers                Omit CSV headers
       -t, --table                 Output as a formatted table
-      --fmt TEXT                  Table format - one of asciidoc, double_grid,
-                                  double_outline, fancy_grid, fancy_outline, github,
-                                  grid, heavy_grid, heavy_outline, html, jira,
-                                  latex, latex_booktabs, latex_longtable, latex_raw,
-                                  mediawiki, mixed_grid, mixed_outline, moinmoin,
-                                  orgtbl, outline, pipe, plain, presto, pretty,
-                                  psql, rounded_grid, rounded_outline, rst, simple,
-                                  simple_grid, simple_outline, textile, tsv,
-                                  unsafehtml, youtrack
+      --fmt TEXT                  Table format - one of asciidoc, colon_grid,
+                                  double_grid, double_outline, fancy_grid,
+                                  fancy_outline, github, grid, heavy_grid,
+                                  heavy_outline, html, jira, latex, latex_booktabs,
+                                  latex_longtable, latex_raw, mediawiki, mixed_grid,
+                                  mixed_outline, moinmoin, orgtbl, outline, pipe,
+                                  plain, presto, pretty, psql, rounded_grid,
+                                  rounded_outline, rst, simple, simple_grid,
+                                  simple_outline, textile, tsv, unsafehtml, youtrack
       --json-cols                 Detect JSON cols and output them as JSON, not
                                   escaped strings
       --load-extension TEXT       Path to SQLite extension, with optional
@@ -814,14 +821,15 @@ See :ref:`cli_triggers`.
       --tsv                  Output TSV
       --no-headers           Omit CSV headers
       -t, --table            Output as a formatted table
-      --fmt TEXT             Table format - one of asciidoc, double_grid,
-                             double_outline, fancy_grid, fancy_outline, github,
-                             grid, heavy_grid, heavy_outline, html, jira, latex,
-                             latex_booktabs, latex_longtable, latex_raw, mediawiki,
-                             mixed_grid, mixed_outline, moinmoin, orgtbl, outline,
-                             pipe, plain, presto, pretty, psql, rounded_grid,
-                             rounded_outline, rst, simple, simple_grid,
-                             simple_outline, textile, tsv, unsafehtml, youtrack
+      --fmt TEXT             Table format - one of asciidoc, colon_grid,
+                             double_grid, double_outline, fancy_grid, fancy_outline,
+                             github, grid, heavy_grid, heavy_outline, html, jira,
+                             latex, latex_booktabs, latex_longtable, latex_raw,
+                             mediawiki, mixed_grid, mixed_outline, moinmoin, orgtbl,
+                             outline, pipe, plain, presto, pretty, psql,
+                             rounded_grid, rounded_outline, rst, simple,
+                             simple_grid, simple_outline, textile, tsv, unsafehtml,
+                             youtrack
       --json-cols            Detect JSON cols and output them as JSON, not escaped
                              strings
       --load-extension TEXT  Path to SQLite extension, with optional :entrypoint
@@ -853,14 +861,15 @@ See :ref:`cli_indexes`.
       --tsv                  Output TSV
       --no-headers           Omit CSV headers
       -t, --table            Output as a formatted table
-      --fmt TEXT             Table format - one of asciidoc, double_grid,
-                             double_outline, fancy_grid, fancy_outline, github,
-                             grid, heavy_grid, heavy_outline, html, jira, latex,
-                             latex_booktabs, latex_longtable, latex_raw, mediawiki,
-                             mixed_grid, mixed_outline, moinmoin, orgtbl, outline,
-                             pipe, plain, presto, pretty, psql, rounded_grid,
-                             rounded_outline, rst, simple, simple_grid,
-                             simple_outline, textile, tsv, unsafehtml, youtrack
+      --fmt TEXT             Table format - one of asciidoc, colon_grid,
+                             double_grid, double_outline, fancy_grid, fancy_outline,
+                             github, grid, heavy_grid, heavy_outline, html, jira,
+                             latex, latex_booktabs, latex_longtable, latex_raw,
+                             mediawiki, mixed_grid, mixed_outline, moinmoin, orgtbl,
+                             outline, pipe, plain, presto, pretty, psql,
+                             rounded_grid, rounded_outline, rst, simple,
+                             simple_grid, simple_outline, textile, tsv, unsafehtml,
+                             youtrack
       --json-cols            Detect JSON cols and output them as JSON, not escaped
                              strings
       --load-extension TEXT  Path to SQLite extension, with optional :entrypoint
@@ -957,6 +966,44 @@ See :ref:`cli_create_index`.
       -h, --help                 Show this message and exit.
 
 
+.. _cli_ref_migrate:
+
+migrate
+=======
+
+See :ref:`cli_migrate`.
+
+::
+
+    Usage: sqlite-utils migrate [OPTIONS] DB_PATH [MIGRATIONS]...
+
+      Apply pending database migrations.
+
+      Usage:
+
+          sqlite-utils migrate database.db
+
+      This will find the migrations.py file in the current directory or
+      subdirectories and apply any pending migrations.
+
+      Or pass paths to one or more migrations.py files directly:
+
+          sqlite-utils migrate database.db path/to/migrations.py
+
+      Pass --list to see a list of applied and pending migrations without applying
+      them.
+
+      Use --stop-before migration_set:name to stop before a migration. This option
+      can be used multiple times.
+
+    Options:
+      --stop-before TEXT  Stop before applying this migration. Use set:name to
+                          target a migration set.
+      --list              List migrations without running them
+      -v, --verbose       Show verbose output
+      -h, --help          Show this message and exit.
+
+
 .. _cli_ref_enable_fts:
 
 enable-fts

{sqlite_utils-4.0a1 → sqlite_utils-4.0rc1}/docs/cli.rst

@@ -257,6 +257,7 @@ Available ``--fmt`` options are:
 .. ]]]
 
 - ``asciidoc``
+- ``colon_grid``
 - ``double_grid``
 - ``double_outline``
 - ``fancy_grid``
@@ -1057,6 +1058,37 @@ That will look for SpatiaLite in a set of predictable locations. To load it from
 
     sqlite-utils create-database empty.db --init-spatialite --load-extension /path/to/spatialite.so
 
+.. _cli_migrate:
+
+Running migrations
+==================
+
+The ``migrate`` command applies pending Python migrations to a database. For the full migration file format and Python API, see :ref:`migrations`.
+
+.. code-block:: bash
+
+    sqlite-utils migrate creatures.db path/to/migrations.py
+
+If you omit the migration path it will search the current directory and subdirectories for files called ``migrations.py``:
+
+.. code-block:: bash
+
+    sqlite-utils migrate creatures.db
+
+Use ``--list`` to list applied and pending migrations without running them:
+
+.. code-block:: bash
+
+    sqlite-utils migrate creatures.db --list
+
+Use ``--stop-before`` to stop before a named migration. The option can be passed more than once, and can target a specific migration set using ``migration_set:migration_name``:
+
+.. code-block:: bash
+
+    sqlite-utils migrate creatures.db path/to/migrations.py \
+      --stop-before creatures:add_weight \
+      --stop-before sales:drop_index
+
 .. _cli_inserting_data:
 
 Inserting JSON data
@@ -1849,7 +1881,19 @@ These recipes can be used in the code passed to ``sqlite-utils convert`` like th
     sqlite-utils convert my.db mytable mycolumn \
       'r.jsonsplit(value)'
 
-To use any of the documented parameters, do this:
+You can also pass the recipe function directly without the ``(value)`` part - sqlite-utils will detect that it is a callable and use it automatically:
+
+.. code-block:: bash
+
+    sqlite-utils convert my.db mytable mycolumn r.parsedate
+
+This shorter syntax works for any callable, including functions from imported modules:
+
+.. code-block:: bash
+
+    sqlite-utils convert my.db mytable mycolumn json.loads --import json
+
+To use any of the documented parameters, use the full function call syntax:
 
 .. code-block:: bash
 

{sqlite_utils-4.0a1 → sqlite_utils-4.0rc1}/docs/contributing.rst

@@ -13,78 +13,61 @@ All improvements to the software should start with an issue. Read `How I build a
 Obtaining the code
 ==================
 
-To work on this library locally, first checkout the code. Then create a new virtual environment::
+To work on this library locally, first checkout the code::
 
     git clone git@github.com:simonw/sqlite-utils
     cd sqlite-utils
-    python3 -mvenv venv
-    source venv/bin/activate
 
-Or if you are using ``pipenv``::
+Use ``uv run`` to run the development version of the tool::
 
-    pipenv shell
-
-Within the virtual environment running ``sqlite-utils`` should run your locally editable version of the tool. You can use ``which sqlite-utils`` to confirm that you are running the version that lives in your virtual environment.
+    uv run sqlite-utils --help
 
 .. _contributing_tests:
 
 Running the tests
 =================
 
-To install the dependencies and test dependencies::
-
-    pip install -e '.[test]'
+Use ``uv run`` to run the tests::
 
-To run the tests::
-
-    pytest
+    uv run pytest
 
 .. _contributing_docs:
 
 Building the documentation
 ==========================
 
-To build the documentation, first install the documentation dependencies::
-
-    pip install -e '.[docs]'
+To build the documentation run this command::
 
-Then run ``make livehtml`` from the ``docs/`` directory to start a server on port 8000 that will serve the documentation and live-reload any time you make an edit to a ``.rst`` file::
+    uv run make livehtml --directory docs
 
-    cd docs
-    make livehtml
+This will start a server on port 8000 that will serve the documentation and live-reload any time you make an edit to a ``.rst`` file.
 
 The `cog <https://github.com/nedbat/cog>`__ tool is used to maintain portions of the documentation. You can run it like so::
 
-    cog -r docs/*.rst
+    uv run cog -r docs/*.rst
 
 .. _contributing_linting:
 
 Linting and formatting
 ======================
 
-``sqlite-utils`` uses `Black <https://black.readthedocs.io/>`__ for code formatting, and `flake8 <https://flake8.pycqa.org/>`__ and `mypy <https://mypy.readthedocs.io/>`__ for linting and type checking.
+``sqlite-utils`` uses `Black <https://black.readthedocs.io/>`__ for code formatting, and `flake8 <https://flake8.pycqa.org/>`__ and `mypy <https://mypy.readthedocs.io/>`__ for linting and type checking::
 
-Black is installed as part of ``pip install -e '.[test]'`` - you can then format your code by running it in the root of the project::
+    uv run black .
 
-    black .
+Linting tools can be run like this::
 
-To install ``mypy`` and ``flake8`` run the following::
-
-    pip install -e '.[flake8,mypy]'
-
-Both commands can then be run in the root of the project like this::
-
-    flake8
-    mypy sqlite_utils
+    uv run flake8
+    uv run mypy sqlite_utils
 
 All three of these tools are run by our CI mechanism against every commit and pull request.
 
 .. _contributing_just:
 
-Using Just and uv
-=================
+Using Just
+==========
 
-If you install `Just <https://github.com/casey/just>`__ and `uv <https://github.com/astral-sh/uv>`__ you can use them to manage your local development environment.
+If you install `Just <https://github.com/casey/just>`__ you can use it to manage your local development environment.
 
 To run all of the tests and linters::
 

{sqlite_utils-4.0a1 → sqlite_utils-4.0rc1}/docs/index.rst

@@ -36,6 +36,7 @@ Contents
    installation
    cli
    python-api
+   migrations
    plugins
    reference
    cli-reference