File tree Expand file tree Collapse file tree 1 file changed +17
-5
lines changed
Expand file tree Collapse file tree 1 file changed +17
-5
lines changed Original file line number Diff line number Diff line change @@ -9,18 +9,30 @@ outdated in a new release of the OHDSI vocabularies.
99
1010## Installation
1111
12- kotobuki requires Python 3.11+ and is available on PyPI:
13-
14- ``` shell
15- pip install kotobuki
16- ```
12+ kotobuki requires Python 3.11+ and is available on [ PyPI] ( https://pypi.org/project/kotobuki/ ) .
1713
1814Depending on the type of database you have, you'll also need to install the required python
1915adapter library.
2016E.g. for postgresql, you can use [ psycopg2] ( https://pypi.org/project/psycopg2/ ) .
2117
2218See SQLAlchemy docs for a list of supported [ dialects] ( https://docs.sqlalchemy.org/en/20/dialects/ ) .
2319
20+ As kotobuki is intended to be used as a standalone tool, the recommended method of installation is
21+ in an isolated (temporary) environment.
22+
23+ E.g. if using [ uv] ( https://docs.astral.sh/uv/ ) with a postgresql database:
24+
25+ ``` shell
26+ uvx --with psycopg2 --from kotobuki update-usagi-file --help
27+ ```
28+
29+ Or within a Jupyter notebook:
30+
31+ ``` shell
32+ uv run --with jupyter,psycopg2,kotobuki jupyter lab
33+ ```
34+
35+
2436## Usage
2537See [ User documentation] ( https://github.com/thehyve/kotobuki/blob/main/docs/kotobuki.md )
2638
You can’t perform that action at this time.
0 commit comments