Skip to content

Update README: Now QPIP does check for Python dependencies on plugin installation #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gacarrillor merged 1 commit into from
Nov 11, 2025
Merged

Update README: Now QPIP does check for Python dependencies on plugin installation #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

**QPIP** is a QGIS plugin allowing to manage Python dependencies for other plugins.

When loading other plugins, it will check if a `requirements.txt` file exists in its directory. If so, it will verify if the dependencies are met, and display a dialog offering to install missing requirements.
When installing or loading other plugins, it will check if a `requirements.txt` file exists in its directory. If so, it will verify if the dependencies are met, and display a dialog offering to install missing requirements.

All requirements are installed in the user's profile (under `python/dependencies`), so that each user profile can have a different set of dependencies.


## Usage (end user)

Install `QPIP` through the QGIS plugin manager. Once installed, by default, dependencies will be checked automatically when activating new plugins.
Install `QPIP` through the QGIS plugin manager. Once installed, by default, dependencies will be checked automatically when installing or activating new plugins.

### Plugin menu

Expand All @@ -29,7 +29,7 @@ The main dialog shows a list of Python libraries with the following columns:
- **Installed** the version currently available on your system (system-wide python libraries are marked with `[global]`)
- **Action** the action that will be taken once you click on "OK".

You can filter the list to either show only missing/conflicting dependencies, or to include system wide python libraries even if not directly required by a QGIS plugin. Note that you should not uninstall/upgrade system wide python libraries unless you know what you are doing (it may require administrator privileges).
You can filter the list to either show only missing/conflicting dependencies, or to include system-wide python libraries even if not directly required by a QGIS plugin. Note that you should not uninstall/upgrade system-wide python libraries unless you know what you are doing (it may require administrator privileges).

You can also configure when QPIP should automatically check for dependencies.

Expand Down Expand Up @@ -70,7 +70,7 @@ pip install pre-commit
pre-commit install
```

Deployements to QGIS plugin repository are made automatically by Github workflows when tags matching `v*` are pushed.
Deployments to QGIS plugin repository are made automatically by GitHub workflows when tags matching `v*` are pushed.


## Roadmap
Expand Down