Skip to content

Commit b104ccf

Browse files
committed
Binary instructions in README
1 parent 7f313c5 commit b104ccf

2 files changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,19 @@ Python client library for [Diffbot](https://www.diffbot.com) APIs.
55

66
## Installation
77

8+
Install the [standalone CLI binary](#standalone-binary) for [agentic use](#how-to-use-with-an-agent):
9+
10+
```bash
11+
curl -fsSL https://raw.githubusercontent.com/diffbot/diffbot-python/main/install.sh | sh
12+
```
13+
14+
If you prefer, the full Python library can also be installed with pip:
15+
816
```bash
917
python3 -m pip install diffbot-python
1018
```
1119

12-
Or, for local development:
20+
For local development:
1321

1422
```bash
1523
pip install -e ".[dev]"
@@ -202,9 +210,9 @@ uv tool install .
202210

203211
This drops a `db` executable into `~/.local/bin` (ensure it is on your `PATH`). Use `--force` to reinstall or upgrade after changes, or `--editable` to have source edits take effect immediately. Alternatively, a plain `pip install .` (or `pip install -e .`) also installs the `db` entry point into the active environment.
204212

205-
### Standalone binary (no Python required)
213+
### Standalone binary
206214

207-
Every release also ships a self-contained `db` binary for Linux (x86_64 and aarch64) and macOS (Apple Silicon) — no Python install needed. The installer detects your platform, verifies the SHA256 checksum, and installs (or upgrades) `db` into `~/.local/bin`:
215+
Every release also ships a self-contained `db` binary for Linux (x86_64 and aarch64) and macOS (Apple Silicon) as a Python-free option. The installer detects your platform, verifies the SHA256 checksum, and installs (or upgrades) `db` into `~/.local/bin`:
208216

209217
```bash
210218
curl -fsSL https://raw.githubusercontent.com/diffbot/diffbot-python/main/install.sh | sh
@@ -216,6 +224,8 @@ Pin a specific release or install location with flags (or the `DB_VERSION` / `DB
216224
curl -fsSL https://raw.githubusercontent.com/diffbot/diffbot-python/main/install.sh | sh -s -- --version v0.2.1 --bin-dir ~/bin
217225
```
218226

227+
### How to use
228+
219229
```bash
220230
export DIFFBOT_API_TOKEN=your-token-here
221231

@@ -230,6 +240,12 @@ db entities "Apple CEO Tim Cook announced record quarterly earnings."
230240
db entities "Apple CEO Tim Cook announced record quarterly earnings." -f dql
231241
```
232242

243+
### How to use with an agent
244+
Once installed, this library will work alongside [`diffbot-skills`](https://github.com/diffbot/diffbot-skills) to enable your agent full access to structuring web knowledge with Diffbot. Diffbot Agent Skills even unlocks some additional skills like crafting DQL from natural language.
245+
246+
`diffbot-skills` will pick up or install this library automatically.
247+
248+
233249
## Tests
234250

235251
Run the mock test suite:

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)