Skip to content

Commit f25428e

Browse files
committed
docs: clarify dependencies and testing
1 parent 0b0a6df commit f25428e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@ Inspired by [phiresky's sql.js-httpvfs](https://github.com/phiresky/sql.js-httpv
1111

1212
## Installation
1313

14+
You can install sqlite-s3-query from [PyPI](https://pypi.org/project/sqlite-s3-query/) using pip.
15+
1416
```bash
1517
pip install sqlite_s3_query
1618
```
1719

18-
The libsqlite3 binary library is also required, but this is typically already installed on most systems. The earliest version of libsqlite3 known to work is 2012-12-12 (3.7.15).
20+
This will automatically install [HTTPX](https://www.python-httpx.org/), which is used to communicate with S3. A package often used to communciate with S3 from Python is [boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html), but sqlite-s3-query does not use boto3.
21+
22+
The libsqlite3 binary library is also required, but this is typically already installed on most systems. The earliest version of libsqlite3 known to work is 3.7.15 (2012-12-12).
1923

2024

2125
## Usage
@@ -224,3 +228,4 @@ It is safe for multiple threads to call the same `query` function. Under the hoo
224228
- Linux (tested on Ubuntu 20.04), Windows (tested on Windows Server 2019), or macOS (tested on macOS 11)
225229
- SQLite >= 3.7.15, (tested on 3.7.15, 3.36.0, 3.42.0, and the default version available on each OS tested)
226230
- Python >= 3.6.7 (tested on 3.6.7, 3.7.1, 3.8.0, 3.9.0, 3.10.0, and 3.11.0)
231+
- HTTPX >= 0.18.2 (tested on 0.18.2)

0 commit comments

Comments
 (0)