Merge pull request #242 from PASTA-ELN/sb_improveDocumenationAndUserP…

…rompts

User prompt improvements

docs/source/install.rst

@@ -12,10 +12,14 @@ Install python via Anaconda and then PASTA-ELN
 If you do not have Python installed, we recommend using Anaconda.
 1. Go to https://www.anaconda.com/download
 2. Download installer and run install. Accept all defaults
-3. Create environment, e.g. PASTA-ELN
-4. Open environment in command-prompt
+3. Create environment, e.g. PASTA-ELN and choose to install it with "Python 3.11..."
+4. Click on new green arrow button and open "Terminal"
 5. "pip install pasta-eln"
-6. "python -m pasta_eln.gui"
+6. "pip install pasta-eln -U --no-dependencies"
+
+    - if it complains about 'aiohttp' missing "pip install aiohttp"
+
+7. "python -m pasta_eln.gui" (make sure that you have administrator rights)
 
 
 Manual installation

pasta_eln/GUI/configSetupWindows.py

@@ -1,5 +1,5 @@
 """ Widget: setup tab inside the configuration dialog window """
-import logging
+import logging, os, ctypes
 from enum import Enum
 from pathlib import Path
 from typing import Callable, Any
@@ -76,12 +76,23 @@ def execute(self, command:list[Any]) -> None:
         else:
           button = QMessageBox.question(self, "CouchDB installation", couchDBWindows)
           if button == QMessageBox.Yes:
-            res = couchdb('install')
-            flagInstalledSoftware = True
-            if len(res.split('|'))==3:
-              password=res.split('|')[1]
+            try:
+              isAdmin = os.getuid() == 0
+            except AttributeError:
+              isAdmin = ctypes.windll.shell32.IsUserAnAdmin() == 1 # type: ignore[attr-defined]
+            if not isAdmin:
+              QMessageBox.information(self,'Administrator rights required', \
+                          'You require administrator rights for your user. I exit installation now.')
+              self.mainText = self.mainText.replace('- CouchDB','- CouchDB: no admin rights' )
+              self.text1.setMarkdown(self.mainText)
+              flagContinue = False
             else:
-              logging.error('Could not retrieve password :%s',str(res))
+              res = couchdb('install')
+              flagInstalledSoftware = True
+              if len(res.split('|'))==3:
+                password=res.split('|')[1]
+              else:
+                logging.error('Could not retrieve password :%s',str(res))
           else:
             self.mainText = self.mainText.replace('- CouchDB','- CouchDB: user chose to NOT install' )
             self.text1.setMarkdown(self.mainText)
@@ -131,7 +142,7 @@ def execute(self, command:list[Any]) -> None:
 
       #If installed, restart
       if flagInstalledSoftware:
-        button = QMessageBox.information(self,'PASTA-ELN restart required', restartPastaWindows)
+        QMessageBox.information(self,'PASTA-ELN restart required', restartPastaWindows)
         restart()
 
       #Example data

pasta_eln/installationTools.py

@@ -1,4 +1,4 @@
-'''  Methods that check, repair, the local PASTA-ELN installation '''
+'''  Methods that check, repair, the local PASTA-ELN installation: no Qt-here '''
 import os, platform, sys, json, shutil, random, string, logging, uuid
 from typing import Optional, Any, Callable
 import urllib.request
@@ -114,7 +114,7 @@ def couchdb(command:str='test') -> str:
   elif command == 'install':
     if platform.system()=='Linux':
       return '**ERROR should not be called'
-    elif platform.system()=='Windows':
+    if platform.system()=='Windows':
       logging.info('CouchDB starting ...')
       url = 'https://couchdb.neighbourhood.ie/downloads/3.1.1/win/apache-couchdb-3.1.1.msi'
       path = Path.home()/'Downloads'/'apache-couchdb-3.1.1.msi'

pasta_eln/serverActions.py

@@ -343,7 +343,7 @@ def backupCouchDB(location:str='', userName:str='', password:str='') -> None:
   if location=='local':
     location = '127.0.0.1'
     if not userName:
-      userName = input('Enter username: ').strip()
+      userName = input('Enter local admin username: ').strip()
     if not password:
       password = input('Enter password: ').strip()
   elif location=='remote':
@@ -518,7 +518,7 @@ def main() -> None:
     url, administrator, password = myString.split(':')
     print("URL and credentials successfully read from keyring")
   except Exception:
-    print("Could not get credentials from keyring.")
+    print("Could not get credentials for the remote server from keyring.")
     ## URL
     url = input('Enter the URL without http and without port: ')
     if len(url)<2: