Gmail_Create_GitHub_issue_on_specific_email.ipynb

Kernel: Python 3

Gmail - Create GitHub issue on specific email

Give Feedback | Bug report

Tags: #gmail #github #email #issue #create #python

Author: Florent Ravenel

Last update: 2023-05-18 (Created: 2023-05-17)

Description: This notebook will show how to create a GitHub issue from a specific email using Gmail and Python. It is usefull for organizations that need to track emails and create issues from them.

References:

• Gmail API

• GitHub API

Input

Import librairies

import naas
from naas_drivers import email
from re import search
import pandas as pd
import requests

Setup Variables

Create an application password following this procedure

• username: This variable stores the username or email address associated with the email account

• password: This variable stores the password or authentication token required to access the email account

• smtp_server: This variable represents the SMTP server address used for sending emails.

• box: This variable stores the name or identifier of the mailbox or folder within the email account that will be accessed.

• keywords: This variable stores the keywords to be searched in email text.

• cron: CRON to be set to schedule your notebook. More info here

• github_token: GitHub token

• repository_url: GitHub HTML repository URL

• assignees: GitHub assignees

• labels: GitHub labels

# Inputs
username = "xxxxx@xxxx"
password = naas.secret.get("GMAIL_APP_PASSWORD") or "xxxxxxxx"
smtp_server = "imap.gmail.com"
box = "INBOX"
keywords = "xxxx"

# Outputs
cron = "0 8,20 * * *" #everyday at 8AM and 8PM
github_token = naas.secret.get('GITHUB_TOKEN')
repository_url = "https://github.com/xxxxxxx"
assignees = []
labels = []

Model

Get email list

emails = email.connect(username, password, smtp_server=smtp_server)
df_emails = emails.get()
print(f"✅ Emails fetched:", len(df_emails))
df_emails.head(1)

Find emails matching criteria on subject and text

def find_match(df, keywords):
    # Init
    df_match = pd.DataFrame()
    
    # Loop
    for index, row in df.iterrows():
        tmp_df = pd.DataFrame()
        uid = row["uid"]
        subject = row["subject"]
        text = row["text"]
        
        # Check keywords on subject and text
        if search(keywords, subject):
            tmp_df = df[index:index+1]
        elif search(keywords, text):
            tmp_df = df[index:index+1]
        if len(tmp_df) > 0:
            df_match = pd.concat([df_match, tmp_df])
    return df_match.reset_index(drop=True)
    
df_match = find_match(df_emails, keywords)
print("✅ Rows fetched:", len(df_match))
df_match.head(1)

Output

Create GitHub issue and delete email

def create_new_github_issue(
    token,
    repository_url,
    subject,
    text,
    assignees,
    labels,
):
    # Init
    title = subject.replace("Fwd:", "")
    body = text
    
    # Requests
    owner = repository_url.split("github.com/")[-1].split("/")[0]
    repo_name = repository_url.split(f"/{owner}/")[-1].split("/")[0]
    url = f"https://api.github.com/repos/{owner}/{repo_name}/issues"
    data = {
        "title": title,
        "body": body,
        "assignees": assignees,
        "labels": labels,
    }
    headers = {'Authorization': f'token {token}'}
    response = requests.post(url, headers=headers, json=data)
    github_issue = response.json()
    print(f"✅ Github issue created:", f"https://github.com/{owner}/{repo_name}/issues/{github_issue.get('number')}")
    return github_issue

if len(df_match) > 0:
    for index, row in df_match.iterrows():
        uid = row["uid"]
        subject = row["subject"]
        text = row["text"]
        create_new_github_issue(
            github_token,
            repository_url,
            subject,
            text,
            assignees,
            labels
        )
        emails.set_flag(uid, name="DELETED")
        print("✅ Email deleted from mailbox")

Add scheduler

naas.scheduler.add(cron=cron)