def set_Data(self, endpoint: str = "/") -> None:
'''
This method is used to set the most recent GitHub API call into self.data.\n
This data should be moved into it's own instance before this is called again in order to prevent the data from being overwritten.\n
:param endpoint: This can be "commits", "issues", "pulls", "", or some other endpoint that is supported by the GitHub API as long as it is accessible with the root url https://api.github.com/{USER}/{REPOSITORY}
'''
endpoint = endpoint.lower()
self.gha = GitHubAPI(username=self.githubUser, repository=self.githubRepo, token=self.githubToken, tokenList=self.githubTokenList)
if endpoint == "commits":
self.data = [self.gha.access_GitHubRepoCommits(), self.gha.get_ResponseHeaders()]
elif endpoint == "issues":
self.data = [self.gha.access_GitHubRepoIssues(), self.gha.get_ResponseHeaders()]
elif endpoint == "pulls":
self.data = [self.gha.access_GitHubRepoPulls(), self.gha.get_ResponseHeaders()]
elif endpoint == "":
self.data = [self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint), self.gha.get_ResponseHeaders()]
elif endpoint[0] == "/":
self.data = [self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint), self.gha.get_ResponseHeaders()]
else:
self.data = [self.gha.access_GitHubAPISpecificURL(url=endpoint), self.gha.get_ResponseHeaders()]
class Logic:
'''
This is logic to call all other classes and methods that make the program run.\n
Does very little analysis of data.
'''
def __init__(self,
username: str = None,
repository: str = None,
token: str = None,
tokenList: list = None,
cursor: Cursor = None,
connection: Connection = None) -> None:
'''
Initalizes the class and sets class variables that are to be used only in this class instance.\n
:param username: The GitHub username.\n
:param repository: The GitHub repository.\n
:param token: The personal access token from the user who initiated the program.
:param tokenList: A list of tokens that will be iterated through.\n
:param data: The dictionary of data that is returned from the API call.\n
:param responseHeaders: The dictionary of data that is returned with the API call.\n
:param cursor: The database cursor.\n
:param connection: The database connection.
'''
self.githubUser = username
self.githubRepo = repository
self.githubToken = token
self.githubTokenList = tokenList
self.dbCursor = cursor
self.dbConnection = connection
self.data = None
self.gha = None
def program(self) -> None:
'''
Calls classes and methods to analyze and interpret data.
Computing and inserting calculations into the calculations table.
'''
# Gets and stores data from the root api endpoint
self.set_Data(endpoint="") # %%
# Gets and stores data from the commits api endpoint
self.set_Data(endpoint="commits")
Commits.Logic(gha=self.gha,
data=self.data[0],
responseHeaders=self.data[1],
cursor=self.dbCursor,
connection=self.dbConnection).parser()
# get all the times from the commits table
self.dbCursor.execute("SELECT committer_date FROM COMMITS;")
date_rows = self.dbCursor.fetchall()
# calculate average time between commit
total_times = []
total_time_differences = []
for row in date_rows:
date = datetime.strptime(row[0], "%Y-%m-%d %H:%M:%S")
total_times.append(date)
# only if the list is greater than two
if len(total_times) >= 2:
for t in range(len(total_times) - 1):
time_difference = abs(total_times[t] - total_times[t + 1])
total_time_differences.append(time_difference.total_seconds())
value = str(
sum(total_time_differences) / len(total_time_differences))
else:
value = "N/A"
# average time between commits
calc_name = "Average Time Between Commits (secs)"
# Stores the data into a SQL database
sql = "INSERT INTO COMMITS_CALCULATIONS (calc_name, value) VALUES (?,?);"
self.dbCursor.execute(
sql,
(str(calc_name), str(value)),
)
self.dbConnection.commit()
def generate_DateTimeList(self, rCDT: datetime) -> list:
'''
Creates a list of datetimes from the repository conception datetime till today's current datetime.\n
:param rCDT: Repository conception datetime. This is found in the root api call of a repository.
'''
dates_in_specific_format = []
today = datetime.today()
if rCDT.strftime("%Y-%m-%d") == today.strftime("%Y-%m-%d"):
dates_in_specific_format.append(str(today))
else:
dates_in_specific_format.append(str(today))
while (today > rCDT):
today = today - timedelta(days=1)
dates_in_specific_format.append(str(today))
return dates_in_specific_format
def get_Data(self) -> dict:
'''
Returns the class variable data.
'''
return self.data
def get_DbConnection(self) -> Connection:
'''
Returns the class variable dbConnection.
'''
return self.dbConnection
def get_DbCursor(self) -> Cursor:
'''
Returns the class variable dbCursor.
'''
return self.dbCursor
def get_GitHubRepo(self) -> str:
'''
Returns the class variable githubRepo.
'''
return self.githubRepo
def get_GitHubToken(self) -> str:
'''
Returns the class variable githubToken.
'''
return self.githubToken
def get_GitHubUser(self) -> str:
'''
Returns the class variable githubUser.
'''
return self.githubUser
def set_Data(self, endpoint: str = "/") -> None:
'''
This method is used to set the most recent GitHub API call into self.data.\n
This data should be moved into it's own instance before this is called again in order to prevent the data from being overwritten.\n
:param endpoint: This can be "commits", "issues", "pulls", "", or some other endpoint that is supported by the GitHub API as long as it is accessible with the root url https://api.github.com/{USER}/{REPOSITORY}
'''
endpoint = endpoint.lower()
self.gha = GitHubAPI(username=self.githubUser,
repository=self.githubRepo,
token=self.githubToken,
tokenList=self.githubTokenList)
if endpoint == "commits":
self.data = [
self.gha.access_GitHubRepoCommits(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "issues":
self.data = [
self.gha.access_GitHubRepoIssues(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "pulls":
self.data = [
self.gha.access_GitHubRepoPulls(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "":
self.data = [
self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint),
self.gha.get_ResponseHeaders()
]
elif endpoint[0] == "/":
self.data = [
self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint),
self.gha.get_ResponseHeaders()
]
else:
self.data = [
self.gha.access_GitHubAPISpecificURL(url=endpoint),
self.gha.get_ResponseHeaders()
]
class Logic:
'''
This is logic to call all other classes and methods that make the program run.\n
Does very little analysis of data.
'''
def __init__(self, username: str=None, repository:str=None, token:str=None, tokenList:list=None, cursor:Cursor=None, connection:Connection=None) -> None:
'''
Initalizes the class and sets class variables that are to be used only in this class instance.\n
:param username: The GitHub username.\n
:param repository: The GitHub repository.\n
:param token: The personal access token from the user who initiated the program.
:param tokenList: A list of tokens that will be iterated through.\n
:param data: The dictionary of data that is returned from the API call.\n
:param responseHeaders: The dictionary of data that is returned with the API call.\n
:param cursor: The database cursor.\n
:param connection: The database connection.
'''
self.githubUser = username
self.githubRepo = repository
self.githubToken = token
self.githubTokenList = tokenList
self.dbCursor = cursor
self.dbConnection = connection
self.data = None
self.gha = None
def program(self) -> None:
'''
Calls classes and methods to analyze and interpret data.
'''
# Gets and stores data from the root api endpoint
self.set_Data(endpoint="")
repoConcptionDateTime = datetime.strptime(self.data[0]['created_at'].replace("T", " ").replace("Z", ""), "%Y-%m-%d %H:%M:%S")
# Index 0 = Current datetime, Index -1 = conception datetime
datetimeList = self.generate_DateTimeList(rCDT=repoConcptionDateTime)
# Gets and stores data from the commits api endpoint
self.set_Data(endpoint="commits")
Commits.Logic(gha=self.gha, data=self.data[0], responseHeaders=self.data[1],cursor=self.dbCursor, connection=self.dbConnection).parser()
# # Gets and stores data from the pulls api endpoint
# self.set_Data(endpoint="pulls")
# Pulls.Logic(gha=self.gha, data=self.data[0], responseHeaders=self.data[1],
# cursor=self.dbCursor, connection=self.dbConnection).parser()
# # Gets and stores data from the issues api endpoint
# self.set_Data(endpoint="issues")
# Issues.Logic(gha=self.gha, data=self.data[0], responseHeaders=self.data[1],
# cursor=self.dbCursor, connection=self.dbConnection).parser()
# Lines_Of_Code_And_Num_Of_Chars.Main(username, repository)
# Adds all of the datetimes to the SQL database
# Bewary of changing
for foo in datetimeList:
self.dbCursor.execute(
"SELECT COUNT(*) FROM COMMITS WHERE date(committer_date) <= date('" + foo + "');")
rows = self.dbCursor.fetchall()
commits = rows[0][0]
# self.dbCursor.execute(
# "SELECT COUNT(*) FROM ISSUES WHERE date(created_at) <= date('" + foo + "');")
# rows = self.dbCursor.fetchall()
# issues = rows[0][0]
# self.dbCursor.execute(
# "SELECT COUNT(*) FROM PULLREQUESTS WHERE date(created_at) <= date('" + foo + "');")
# rows = self.dbCursor.fetchall()
# pull_requests = rows[0][0]
# sql = "INSERT INTO MASTER (date, commits, issues, pull_requests) VALUES (?,?,?,?);"
sql = "INSERT INTO MASTER (date, commits) VALUES (?,?);"
self.dbCursor.execute(
sql, (foo, str(commits)))
self.dbConnection.commit()
def generate_DateTimeList(self, rCDT: datetime) -> list:
'''
Creates a list of datetimes from the repository conception datetime till today's current datetime.\n
:param rCDT: Repository conception datetime. This is found in the root api call of a repository.
'''
foo = []
today = datetime.today()
if rCDT.strftime("%Y-%m-%d") == today.strftime("%Y-%m-%d"):
foo.append(str(today))
else:
foo.append(str(today))
while (today > rCDT):
today = today - timedelta(days=1)
foo.append(str(today))
return foo
def get_Data(self) -> dict:
'''
Returns the class variable data.
'''
return self.data
def get_DbConnection(self) -> Connection:
'''
Returns the class variable dbConnection.
'''
return self.dbConnection
def get_DbCursor(self) -> Cursor:
'''
Returns the class variable dbCursor.
'''
return self.dbCursor
def get_GitHubRepo(self) -> str:
'''
Returns the class variable githubRepo.
'''
return self.githubRepo
def get_GitHubToken(self) -> str:
'''
Returns the class variable githubToken.
'''
return self.githubToken
def get_GitHubUser(self) -> str:
'''
Returns the class variable githubUser.
'''
return self.githubUser
def set_Data(self, endpoint: str = "/") -> None:
'''
This method is used to set the most recent GitHub API call into self.data.\n
This data should be moved into it's own instance before this is called again in order to prevent the data from being overwritten.\n
:param endpoint: This can be "commits", "issues", "pulls", "", or some other endpoint that is supported by the GitHub API as long as it is accessible with the root url https://api.github.com/{USER}/{REPOSITORY}
'''
endpoint = endpoint.lower()
self.gha = GitHubAPI(username=self.githubUser, repository=self.githubRepo, token=self.githubToken, tokenList=self.githubTokenList)
if endpoint == "commits":
self.data = [self.gha.access_GitHubRepoCommits(), self.gha.get_ResponseHeaders()]
elif endpoint == "issues":
self.data = [self.gha.access_GitHubRepoIssues(), self.gha.get_ResponseHeaders()]
elif endpoint == "pulls":
self.data = [self.gha.access_GitHubRepoPulls(), self.gha.get_ResponseHeaders()]
elif endpoint == "":
self.data = [self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint), self.gha.get_ResponseHeaders()]
elif endpoint[0] == "/":
self.data = [self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint), self.gha.get_ResponseHeaders()]
else:
self.data = [self.gha.access_GitHubAPISpecificURL(url=endpoint), self.gha.get_ResponseHeaders()]
class Logic:
'''
This is logic to call all other classes and methods that make the program run.\n
Does very little analysis of data.
'''
def __init__(self,
username: str = None,
repository: str = None,
token: str = None,
tokenList: list = None,
cursor: Cursor = None,
connection: Connection = None) -> None:
'''
Initalizes the class and sets class variables that are to be used only in this class instance.\n
:param username: The GitHub username.\n
:param repository: The GitHub repository.\n
:param token: The personal access token from the user who initiated the program.
:param tokenList: A list of tokens that will be iterated through.\n
:param data: The dictionary of data that is returned from the API call.\n
:param responseHeaders: The dictionary of data that is returned with the API call.\n
:param cursor: The database cursor.\n
:param connection: The database connection.
'''
self.githubUser = username
self.githubRepo = repository
self.githubToken = token
self.githubTokenList = tokenList
self.dbCursor = cursor
self.dbConnection = connection
self.data = None
self.gha = None
def program(self) -> None:
'''
Calls classes and methods to analyze and interpret data.
Computing and inserting calculations into the calculations table.
'''
# Gets and stores data from the root api endpoint
self.set_Data(endpoint="") # %%
# Gets and stores data from the commits api endpoint
self.set_Data(endpoint="commits")
Commits.Logic(gha=self.gha,
data=self.data[0],
responseHeaders=self.data[1],
cursor=self.dbCursor,
connection=self.dbConnection).parser()
cc = CommitsCalculations.CommitsCalculations(self.dbCursor,
self.dbConnection)
cc.calc_average_time_between_commits()
cc.calc_commits_per_hour()
def generate_DateTimeList(self, rCDT: datetime) -> list:
'''
Creates a list of datetimes from the repository conception datetime till today's current datetime.\n
:param rCDT: Repository conception datetime. This is found in the root api call of a repository.
'''
dates_in_specific_format = []
today = datetime.today()
if rCDT.strftime("%Y-%m-%d") == today.strftime("%Y-%m-%d"):
dates_in_specific_format.append(str(today))
else:
dates_in_specific_format.append(str(today))
while (today > rCDT):
today = today - timedelta(days=1)
dates_in_specific_format.append(str(today))
return dates_in_specific_format
def get_Data(self) -> dict:
'''
Returns the class variable data.
'''
return self.data
def get_DbConnection(self) -> Connection:
'''
Returns the class variable dbConnection.
'''
return self.dbConnection
def get_DbCursor(self) -> Cursor:
'''
Returns the class variable dbCursor.
'''
return self.dbCursor
def get_GitHubRepo(self) -> str:
'''
Returns the class variable githubRepo.
'''
return self.githubRepo
def get_GitHubToken(self) -> str:
'''
Returns the class variable githubToken.
'''
return self.githubToken
def get_GitHubUser(self) -> str:
'''
Returns the class variable githubUser.
'''
return self.githubUser
def set_Data(self, endpoint: str = "/") -> None:
'''
This method is used to set the most recent GitHub API call into self.data.\n
This data should be moved into it's own instance before this is called again in order to prevent the data from being overwritten.\n
:param endpoint: This can be "commits", "issues", "pulls", "", or some other endpoint that is supported by the GitHub API as long as it is accessible with the root url https://api.github.com/{USER}/{REPOSITORY}
'''
endpoint = endpoint.lower()
self.gha = GitHubAPI(username=self.githubUser,
repository=self.githubRepo,
token=self.githubToken,
tokenList=self.githubTokenList)
if endpoint == "commits":
self.data = [
self.gha.access_GitHubRepoCommits(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "issues":
self.data = [
self.gha.access_GitHubRepoIssues(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "pulls":
self.data = [
self.gha.access_GitHubRepoPulls(),
self.gha.get_ResponseHeaders()
]
elif endpoint == "":
self.data = [
self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint),
self.gha.get_ResponseHeaders()
]
elif endpoint[0] == "/":
self.data = [
self.gha.access_GitHubAPISpecificEndpoint(endpoint=endpoint),
self.gha.get_ResponseHeaders()
]
else:
self.data = [
self.gha.access_GitHubAPISpecificURL(url=endpoint),
self.gha.get_ResponseHeaders()
]