Skip to content

Commit 18c60b9

Browse files
Update README.md
1 parent fe01710 commit 18c60b9

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,26 @@ Installation
2929
- OR
3030
- Download the `.sublime-package` from git repo and put it in your sublime packages folder
3131

32+
Settings
33+
--------
34+
```
35+
{
36+
"paths_to_scan": [], // Not used as of now
37+
"python_venv_path": "",
38+
"python_interpreter_path": "", // Not used as of now
39+
"log_level": "info",
40+
"import_scan_depth": 4
41+
}
42+
```
43+
- `paths_to_scan`: This is still in development, it will have no effect as of now.
44+
- `python_interpreter_path`: This is still in development, it will have no effect as of now.
45+
- `python_venv_path` : Specifies which python env to use when indexing files, if not given it will choose the default python interpreter of your system (Make sure you have set any default python, otherwise it will not be able to index). It takes the full path to `activate` file of the virtual environment, for example:
46+
```
47+
"python_venv_path": "~/home/venv/bin/activate"
48+
```
49+
- `log_level`: By default set to `info`, accepted values `info`, `debug`, `error`, `warning`
50+
- `import_scan_depth`: This defines how deep it will scan any python package, the higher the number the more deep it will go, `4` is an optimal depth, you can increase it but it will also increase the time to index all files, so change it carefully.
51+
3252
Usage
3353
-----
3454
- Upon installation it automatically reads the settings and scans your python environment for packages and index them.

0 commit comments

Comments
 (0)