Skip to content

Commit b386dcc

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

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

finegrain/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
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](https://docs.astral.sh/uv/) (which we recommend) you can do:
14+
15+
```bash
16+
uv add "finegrain @ git+https://github.com/finegrain-ai/finegrain-python#subdirectory=finegrain"
17+
```
18+
519
## Usage
620

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

0 commit comments

Comments
 (0)