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
Copy file name to clipboardExpand all lines: README.md
+27-24Lines changed: 27 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,17 +41,20 @@ If you want to run statelessly you omit mounting volume onto /cache (not recomme
41
41
$ docker run --rm -v $(pwd):/out ghcr.io/alterakey/trueseeing
42
42
43
43
44
-
### With pip / uvx
44
+
### Install with [uv](https://github.com/astral-sh/uv)
45
45
46
-
Alternatively, you can install our package with pip as follows. This form of installation might be useful for extensions, as it grants them the greatest freedom. Just remember you need a JRE and Android SDK (optionally; to mess with devices):
46
+
Alternatively, you can install our package with [uv](https://github.com/astral-sh/uv) as follows. Especially the `uv tool install`form of installation might be useful for extensions (see below), as it grants them the greatest freedom. Just remember you need a JRE and Android SDK (optionally; to mess with devices):
47
47
48
-
$ pip install --user trueseeing
48
+
$ uvx trueseeing
49
+
50
+
$ uv tool install trueseeing
49
51
$ trueseeing
50
52
51
-
Or, with [uv](https://github.com/astral-sh/uv) you could do:
53
+
### Install with pip (deprecated)
52
54
53
-
$ uvx trueseeing
55
+
Of course you can always use the good old pip if you must:
54
56
57
+
$ pip install trueseeing
55
58
56
59
## Usage
57
60
@@ -122,7 +125,7 @@ To get report generated in stdout, specify '-' as filename:
122
125
123
126
### Extensions
124
127
125
-
You can write your own commands and signatures as extensions. Extensions are placed under `/ext` (containers) or `~/.trueseeing2/extensions/` (pip) . Alternatively you can distribute your extensions as wheels. We provide type information so you can not only type-check your extensions with [mypy](https://github.com/python/mypy) but also get a decent assist from IDEs. See the details section for details.
128
+
You can write your own commands and signatures as extensions. Extensions are placed under `/ext` (containers) or `~/.trueseeing2/extensions/` (uv/pip) . Alternatively you can distribute your extensions as wheels. We provide type information so you can not only type-check your extensions with [zuban](https://github.com/zubanls/zuban) but also get a decent assist from IDEs. See the details section for details.
126
129
127
130
## Build
128
131
@@ -134,30 +137,30 @@ To build wheels you can do with [flit](https://flit.pypa.io/en/stable/), as foll
134
137
135
138
$ flit build
136
139
137
-
To hack it, you need to create a proper build environment. To create one, set up a venv, install [flit](https://flit.pypa.io/en/stable/) in there, and have it pull dependencies and validating toolchains; esp. [mypy](https://github.com/python/mypy) and [pflake8](https://github.com/csachs/pyproject-flake8). In short, do something like this:
140
+
To hack it, you need to create a proper build environment. With [uv](https://github.com/astral-sh/uv) you could just do:
$ docker build -t trueseeing . # to build (container)
150
150
151
-
Or, with [uv](https://github.com/astral-sh/uv) you could do:
151
+
With pip, to create one, firstly set up a venv, install [flit](https://flit.pypa.io/en/stable/) and validating toolchains ([zuban](https://github.com/zubanls/zuban) and [ruff](https://github.com/astral-sh/ruff)) in there, and have flit pull dependencies. In short, do something like this:
@@ -204,7 +207,7 @@ Currently we can detect the following class of vulnerabilities, largely ones cov
204
207
205
208
### Extension API
206
209
207
-
Our extension API lays under the `trueseeing.api` package. As we provide type information with it, your IDE will assist you when writing your extensions.
210
+
Our extension API lays under the `trueseeing.api` package. As we provide type information with it, your IDE will assist you when writing your extensions. Just make sure its (or its language server's) PYTHONPATH covers the venv in where our package; see `uv tool list --show-paths` if you installed it with `uv tool install`. If you installed with `uvx`, consider re-install it with `uvx install`. If you installed with pip, you've already know where it is.
0 commit comments