Merge pull request #24 from OSLL/5_export_sheets

issue 5 done

Author: zmm

README.md

@@ -1,4 +1,4 @@
-# GITLogger
+  # GITLogger
 
 ## Установка зависимостей
 
@@ -22,6 +22,23 @@ python3 main.py -i [-t, --token] token (github токен вместо token) [-
 ```commandline
 python3 main.py -p [-t, --token] token (github токен вместо token) [-l, --list]  list (list - строка пути к txt файлу со списком репозиториев) [-o, --out] out (out - название csv файла, в который будут помещены все логи)
 ```
+##  Получение токена для работы с Google таблицей:
+Сначала нужно создать проект на сайте  [Google Cloud](https://console.cloud.google.com/). Выбираем название проекта, жмем на кнопку "Create".
+
+Затем в меню слева нажимаем на API'S & Services, выбираем Enabled APIs & services. Затем на новой страничке сверху находим "+" с надписью ENABLE APIS AND SERVICES. В поиске находим sheet, нажимаем на кнопку enable, такое же можно сделать и для drive. Теперь приложение может общаться с помощью API Google sheets.
+
+В меню слева в API'S & Services переходим на вкладку Credentials, сверху должен быть восклицательный знак в оранжевом треугольнике, в этом сообщении нажимаем на CONFIGURE CONSENT SCREEN. Выбираем external и жмем Create. Заполняем поля со звездочками, жмем SAVE AND CONTINUE.
+
+Заходим опять в Credentials. Нажимаем сверху на "+" CREATE CREDENTIALS и выбираем Service account. На первом этапе создаем имя,;жмем continue, на втором даем себе права owner, жмем DONE.
+
+В таблице Service Accounts будет запись, нажимаем на нее. Сверху будет вкладка keys. Add key -> Create new key -> json -> create. Получаем нужный json файл.
+##  Получение table_id и sheet_id для работы с Google таблицей:
+После создания таблицы в google sheets, получаем ссылку на эту таблицу и вводим ее в любом поисковике.В получившемся запросе после строчки "d/" будет находиться table_id, после строчки "gid=" будет находиться sheet_id 
+## Экспорт таблицы в Google Sheets:
+
+``` commandline
+python3 main.py -p [-t, --token] token (github токен вместо token) [-l,--list] list (list - строка пути к txt файлу со списком репозиториев) [-o, --out] out (out - название csv файла, в который будут помещены все логи) [--google_token] token.json (файл с google токеном) [--table_id] table_id (id таблицы, указанной в url пути до таблицы) [--sheet_id] sheet_id (id конкретного листа в таблице google)
+```
 
 ## Файл со списком репозиториев:
 

export_sheets.py

@@ -0,0 +1,33 @@
+import pygsheets
+import pandas as pd
+
+INT_MASS = [{
+    "one": 1,
+    "two": 2,
+    "what?": 3
+}]
+
+def write_data_to_table(csv_path, google_token, table_id, sheet_id):
+    if google_token and sheet_id and table_id :
+        gc = pygsheets.authorize(service_file=google_token)
+        sh = gc.open_by_key(table_id)
+
+    try:
+        sh.worksheets('title', sheet_id)
+    except:
+        sh.add_worksheet(sheet_id)
+
+    wk_content = sh.worksheet_by_title(sheet_id)
+
+    if csv_path:
+        df = pd.read_csv(csv_path, delimiter=',', encoding='cp1251')
+    else:
+        df = pd.DataFrame(INT_MASS)
+
+    # Очистка существующих данных
+    wk_content.clear()
+
+    # Запись новых данных
+    wk_content.set_dataframe(df, 'A1', copy_head=True)
+
+

main.py

@@ -3,17 +3,33 @@
 import pytz
 
 import git_logger
-
+import export_sheets
 
 def parse_args():
     parser = argparse.ArgumentParser()
     parser.add_argument("-p", help="log pull requests", action="store_true")
     parser.add_argument("-i", help="log issues", action="store_true")
+    parser.add_argument("-e", help="export table to google sheets", action="store_true")
     parser.add_argument('-t', '--token', type=str, required=True, help='token github account')
     parser.add_argument('-l', '--list', type=str, required=True, help='repos names file')
     parser.add_argument('-o', '--out', type=str, required=True, help='output filename')
     parser.add_argument('-s', '--start', type=str, required=False, help='start time', default='2000/01/01-00:00:00')
     parser.add_argument('-f', '--finish', type=str, required=False, help='finish time', default='2400/01/01-00:00:00')
+    parser.add_argument('--google_token', type=str, required=False, help='Specify path to google token file')
+    parser.add_argument('--table_id', type=str, required=False,
+                        help='Specify Google sheet document id (can find in url)')
+    parser.add_argument('--sheet_id', type=str, required=False,
+                        help='Specify title for a sheet in a document in which data will be printed')
+    args = parser.parse_args()
+    
+    if args.e:
+        for action in parser._actions:
+            if action.dest == 'google_token':
+                action.required = True
+            if action.dest == 'table_id':
+                action.required = True
+            if action.dest == 'sheet_id':
+                action.required = True
     return parser.parse_args()
 
 
@@ -43,10 +59,16 @@ def main():
             finish = parse_time(args.finish.split('-'))
         if not args.p and not args.i:
             git_logger.log_commits(client, repositories, csv_name, start, finish)
+            if (args.e):
+                export_sheets.write_data_to_table(csv_name, args.google_token, args.table_id, args.sheet_id)
         if args.p:
             git_logger.log_pull_requests(client, repositories, csv_name, token, start, finish)
+            if (args.e):
+                export_sheets.write_data_to_table(csv_name, args.google_token, args.table_id, args.sheet_id)
         if args.i:
             git_logger.log_issues(client, repositories, csv_name, token, start, finish)
+            if (args.e):
+                export_sheets.write_data_to_table(csv_name, args.google_token, args.table_id, args.sheet_id)
 
 
 

requirements.txt

@@ -1,3 +1,6 @@
 PyGithub~=1.55
+pygsheets==2.0.5
+pandas==1.4.3
 pytz~=2023.3
 requests~=2.31.0
+