Skip to content

Commit 7ce0770

Browse files
authored
Improved README. Fixes #101
1 parent 2ab62bc commit 7ce0770

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ Python CLI utility and library for manipulating SQLite databases.
1010
Read more on my blog: [
1111
sqlite-utils: a Python library and CLI tool for building SQLite databases](https://simonwillison.net/2019/Feb/25/sqlite-utils/)
1212

13-
Install it like this:
13+
## Installation
1414

1515
pip3 install sqlite-utils
1616

17+
## Using as a CLI tool
18+
1719
Now you can do things with the CLI utility like this:
1820

1921
$ sqlite-utils tables dogs.db --counts
@@ -34,7 +36,16 @@ Now you can do things with the CLI utility like this:
3436
1 4 Cleo
3537
2 2 Pancakes
3638

37-
Or you can import it and use it as a Python library like this:
39+
You can even import data into a new database table like this:
40+
41+
$ curl https://api.github.com/repos/simonw/sqlite-utils/releases \
42+
| sqlite-utils insert releases.db releases - --pk
43+
44+
Full CLI documentation: https://sqlite-utils.readthedocs.io/en/stable/cli.html
45+
46+
## Using as a library
47+
48+
You can also `import sqlite_utils` and use it as a Python library like this:
3849

3950
```python
4051
import sqlite_utils
@@ -46,10 +57,11 @@ db["dogs"].insert_all([
4657
], pk="id")
4758
```
4859

49-
Full documentation: https://sqlite-utils.readthedocs.io/
60+
Full library documentation: https://sqlite-utils.readthedocs.io/en/stable/python-api.html
5061

51-
Related projects:
62+
## Related projects
5263

5364
* [Datasette](https://github.com/simonw/datasette): A tool for exploring and publishing data
5465
* [csvs-to-sqlite](https://github.com/simonw/csvs-to-sqlite): Convert CSV files into a SQLite database
5566
* [db-to-sqlite](https://github.com/simonw/db-to-sqlite): CLI tool for exporting a MySQL or PostgreSQL database as a SQLite file
67+
* [dogsheep](https://dogsheep.github.io/): A family of tools for personal analytics, built on top of `sqlite-utils`

0 commit comments

Comments
 (0)