Skip to content

Commit 6e38ca8

Browse files
committed
add info on how to install in the readme
1 parent 99352e0 commit 6e38ca8

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

finegrain/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
This is a client for the [Finegrain](https://finegrain.ai) API. It requires Python 3.12+ and is designed for asynchronous code using asyncio. It depends on httpx and [httpx_sse](https://github.com/florimondmanca/httpx-sse).
44

5+
## Setup
6+
7+
We do not publish this package to PyPI or cut releases for now. Here is how to use it with pip:
8+
9+
```bash
10+
pip install "git+https://github.com/finegrain-ai/finegrain-python#subdirectory=finegrain"
11+
```
12+
13+
If you use uv or Rye (which we recommend) you can do one of:
14+
15+
```bash
16+
uv add "finegrain @ git+https://github.com/finegrain-ai/finegrain-python#subdirectory=finegrain" # with uv
17+
rye add "finegrain @ git+https://github.com/finegrain-ai/finegrain-python#subdirectory=finegrain" # with Rye
18+
```
19+
520
## Usage
621

722
See [this example script](examples/erase.py) to erase an object from an image by prompt.

0 commit comments

Comments
 (0)