sqlite-utils/docs/index.rst

=======================
 sqlite-utils |version|
=======================

|PyPI| |Changelog| |Travis CI| |License|

.. |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
.. |Travis CI| image:: https://travis-ci.com/simonw/sqlite-utils.svg?branch=master
   :target: https://travis-ci.com/simonw/sqlite-utils
.. |License| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
   :target: https://github.com/simonw/sqlite-utils/blob/master/LICENSE

*Python utility functions for manipulating SQLite databases*

This library and command-line utility helps create SQLite databases from an existing collection of data.

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.

It is designed as a useful complement to `Datasette <https://github.com/simonw/datasette>`_.

Contents
--------

.. toctree::
   :maxdepth: 3

   cli
   python-api
   changelog

Take a look at `this script <https://github.com/simonw/russian-ira-facebook-ads-datasette/blob/master/fetch_and_build_russian_ads.py>`_ for an example of this library in action.
Show version in docs Thanks, @nedbat https://twitter.com/nedbat/status/1150490436114534400 2019-07-14 12:45:00 -07:00			`=======================`
			`sqlite-utils \|version\|`
			`=======================`
Initial project layout + database table creation tools 2018-07-28 06:43:18 -07:00
Don't show documentation badge on docs index 2020-05-03 08:47:28 -07:00			`\|PyPI\| \|Changelog\| \|Travis CI\| \|License\|`
Add badges to documentation index 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.readthedocs.io/en/stable/changelog.html`
			`.. \|Travis CI\| image:: https://travis-ci.com/simonw/sqlite-utils.svg?branch=master`
			`:target: https://travis-ci.com/simonw/sqlite-utils`
			`.. \|License\| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg`
			`:target: https://github.com/simonw/sqlite-utils/blob/master/LICENSE`

Initial project layout + database table creation tools 2018-07-28 06:43:18 -07:00			`Python utility functions for manipulating SQLite databases`

Re-arranged documentation index page 2019-01-24 21:23:24 -08:00			`This library and command-line utility helps create SQLite databases from an existing collection of data.`
Started the docs with a meaty example 2018-07-28 16:52:07 -07:00
Re-arranged documentation index page 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.`
Started the docs with a meaty example 2018-07-28 16:52:07 -07:00
Documented insert_all() and upsert() and upsert_all() Also re-titled main docs page to 'Python API' 2018-08-12 17:17:14 -07:00			It is designed as a useful complement to `Datasette <https://github.com/simonw/datasette>`_.

table.count property, plus made a start on table documentation 2018-07-30 20:24:35 -07:00			`Contents`
			`--------`

			`.. toctree::`
extracts= table parameter, closes #46 2019-07-23 10:00:42 -07:00			`:maxdepth: 3`
table.count property, plus made a start on table documentation 2018-07-30 20:24:35 -07:00
First CLI command: sqlite-utils table_names test.db 2019-01-24 19:30:47 -08:00			`cli`
Re-arranged documentation index page 2019-01-24 21:23:24 -08:00			`python-api`
Started a changelog, releasing 0.6 2018-08-12 17:46:22 -07:00			`changelog`
Started the docs with a meaty example 2018-07-28 16:52:07 -07:00
Documented insert_all() and upsert() and upsert_all() Also re-titled main docs page to 'Python API' 2018-08-12 17:17:14 -07:00			Take a look at `this script <https://github.com/simonw/russian-ira-facebook-ads-datasette/blob/master/fetch_and_build_russian_ads.py>`_ for an example of this library in action.