mirror of
https://github.com/simonw/dclient.git
synced 2026-07-24 09:54:32 +02:00
c847badc4e* Move making queries to own page, refs #7 * Documentation for the dclient insert feature, refs #8 * Implemented progress bar for insert, refs #8 * --pk option * --ignore and --replace for insert, refs #8 * --batch-size option, refs #8 * First insert test, using a mock - refs #8 * insert test that exercises against an in-memory Datasette instance, refs #8 * Insert tests now cover an error case, refs #8 * Tests for --ignore and --replace, refs #8 * Tests for different formats, refs #8 * Test for --no-detect-types * Support for --encoding, refs #8
52 lines
No EOL
1.7 KiB
Markdown
52 lines
No EOL
1.7 KiB
Markdown
# dclient
|
|
|
|
[](https://pypi.org/project/dclient/)
|
|
[](https://github.com/simonw/dclient/releases)
|
|
[](https://github.com/simonw/dclient/actions?query=workflow%3ATest)
|
|
[](https://github.com/simonw/dclient/blob/master/LICENSE)
|
|
|
|
A client CLI utility for [Datasette](https://datasette.io/) instances
|
|
|
|
## Things you can do with dclient
|
|
|
|
- Run SQL queries against Datasette and returning the results as JSON
|
|
- Run queries against authenticated Datasette instances
|
|
- Create aliases and store authentication tokens for convenient access to Datasette
|
|
- Insert data into Datasette using the [insert API](https://docs.datasette.io/en/latest/json_api.html#the-json-write-api) (Datasette 1.0 alpha or higher)
|
|
|
|
## Installation
|
|
|
|
Install this tool using `pip`:
|
|
```bash
|
|
pip install dclient
|
|
```
|
|
If you want to install it in the same virtual environment as Datasette (to use it as a plugin) you can instead run:
|
|
```bash
|
|
datasette install dclient
|
|
```
|
|
## Running a query
|
|
|
|
```bash
|
|
dclient query https://latest.datasette.io/fixtures "select * from facetable limit 1"
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Visit **[dclient.datasette.io](https://dclient.datasette.io)** for full documentation on using this tool.
|
|
|
|
## Development
|
|
|
|
To contribute to this tool, first checkout the code. Then create a new virtual environment:
|
|
```bash
|
|
cd dclient
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
```
|
|
Now install the dependencies and test dependencies:
|
|
```bash
|
|
pip install -e '.[test]'
|
|
```
|
|
To run the tests:
|
|
```bash
|
|
pytest
|
|
``` |