diff --git a/README.md b/README.md index 4e961fc..fa78d9d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # sqlite-utils [![PyPI](https://img.shields.io/pypi/v/sqlite-utils.svg)](https://pypi.org/project/sqlite-utils/) -[![Changelog](https://img.shields.io/github/v/release/simonw/sqlite-utils?include_prereleases&label=changelog)](https://sqlite-utils.readthedocs.io/en/latest/changelog.html) +[![Changelog](https://img.shields.io/github/v/release/simonw/sqlite-utils?include_prereleases&label=changelog)](https://sqlite-utils.datasette.io/en/latest/changelog.html) [![Python 3.x](https://img.shields.io/pypi/pyversions/sqlite-utils.svg?logo=python&logoColor=white)](https://pypi.org/project/sqlite-utils/) [![Tests](https://github.com/simonw/sqlite-utils/workflows/Test/badge.svg)](https://github.com/simonw/sqlite-utils/actions?query=workflow%3ATest) -[![Documentation Status](https://readthedocs.org/projects/sqlite-utils/badge/?version=latest)](http://sqlite-utils.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/sqlite-utils/badge/?version=latest)](http://sqlite-utils.datasette.io/en/latest/?badge=latest) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/sqlite-utils/blob/main/LICENSE) Python CLI utility and library for manipulating SQLite databases. ## Some feature highlights -- [Pipe JSON](https://sqlite-utils.readthedocs.io/en/stable/cli.html#inserting-json-data) (or [CSV or TSV](https://sqlite-utils.readthedocs.io/en/stable/cli.html#inserting-csv-or-tsv-data)) directly into a new SQLite database file, automatically creating a table with the appropriate schema -- [Configure SQLite full-text search](https://sqlite-utils.readthedocs.io/en/stable/cli.html#configuring-full-text-search) against your database tables and run search queries against them, ordered by relevance -- Run [transformations against your tables](https://sqlite-utils.readthedocs.io/en/stable/cli.html#transforming-tables) to make schema changes that SQLite `ALTER TABLE` does not directly support, such as dropping columns -- [Extract columns](https://sqlite-utils.readthedocs.io/en/stable/cli.html#extracting-columns-into-a-separate-table) into separate tables to better normalize your existing data +- [Pipe JSON](https://sqlite-utils.datasette.io/en/stable/cli.html#inserting-json-data) (or [CSV or TSV](https://sqlite-utils.datasette.io/en/stable/cli.html#inserting-csv-or-tsv-data)) directly into a new SQLite database file, automatically creating a table with the appropriate schema +- [Configure SQLite full-text search](https://sqlite-utils.datasette.io/en/stable/cli.html#configuring-full-text-search) against your database tables and run search queries against them, ordered by relevance +- Run [transformations against your tables](https://sqlite-utils.datasette.io/en/stable/cli.html#transforming-tables) to make schema changes that SQLite `ALTER TABLE` does not directly support, such as dropping columns +- [Extract columns](https://sqlite-utils.datasette.io/en/stable/cli.html#extracting-columns-into-a-separate-table) into separate tables to better normalize your existing data Read more on my blog: [ sqlite-utils: a Python library and CLI tool for building SQLite databases](https://simonwillison.net/2019/Feb/25/sqlite-utils/) and other [entries tagged sqliteutils](https://simonwillison.net/tags/sqliteutils/). @@ -54,7 +54,7 @@ You can even import data into a new database table like this: $ curl https://api.github.com/repos/simonw/sqlite-utils/releases \ | sqlite-utils insert releases.db releases - --pk id -See the [full CLI documentation](https://sqlite-utils.readthedocs.io/en/stable/cli.html) for comprehensive coverage of many more commands. +See the [full CLI documentation](https://sqlite-utils.datasette.io/en/stable/cli.html) for comprehensive coverage of many more commands. ## Using as a library @@ -70,7 +70,7 @@ db["dogs"].insert_all([ ], pk="id") ``` -Check out the [full library documentation](https://sqlite-utils.readthedocs.io/en/stable/python-api.html) for everything else you can do with the Python library. +Check out the [full library documentation](https://sqlite-utils.datasette.io/en/stable/python-api.html) for everything else you can do with the Python library. ## Related projects diff --git a/docs/cli.rst b/docs/cli.rst index bf67a11..445cef2 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -427,7 +427,7 @@ You can delete all the existing rows in the table before inserting the new recor $ sqlite-utils insert dogs.db dogs dogs.json --truncate -You can also import newline-delimited JSON using the ``--nl`` option. Since `Datasette `__ can export newline-delimited JSON, you can combine the two tools like so:: +You can also import newline-delimited JSON using the ``--nl`` option. Since `Datasette `__ can export newline-delimited JSON, you can combine the two tools like so:: $ curl -L "https://latest.datasette.io/fixtures/facetable.json?_shape=array&_nl=on" \ | sqlite-utils insert nl-demo.db facetable - --pk=id --nl diff --git a/docs/index.rst b/docs/index.rst index 528dbae..571020f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ .. |PyPI| image:: https://img.shields.io/pypi/v/sqlite-utils.svg :target: https://pypi.org/project/sqlite-utils/ .. |Changelog| image:: https://img.shields.io/github/v/release/simonw/sqlite-utils?include_prereleases&label=changelog - :target: https://sqlite-utils.readthedocs.io/en/stable/changelog.html + :target: https://sqlite-utils.datasette.io/en/stable/changelog.html .. |CI| image:: https://github.com/simonw/sqlite-utils/workflows/Test/badge.svg :target: https://github.com/simonw/sqlite-utils/actions .. |License| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg diff --git a/docs/python-api.rst b/docs/python-api.rst index 130c4cb..ac7a830 100644 --- a/docs/python-api.rst +++ b/docs/python-api.rst @@ -349,7 +349,7 @@ Specifying foreign keys Any operation that can create a table (``.create()``, ``.insert()``, ``.insert_all()``, ``.upsert()`` and ``.upsert_all()``) accepts an optional ``foreign_keys=`` argument which can be used to set up foreign key constraints for the table that is being created. -If you are using your database with `Datasette `__, Datasette will detect these constraints and use them to generate hyperlinks to associated records. +If you are using your database with `Datasette `__, Datasette will detect these constraints and use them to generate hyperlinks to associated records. The ``foreign_keys`` argument takes a list that indicates which foreign keys should be created. The list can take several forms. The simplest is a list of columns: diff --git a/setup.py b/setup.py index a507a1b..2a17384 100644 --- a/setup.py +++ b/setup.py @@ -35,8 +35,8 @@ setup( tests_require=["sqlite-utils[test]"], url="https://github.com/simonw/sqlite-utils", project_urls={ - "Documentation": "https://sqlite-utils.readthedocs.io/en/stable/", - "Changelog": "https://sqlite-utils.readthedocs.io/en/stable/changelog.html", + "Documentation": "https://sqlite-utils.datasette.io/en/stable/", + "Changelog": "https://sqlite-utils.datasette.io/en/stable/changelog.html", "Source code": "https://github.com/simonw/sqlite-utils", "Issues": "https://github.com/simonw/sqlite-utils/issues", "CI": "https://github.com/simonw/sqlite-utils/actions",