Skip to content

Commit 820b035

Browse files
karfauadrianeboyd
andauthored
docs: reflect current state of pyhton config (#23)
Since uv/pip-compile support is now more complete, the readme needs some tweaks. --------- Co-authored-by: Adriane Boyd <[email protected]>
1 parent 0581ed3 commit 820b035

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ A very common thing is to add [`:autoMergePatch`](https://docs.renovatebot.com/p
198198
### python
199199

200200
**There is currently only [limited / "alpha level" support](https://github.com/renovatebot/renovate/blob/main/lib/modules/manager/pip-compile/readme.md) for python using `pip-compile`.
201-
This configuration has not been used with python projects for a while, it most certainly needs changes.**
201+
This configuration is currently only used in a small number of python projects, so it may need modifications. You can test it in [bettermarks/renovate-config-test-pip-compile](https://github.com/bettermarks/renovate-config-test-pip-compile) by modifying the dependency files and the renovate config in order to see what updates renovate produces.**
202202

203203
```json
204204
{
@@ -211,11 +211,17 @@ It includes the following presets:
211211

212212
- the [default config](#default) from this repository
213213

214-
215214
and it configures the following:
216215

217-
- constraints python to 3.6
218-
- Enables [pip-compile](https://docs.renovatebot.com/modules/manager/pip-compile/) manager (and disables [pip_requirements](https://docs.renovatebot.com/modules/manager/pip_requirements/) and [pip_setup](https://docs.renovatebot.com/modules/manager/pip_setup/) managers since they seem to be conflicting?)
216+
- Enables [pip-compile](https://docs.renovatebot.com/modules/manager/pip-compile/) manager (and disables [pip_requirements](https://docs.renovatebot.com/modules/manager/pip_requirements/) and [pip_setup](https://docs.renovatebot.com/modules/manager/pip_setup/) managers since we don't use those)
217+
218+
If you found a config that works for you, please consider updating this one after testing it in [bettermarks/renovate-config-test-pip-compile](https://github.com/bettermarks/renovate-config-test-pip-compile).
219219

220220
**you can override all of this per repo!**
221-
if you found a config that works for you, please consider to update this one.
221+
222+
It is very likely (especially for `uv pip compile`, which doesn't include the python version in the header) that you want to specify the python version in the config:
223+
```
224+
"constraints": {
225+
"python": "==3.9"
226+
},
227+
```

0 commit comments

Comments
 (0)