Merge pull request #51 from eodms-sgdot/development

Development

Author: keballantyne

.gitignore

@@ -60,3 +60,8 @@ _changes.md
 _copyright_check.txt
 *.geojson
 v3_ideas.md
+results/
+log/
+*.bat
+*.ps1
+*.code-workspace

README.md

@@ -1,15 +1,15 @@
-EODMS Command-line Interface
+EODMS Command-line Interface (EODMS-CLI)
 ============================
 
 ## Overview
 
-The **eodms_cli.py** script is used to search, order and download imagery from the EODMS using the REST API (RAPI) service.
+The **EODMS-CLI** script is used to search, order and download imagery from the EODMS using the REST API (RAPI) service.
 
 ## Requirements
 
 ### Python
 
-The eodms_cli.py was designed using **Python 3.7** however it has been tested successfully in Python 3.6.10. Using a version prior to Python 3.6 is not recommended as the script will not work properly.
+The EODMS-CLI was designed using **Python 3.7** however it has been tested successfully in Python 3.6.10. Using a version prior to Python 3.6 is not recommended as the script will not work properly.
 
 ### Python Packages
 
@@ -30,26 +30,18 @@ The eodms_cli.py was designed using **Python 3.7** however it has been tested su
 
 1. Clone the repository:
 
-	```dos
+	```bash
 	> git clone https://github.com/eodms-sgdot/eodms-cli.git
 	```
 
 2. Install required packages (GDAL not included):
 
-	```dos
+	```bash
 	> cd eodms-cli
 	> pip install -r requirements.txt
 	```
 
-3. Either
-
-- run the batch file and enter values when prompted:
-	
-	```dos
-	> eodms_cli.bat
-	```
-	
-- run the script using Python
+3. Run the script using Python
 
 	```bash
 	> python eodms_cli.py
@@ -72,6 +64,55 @@ In the config file, you can:
 
 For more in-depth information on the configuration file, visit [Config File](https://github.com/eodms-sgdot/eodms-cli/wiki/Config-File).
 
+## Updating
+
+### Update py-eodms-rapi
+
+If you receive one of these messages when running the eodms-cli, follow the instructions and run `pip install py-eodms-rapi -U`.
+
+```bash
+**** WARNING ****
+The py-eodms-rapi currently installed is not the latest version. 
+It is recommended to use the latest version of the package. Please
+install it using: 'pip install py-eodms-rapi -U'.
+*****************
+```
+
+or
+
+```bash
+**** ERROR ****
+The py-eodms-rapi currently installed is an older version than the
+minimum required version. Please install it using: 'pip
+install py-eodms-rapi -U'.
+*****************
+```
+
+### Update eodms-cli
+
+If you need to update the eodms-cli to a new release, follow these steps:
+
+1. Pull from the most recent Github repository
+
+	```bash
+	> cd eodms-cli  # your eodms-cli repository file location
+	> git pull origin main
+	```
+
+2. Install required packages (GDAL not included):
+
+	```bash
+	> cd eodms-cli
+	> pip install -r requirements.txt
+	> pip install py-eodms-rapi -U  # get the latest py-eodms-rapi for best functionality
+	```
+	
+3. Run the script using Python
+
+	```bash
+	> python eodms_cli.py
+	```
+
 ## User Guide
 
 For the full instructions on using the eodms_orderdownload script, please visit the [Wiki](https://github.com/eodms-sgdot/eodms-cli/wiki).
@@ -85,7 +126,7 @@ If you have any questions or require support, please contact the EODMS Support T
 MIT License
 
 Copyright (c) His Majesty the King in Right of Canada, as 
-represented by the Minister of Natural Resources, 2023
+represented by the Minister of Natural Resources, 2024
 
 Permission is hereby granted, free of charge, to any person obtaining a 
 copy of this software and associated documentation files (the "Software"), 

eodms_cli.bat

@@ -1,7 +1,7 @@
 ##############################################################################
 #
 # Copyright (c) His Majesty the King in Right of Canada, as
-# represented by the Minister of Natural Resources, 2023
+# represented by the Minister of Natural Resources, 2024
 # 
 # Licensed under the MIT license
 # (see LICENSE or <http://opensource.org/licenses/MIT>) All files in the 
@@ -13,11 +13,11 @@
 __title__ = 'EODMS-CLI'
 __author__ = 'Kevin Ballantyne'
 __copyright__ = 'Copyright (c) His Majesty the King in Right of Canada, ' \
-                'as represented by the Minister of Natural Resources, 2023'
+                'as represented by the Minister of Natural Resources, 2024'
 __license__ = 'MIT License'
 __description__ = 'Script used to search, order and download imagery from ' \
                   'the EODMS using the REST API (RAPI) service.'
-__version__ = '3.4.2'
+__version__ = '3.5.0'
 __maintainer__ = 'Kevin Ballantyne'
 __email__ = 'eodms-sgdot@nrcan-rncan.gc.ca'
 
@@ -84,7 +84,7 @@
                 }
             }
 
-min_rapi_version = '1.5.0'
+min_rapi_version = '1.7.0'
 
 class Prompter:
     """
@@ -104,6 +104,7 @@ def __init__(self, eod, config_util, params, in_click, testing=False):
         """
 
         self.eod = eod
+        self.eod.set_prompter(self)
         self.reset_col = eod.get_colour(reset=True)
         self.config_util = config_util
         self.config_info = config_util.get_info()
@@ -1105,9 +1106,9 @@ def print_syntax(self):
         """
 
         print("\nUse this command-line syntax to run the same parameters:")
-        cli_syntax = self.build_syntax()
-        print(f"{self.eod.path_colour}{cli_syntax}{self.eod.reset_colour}")
-        self.logger.info(f"Command-line Syntax: {cli_syntax}")
+        self.cli_syntax = self.build_syntax()
+        print(f"{self.eod.path_colour}{self.cli_syntax}{self.eod.reset_colour}")
+        self.logger.info(f"Command-line Syntax: {self.cli_syntax}")
 
     def prompt(self):
         """
@@ -1695,7 +1696,7 @@ def cli(username, password, input_val, collections, process, filters, dates,
         print(f"\n  {__title__}, version {__version__}\n")
         eod_util.EodmsProcess().exit_cli()
 
-    conf_util = config_util.ConfigUtils()
+    conf_util = config_util.ConfigUtils(eod_util.EodmsProcess())
 
     if configure:
         conf_util.ask_user(configure)

eodms_cli.code-workspace

@@ -1,4 +1,4 @@
-py-eodms-rapi>=1.5.0
+py-eodms-rapi>=1.7.0
 requests>=2.23.0
 dateparser>=1.0.0
 geomet>=0.3.0

eodms_cli.py

@@ -20,13 +20,14 @@
 
 class ConfigUtils:
 
-    def __init__(self):
+    def __init__(self, eod=None):
         # Set the configuration filepath
         old_config_fn = os.path.join(os.sep, os.path.expanduser('~'), '.eodms',
                                       'eodmscli_config.ini')
 
         self.config_fn = os.path.join(os.sep, os.path.expanduser('~'), '.eodms',
                                       'config.ini')
+        self.eod = eod
 
         if os.path.exists(old_config_fn):
             os.rename(old_config_fn, self.config_fn)

requirements.txt

@@ -210,7 +210,7 @@ def add_field(self, **kwargs):
     #                        rapi_title='Spatial Resolution',
     #                        ui_label='Pixel Spacing (Metres)')
 
-    def get_eod_fieldnames(self, sort=False):
+    def get_eod_fieldnames(self, sort=False, lowered=False):
         """
         Gets the list of EOD fieldnames.
 
@@ -219,9 +219,15 @@ def get_eod_fieldnames(self, sort=False):
         """
 
         if sort:
-            return sorted([f.get_eod_name() for f in self.fields])
+            if lowered:
+                return sorted([f.get_eod_name().lower() for f in self.fields])
+            else:
+                return sorted([f.get_eod_name() for f in self.fields])
         else:
-            return [f.get_eod_name() for f in self.fields]
+            if lowered:
+                return [f.get_eod_name().lower() for f in self.fields]
+            else:
+                return [f.get_eod_name() for f in self.fields]
 
     def get_field(self, eod_name):
         """