diff options
author | Eike Ziller <eike.ziller@qt.io> | 2018-09-14 16:21:08 +0200 |
---|---|---|
committer | Eike Ziller <eike.ziller@qt.io> | 2018-09-17 10:52:11 +0000 |
commit | 9e10b05850ee3a42513a334e66f61b37e02691e8 (patch) | |
tree | 471c09fb9ff584488a15453e528257b7e61e9075 /docs | |
parent | a33fc09a091f73ca3cc3192dfc88218883aed1c9 (diff) |
Remove unnecessary "setup.py" mechanism for initializing extensions
There already is the requirements.txt mechanism that takes care of pip
installing in the right way.
Setup for which this is not sufficient should be possible to do in the
initialization code of the extension directly. Additionally the provided
example was broken (e.g. didn't work with spaces in paths), and the
whole mechanism had the encapsulation problem that the extensions
themselves had before they were made modules/packages.
Change-Id: I8692e26e65ec667267c7918e6edbd32f55534bc8
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/extensions.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/docs/extensions.md b/docs/extensions.md index 6d4998d..4b3689a 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -117,13 +117,11 @@ are reserved for the ExtensionManager. Unless you know exactly what you are doin touch any of these variables. ## Installing dependencies -There are two ways you can install dependencies. If you need very fine-grained control over how -extension looks like before it can be run, you can supply a `setup.py` script, which is run -separately before your extension is started. An example of such a script can be found in the example -extension `examples/numpysetup`. -If you only want to install dependencies, you can also include a standard Python `requirements.txt` +If you want to install dependencies, you can include a standard Python `requirements.txt` file in your extension folder. **Note that this file is pip installed _once_.** After the initial pip install, a new file called `requirements.txt.installed` is created in the extensions folder. To run the install again, this file simply has to be deleted. **Be careful to remove this file, when distributing your extension in a .zip file.** + +Otherwise you can do any setup you need in your extension's initialization code. |