sqlite-utils/docs/index.rst

43 lines
1.7 KiB
ReStructuredText
Raw Normal View History

=======================
sqlite-utils |version|
=======================
2022-08-02 14:15:52 -07:00
|PyPI| |Changelog| |CI| |License| |discord|
2020-05-03 08:44:41 -07:00
.. |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.datasette.io/en/stable/changelog.html
2020-08-28 15:41:29 -07:00
.. |CI| image:: https://github.com/simonw/sqlite-utils/workflows/Test/badge.svg
:target: https://github.com/simonw/sqlite-utils/actions
2020-05-03 08:44:41 -07:00
.. |License| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
2020-08-10 14:04:32 -07:00
:target: https://github.com/simonw/sqlite-utils/blob/main/LICENSE
2022-08-02 14:15:52 -07:00
.. |discord| image:: https://img.shields.io/discord/823971286308356157?label=discord
:target: https://discord.gg/Ass7bCAMDw
2020-05-03 08:44:41 -07:00
2022-11-15 07:53:38 -08:00
*CLI tool and Python library for manipulating SQLite databases*
2019-01-24 21:23:24 -08:00
This library and command-line utility helps create SQLite databases from an existing collection of data.
2018-07-28 16:52:07 -07:00
2019-01-24 21:23:24 -08:00
Most of the functionality is available as either a Python API or through the ``sqlite-utils`` command-line tool.
sqlite-utils is not intended to be a full ORM: the focus is utility helpers to make creating the initial database and populating it with data as productive as possible.
2018-07-28 16:52:07 -07:00
2020-12-29 13:33:25 -08:00
It is designed as a useful complement to `Datasette <https://datasette.io/>`_.
`Cleaning data with sqlite-utils and Datasette <https://datasette.io/tutorials/clean-data>`_ provides a tutorial introduction (and accompanying ten minute video) about using this tool.
Contents
--------
.. toctree::
2019-07-23 10:00:42 -07:00
:maxdepth: 3
installation
cli
2019-01-24 21:23:24 -08:00
python-api
plugins
reference
cli-reference
contributing
2018-08-12 17:46:22 -07:00
changelog