Merge pull request #746 from piyushmohan01/main

CLI tool for Timezones

Author: pawangeek

timezone_cli/README.md

@@ -0,0 +1,33 @@
+# CLI Tool for Timezones
+
+- This tool lets the user find the time pertaining to various timezones around the globe. 
+- It allows users to pass a timezone of their choice or have ten common timezone results printed. 
+- On top of that, the user can also pass two different timezones to get the comparisons.
+- The script uses the [pytz](http://pytz.sourceforge.net/) library which provides the required functionalities withing the context of python (2.4 or higher).
+
+## Setup instructions
+
+- Install libraries : ```pip install -r requirements.txt```
+- Run the script with parameters : ```python tz_tool.py [params]```
+
+## Parameter instructions
+- Here's the list of parameters that can be passed :
+    - ```--help``` : Get info about the paramters
+    - ```--cm``` : Get time of 10 common timezones
+    - ```--cu [timezone]``` : Get time of custom timezone
+    - ```--cp [timezone_1]-[timezone_2]``` : Compare differences between two timezones
+- Points to note :
+    - Always pass valid timezones (View examples below)
+    - When comparing, pass two '-' seperated timezones
+- Examples :
+    - ```python tz_tool.py --help```
+    - ```python tz_tool.py --cm```
+    - ```python tz_tool.py --cu Europe/Rome```
+    - ```python tz_tool.py --cp Asia/Kolkata-Europe/Rome```
+
+## Sample Output
+
+![](./images/markdown-sample.JPG)
+
+## Author(s)
+- [Piyush Mohan](https://github.com/piyushmohan01)

timezone_cli/images/common.JPG

@@ -0,0 +1,2 @@
+pytz==2021.3
+python-dateutil==2.8.2

timezone_cli/images/compare.JPG

@@ -0,0 +1,103 @@
+import sys
+import getopt
+from datetime import datetime
+from pytz import timezone
+from dateutil.relativedelta import relativedelta
+
+
+# --- INFO ON PARAMS ---
+def print_help():
+    print('[+] use --cu and pass custom timezone to find time.')
+    print('[+] use --cm to get the time of common timezones around the world.')
+    print('[+] use --cmp and pass two \'-\' seperated timezones to compare.')
+    print('[+] use --help again if needed.')
+    print('\n' + '-' * 50 + '\n')
+
+
+# --- GET DATETIME OF PASSED TIMEZONE ---
+def get_datetime(time_zone):
+    utcnow = timezone('utc').localize(datetime.utcnow())
+    output_datetime = utcnow.astimezone(timezone(time_zone)).replace(tzinfo=None)
+    return output_datetime
+
+
+# --- GET DATETIME OF CUSTOM TIMEZONE ---
+def get_custom_tz(time_zone):
+    response = str(get_datetime(time_zone))
+    print(f'%20s' % 'Timezone' + '  :' + ' ' * 2 + time_zone)  # noqa
+    date, time = response.split(' ')
+    hours, minutes, seconds = time.split(':')
+    print('%20s' % 'Hours' + '  :' + ' ' * 2 + hours)
+    print('%20s' % 'Minutes' + '  :' + ' ' * 2 + minutes)
+    print('%20s' % 'Seconds' + '  :' + ' ' * 2 + seconds)
+    print('%20s' % 'Date' + '  :' + ' ' * 2 + date)
+    print('\n' + '-' * 50 + '\n')
+
+
+# --- GET DATETIMES OF COMMON TIMEZONES ---
+def get_common_tz():
+    common_tz_list = [
+        'America/Sao_Paulo',
+        'America/New_York',
+        'America/Mexico_City',
+        'Asia/Kolkata',
+        'Asia/Tokyo',
+        'Europe/Paris',
+        'Europe/Berlin',
+        'Africa/Johannesburg',
+        'Africa/Casablanca',
+        'Australia/Melbourne',
+    ]
+    for item in common_tz_list:
+        print('%-20s' % item, end='')
+        print(':' + ' ' * 2 + str(get_datetime(item)))
+    print('\n' + '-' * 50 + '\n')
+
+
+# --- COMPARE DIFFERENCES BTW TWO TIMEZONES ---
+def get_comparisons(tz_1, tz_2):
+    offset = relativedelta(get_datetime(tz_1), get_datetime(tz_2))
+    print('%25s' % 'Comparing :', tz_1)
+    print('%25s' % 'With :', tz_2)
+    print('')
+    print('%25s' % 'Hours :', offset.hours)
+    print('%25s' % 'Minutes :', offset.minutes)
+    print('%25s' % 'Seconds :', offset.seconds)
+    print('\n' + '-' * 50 + '\n')
+
+
+# --- MAIN FUNCTION ---
+def Main():
+    print('\n' + '-' * 50 + '\n')
+    print(' ' * 16 + 'TIMEZONE TOOL')
+    print('\n' + '-' * 50 + '\n')
+
+    # --- SET DEFAULTS ---
+    argument_list = sys.argv[1:]
+    options = ''
+    long_options = ['cu=', 'cm', 'cp=', 'help']
+
+    # --- TRY-CATCH BLOCK FOR ARGS ---
+    try:
+        args, _ = getopt.getopt(argument_list, shortopts=options, longopts=long_options)
+        for current_argument, current_value in args:
+            if current_argument in ('--help'):
+                print_help()
+            if current_argument in ('--cu'):
+                get_custom_tz(current_value)
+            if current_argument in ('--cm'):
+                get_common_tz()
+            if current_argument in ('--cp'):
+                timezones = current_value.split('-')
+                if len(timezones) == 2:
+                    get_comparisons(timezones[0], timezones[1])
+                else:
+                    print(' ' * 5, '[+] Seperate the Timezones with \'-\'')
+                    print('\n' + '-' * 50 + '\n')
+
+    except getopt.error as error:
+        print(str(error))
+
+
+if __name__ == '__main__':
+    Main()