You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| Python 3.10-3.12 |[Download](https://www.python.org/downloads/)| The library is Python-based. |
8
-
|Poetry|[Instructions](https://python-poetry.org/docs/#installation)| Poetry is used for package management and virtualenv management in Python codebases |
8
+
|uv|[Instructions](https://docs.astral.sh/uv/)| uv is used for package management and virtualenv management in Python codebases|
9
9
10
10
# Getting Started
11
11
12
12
## Install Dependencies
13
13
14
14
```sh
15
-
# Install Python dependencies.
16
-
poetry install
15
+
# (optional) create virtual environment
16
+
uv venv --python 3.10
17
+
source .venv/bin/activate
18
+
19
+
# install python dependencies
20
+
uv sync --extra dev
17
21
```
18
22
19
23
## Execute the Indexing Engine
20
24
21
25
```sh
22
-
poetry run poe index <...args>
26
+
uv run poe index <...args>
23
27
```
24
28
25
29
## Executing Queries
26
30
27
31
```sh
28
-
poetry run poe query <...args>
32
+
uv run poe query <...args>
29
33
```
30
34
31
35
# Azurite
@@ -40,31 +44,31 @@ or by simply running `azurite` in the terminal if already installed globally. Se
40
44
41
45
# Lifecycle Scripts
42
46
43
-
Our Python package utilizes Poetry to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage build scripts.
47
+
Our Python package utilize uv to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage build scripts.
44
48
45
49
Available scripts are:
46
50
47
-
-`poetry run poe index` - Run the Indexing CLI
48
-
-`poetry run poe query` - Run the Query CLI
49
-
-`poetry build` - This invokes `poetry build`, which will build a wheel file and other distributable artifacts.
50
-
-`poetry run poe test` - This will execute all tests.
51
-
-`poetry run poe test_unit` - This will execute unit tests.
52
-
-`poetry run poe test_integration` - This will execute integration tests.
53
-
-`poetry run poe test_smoke` - This will execute smoke tests.
54
-
-`poetry run poe test_verbs` - This will execute tests of the basic workflows.
55
-
-`poetry run poe check` - This will perform a suite of static checks across the package, including:
51
+
-`uv run poe index` - Run the Indexing CLI
52
+
-`uv run poe query` - Run the Query CLI
53
+
-`uv build` - This will build a wheel file and other distributable artifacts.
54
+
-`uv run poe test` - This will execute all tests.
55
+
-`uv run poe test_unit` - This will execute unit tests.
56
+
-`uv run poe test_integration` - This will execute integration tests.
57
+
-`uv run poe test_smoke` - This will execute smoke tests.
58
+
-`uv run poe test_verbs` - This will execute tests of the basic workflows.
59
+
-`uv run poe check` - This will perform a suite of static checks across the package, including:
56
60
- formatting
57
61
- documentation formatting
58
62
- linting
59
63
- security patterns
60
64
- type-checking
61
-
-`poetry run poe fix` - This will apply any available auto-fixes to the package. Usually this is just formatting fixes.
62
-
-`poetry run poe fix_unsafe` - This will apply any available auto-fixes to the package, including those that may be unsafe.
63
-
-`poetry run poe format` - Explicitly run the formatter across the package.
65
+
-`uv run poe fix` - This will apply any available auto-fixes to the package. Usually this is just formatting fixes.
66
+
-`uv run poe fix_unsafe` - This will apply any available auto-fixes to the package, including those that may be unsafe.
67
+
-`uv run poe format` - Explicitly run the formatter across the package.
64
68
65
69
## Troubleshooting
66
70
67
-
### "RuntimeError: llvm-config failed executing, please point LLVM_CONFIG to the path for llvm-config" when running poetry install
71
+
### "RuntimeError: llvm-config failed executing, please point LLVM_CONFIG to the path for llvm-config" when running uv install
68
72
69
73
Make sure llvm-9 and llvm-9-dev are installed:
70
74
@@ -74,12 +78,6 @@ and then in your bashrc, add
74
78
75
79
`export LLVM_CONFIG=/usr/bin/llvm-config-9`
76
80
77
-
### "numba/\_pymodule.h:6:10: fatal error: Python.h: No such file or directory" when running poetry install
78
-
79
-
Make sure you have python3.10-dev installed or more generally `python<version>-dev`
80
-
81
-
`sudo apt-get install python3.10-dev`
82
-
83
81
### LLM call constantly exceeds TPM, RPM or time limits
84
82
85
83
`GRAPHRAG_LLM_THREAD_COUNT` and `GRAPHRAG_EMBEDDING_THREAD_COUNT` are both set to 50 by default. You can modify these values
0 commit comments