Merge pull request #124 from Riverscapes/dev

Version 0.9.2 Release

.vscode/launch.json

@@ -6,23 +6,23 @@
   "configurations": [
     {
       "name": "QGIS Debug",
-      "type": "python",
+      "type": "debugpy",
       "request": "attach",
       "connect": {
         "host": "localhost",
         "port": 5678
       },
-      "pathMappings": [
-        {
-          "localRoot": "${workspaceFolder}",
-          "remoteRoot": "${workspaceFolder}",
-        }
-      ],
+      // "pathMappings": [
+      //   {
+      //     "localRoot": "${workspaceFolder}",
+      //     "remoteRoot": "${workspaceFolder}",
+      //   }
+      // ],
       "justMyCode": true
     },
     {
       "name": "Python: Current File",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "program": "${file}",
       "cwd": "${workspaceFolder}",

CHANGELOG.md

@@ -1,4 +1,18 @@
 
+## 0.9.2 ***(April 26, 2024)***
+
+### Added
+- Project Data Exchange Uploader
+
+### Fixed
+- Close All Projects Throws Error #107
+- Better Business logic handling
+- Message bar was not showing up #123
+- GraphQL files not being included in the deploy #117
+
+### Changed
+- Removed additional "QRAVE" references
+
 ## 0.9.1 ***(March 27, 2024)***
 
 ### Fixed

CHECKLIST.md

@@ -7,10 +7,11 @@ NEVER WORK DIRECTLY ON THE MASTER BRANCH
 1. Commit and push everything to git
 2. increment the version number in `__version__.py`
 3. Do a compile of all the UI and resources and commit that `pb_tool compile`
-4. Run the `deploy.py` script once and test the local version of the plugin
-5. Do a code review and a pull request to get this onto the master branch
-6. Tag the commit in git with the version number
-7. Run `deploy.py` again. This will produce the zip file to upload
-8. Test again
-9. Go to https://plugins.qgis.org/plugins/riverscapes_viewer/ and log in. You should be able to manage and add a new version from there.
-10. Go make a release on github. This might be redundant but....  TBA
+4. Make sure all dependencies are in place by running `sh ./scripts/installDeps.sh`
+5. Run the `deploy.py` script once and test the local version of the plugin
+6. Do a code review and a pull request to get this onto the master branch
+7. Tag the commit in git with the version number
+8. Run `deploy.py` again. This will produce the zip file to upload
+9. Test again
+10. Go to https://plugins.qgis.org/plugins/riverscapes_viewer/ and log in. You should be able to manage and add a new version from there.
+11. Go make a release on github. This might be redundant but....  TBA

README.md

@@ -8,8 +8,11 @@ The Riverscapes Viewer (formerly QRAVE) is a [QGIS](http://www.qgis.org/en/site/
 
 The Riverscapes Viewer Plugin software was developed by North Arrow Research Ltd., with funding form the [Bonneville Power Administration](https://www.bpa.gov/) (BPA) BPA Fish and Wildlife Program Project [#2011-006](http://www.cbfish.org/Project.mvc/Display/2011-006-00). Contributions were also made by [South Fork Research](http://www.southforkresearch.org/) and members of the [Fluvial Habitats Center](http://etal.joewheaton.org/a/joewheaton.org/et-al/) at Utah State University.
 
-## Developing on windows
+## Developing on Windows OR OSX
+
+Make sure the `RS_DEBUG=true` is set in QGIS Environment
 
+## Developing on windows
 
 1. Make a batch file on your desktop to launch VSCode with the QGIS development paths and environment
 
@@ -96,6 +99,19 @@ Launching the Qt designer:
 $QGIS_PATH/Contents/MacOS/bin/designer 
 ```
 
+## `rsxml` dependency
+
+This plugin uses the `rsxml` library to parse and manipulate Riverscapes XML files. This library is available on PyPi butso you need to install it manually as a wheel so that the plugin can use it. You can install it using the following command:
+
+```bash
+sh ./scripts/install_deps.sh
+```
+
+THis is just running the following command:
+
+```bash
+$QGIS_PATH_PYTHON_PATH/pip3 wheel rsxml==2.0.1 -w ./wheels --no-deps
+```
 
 ## Development resources
 
@@ -104,13 +120,49 @@ $QGIS_PATH/Contents/MacOS/bin/designer
 * [Qt for Python](https://doc.qt.io/qtforpython-5/) - Qt is a C++ library so you need to specify the Python docs. This is where you find help with things like QtGui and QtWidgets
 
 
+## Buildsing the UI files
+
+```
+pyuic5 -x input.ui -o output.py
+```
 
 ## License
 
 Licensed under the [GNU General Public License Version 3](https://github.com/Riverscapes/RiverscapesToolbar/blob/master/LICENSE).
 
 ## QT Designer
 
+### Installing `pb_tool`
+
+First make sure that pb_tool is installed (note that you may need to adjust your QGIS paths in the commands below )
+
+```
+/Applications/QGIS-LTR.app/Contents/MacOS/bin/pip3 install pb_tool
+```
+
+### Running `pb_tool` compile
+
+You just need to run `pb_tool compile` from the installed QGIS python environment. Make sure you're in the repo root for QRavePlugin when you do that
+
+pb_tool compile will do 2 things:
+
+1. It will run pyrcc5 on the `src/resources.qrc` file and compile it to a python file in the `src` directory
+2. It will run pyuic5 on the `src/ui/*.ui` files and compile them to python files in the `src/ui` directory
+
+```bash
+> /Applications/QGIS-LTR.app/Contents/MacOS/bin/pb_tool compile     
+Skipping ./src/ui/dock_widget.ui (unchanged)
+Skipping ./src/ui/meta_widget.ui (unchanged)
+Skipping ./src/ui/meta_widget.ui (unchanged)
+Skipping ./src/ui/about_dialog.ui (unchanged)
+Skipping ./src/ui/options_dialog.ui (unchanged)
+Compiling ./src/ui/project_upload_dialog.ui to ./src/ui/project_upload_dialog.py
+Compiled 1 UI files
+Compiling ./src/resources.qrc to ./src/resources.py
+Compiled 1 resource files
+```
+
+
 On MacOS
 
 `/Applications/QGIS.app/Contents/MacOS/bin/designer`
@@ -124,3 +176,9 @@ On MacOS
 1. Drop a breakpoint.
 1. Cause the breakpoint to fire. VSCode should pause at the breakpoint.
 
+```
+https://github.com/planetfederal/qgis-connect-plugin/blob/885773aa0bed618f85bd15d4c67ccbbcf9bee64c/boundlessconnect/gui/connectdockwidget.py#L430
+```
+
+
+

Workspaces/OSXDev.code-workspace

@@ -12,12 +12,23 @@
 			// "editor.background": "#1c2c2a"
 		},
 		"terminal.integrated.env.osx": {
-			"PYTHONPATH": "${env:QGIS_PATH}/Contents/Resources/python:${env:QGIS_PATH}/Contents/Resources/python/site-packages:${env:QGIS_PATH}/Contents/Resources/python/site-packages/PyQt5",
+			"PYTHONPATH": "${env:QGIS_PATH}/Contents/Resources/python:${env:QGIS_PATH}/Contents/Resources/python/site-packages:${env:QGIS_PATH}/Contents/Resources/python/site-packages/PyQt5:${workspaceFolder}/wheels",
 			"PATH": "${env:PATH}:${env:QGIS_PATH}/Contents/MacOS/bin"
 		},
-		// NOTE: For this to work you need an env file with "QGIS_PATH=/Applications/QGIS-LTR.app/Contents" or whatever your path is
-		"python.pythonPath": "${env:QGIS_PATH}/Contents/MacOS/bin/python3.8",
-	},
+    "terminal.integrated.defaultProfile.linux": "zsh",
+    "[python]": {
+      "editor.tabSize": 4,
+      "editor.formatOnSave": true,
+    },
+    "autopep8.args": [
+      "--max-line-length=240",
+    ],
+    "pylint.args": [
+      "--extension-pkg-whitelist=pygeoprocessing",
+      "--disable=C0301,C0114,C0103,W0719,W0718",
+      "--max-line-length=240"
+    ],
+  },
 	"launch": {
 		"configurations": [],
 		"compounds": []

__version__.py

@@ -1 +1 @@
-__version__ = "0.9.1"
+__version__ = "0.9.2"

config.json

@@ -20,6 +20,15 @@
         "webUrl": "https://viewer.riverscapes.net",
         "issueUrl": "https://github.com/Riverscapes/QRAVEPlugin/issues",
         "changelogUrl": "https://github.com/Riverscapes/QRAVEPlugin/releases",
-        "resourcesUrl": "https://xml.riverscapes.net/"
+        "resourcesUrl": "https://xml.riverscapes.net/",
+        "DE_API_URL": "https://api.data.riverscapes.net",
+        "DE_API_AUTH": {
+          "audience": "https://api.riverscapes.net",
+          "domain": "auth.riverscapes.net",
+          "clientId": "pH1ADlGVi69rMozJS1cixkuL5DMVLhKC",
+          "scope": "openid",
+          "success_url": "https://data.riverscapes.net/login_success",
+          "port": 4721
+        }
     }
 }