Docker implementation and small fixes (#59)

+ add Dockerfile and build instruction
+ add example files for `--list` flag
+ update requirements.txt for Docker
+ fix errors in invites_parser.py

Author: KonstantinKondratenko

Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.10-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
+
+COPY . /app
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+ENV GIT_PYTHON_GIT_EXECUTABLE=/usr/bin/git
+
+ENTRYPOINT ["python", "main.py"]

README.md

@@ -9,6 +9,18 @@
 pip install -r requirements.txt
 ```
 
+## Docker run
+1. Build via:  
+``` bash
+docker build -t checking_repo .
+```
+
+2. Run via:  
+``` bash
+docker run -v $(pwd)/output:/app/output checking_repo [--invites] [--commites] [--etc...] -t <insert_token> -l <insert_list> -o ./output/res.csv
+```
+
+
 ## Запуск приложения:
 1. Логирование commits
 ```commandline
@@ -32,6 +44,7 @@ python3 main.py [-w, --wikis] [-t, --token] token (github токен вмест
 ```
 
 
+
 ##  Получение токена для работы с Google таблицей:
 Сначала нужно создать проект на сайте  [Google Cloud](https://console.cloud.google.com/). Выбираем название проекта, жмем на кнопку "Create".
 

invites_parser.py

@@ -4,16 +4,17 @@
 import json
 from time import sleep
 from github import Github, Repository, GithubException, PullRequest
+import csv
 
 FIELDNAMES = ('repository name', 'invited login', 'invite creation date', 'invitation url')
 
-def log_inviter(repo, invite):
+def log_inviter(repo, invite, writer):
     invite_info = [repo.full_name, invite.invitee.login, invite.created_at.strftime("%d/%m/%Y, %H:%M:%S"), invite.html_url]
     writer.writerow(invite_info)
     print(invite_info)
 
 
-def log_invitations(client: Github, working_repos, csv_name):
+def log_invitations(client: Github, working_repos, csv_name, timedelta=1):
     with open(csv_name, 'w', newline='') as file:
         writer = csv.writer(file)
         writer.writerow(FIELDNAMES)
@@ -22,7 +23,7 @@ def log_invitations(client: Github, working_repos, csv_name):
             invitations = repo.get_pending_invitations()
             for invite in invitations:
                 try:
-                    log_inviter(repo, invite)
+                    log_inviter(repo, invite, writer)
                     sleep(timedelta)
                 except Exception as e:
                     print(e)

main.py

@@ -20,7 +20,7 @@ def parse_args():
     parser.add_argument("--forks_include", help="logging data from forks", action="store_true")
     parser.add_argument("-e", "--export_google_sheets", 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('-l', '--list', type=str, required=True, help='Path to the file containing the list of repositories. Repositories should be separated by a line break. Names should be in the format <organization or owner>/<name> ')
     parser.add_argument("--download_repos", type=str, help="path to downloaded repositories", default='./')
     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')

requirements.txt

@@ -1,6 +1,6 @@
 GitPython==3.1.41
-PyGithub~=1.55
-pygsheets==2.0.5
-pandas==1.4.3
-pytz~=2023.3
-requests~=2.31.0
+PyGithub==2.4.0
+pygsheets==2.0.6
+pandas==2.2.3
+pytz==2024.2
+requests==2.32.3