Skip to content

Commit 22f04b4

Browse files
committed
Update colum names and spreadsheets
1 parent 614e4b7 commit 22f04b4

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

github_analytics/github/traffic.py

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ def get_traffic_referrers(self, repo: str) -> pd.DataFrame:
7575
LOGGER.info(f'Fetching traffic referrers for {repo}.')
7676
data = self._get_traffic_data(repo, 'popular/referrers')
7777
df = pd.DataFrame(data, columns=['referrer', 'count', 'uniques'])
78+
df.rename(
79+
columns={'referrer': 'site', 'count': 'views', 'uniques': 'unique_visitors'},
80+
inplace=True
81+
)
7882
LOGGER.info(f'Retrieved {len(df)} referrer records for {repo}.')
7983
return df
8084

@@ -95,6 +99,10 @@ def get_traffic_paths(self, repo: str) -> pd.DataFrame:
9599
LOGGER.info(f'Fetching traffic paths for {repo}.')
96100
data = self._get_traffic_data(repo, 'popular/paths')
97101
df = pd.DataFrame(data, columns=['path', 'title', 'count', 'uniques'])
102+
df.rename(
103+
columns={'path': 'content', 'count': 'views', 'uniques': 'unique_visitors'},
104+
inplace=True
105+
)
98106
LOGGER.info(f'Retrieved {len(df)} path records for {repo}.')
99107
return df
100108

@@ -113,7 +121,10 @@ def get_traffic_views(self, repo: str) -> pd.DataFrame:
113121
- `uniques`: Number of unique visitors.
114122
"""
115123
data = self._get_traffic_data(repo, 'views')
116-
return pd.DataFrame(data['views'], columns=['timestamp', 'count', 'uniques'])
124+
df = pd.DataFrame(data['views'], columns=['timestamp', 'count', 'uniques'])
125+
df.rename(columns={'count': 'views', 'uniques': 'unique_visitors'}, inplace=True)
126+
LOGGER.info(f'Retrieved {len(df)} views for {repo}.')
127+
return df
117128

118129
def get_traffic_clones(self, repo: str) -> pd.DataFrame:
119130
"""Fetches the number of repository clones over time.
@@ -130,14 +141,18 @@ def get_traffic_clones(self, repo: str) -> pd.DataFrame:
130141
- `uniques`: Number of unique cloners.
131142
"""
132143
data = self._get_traffic_data(repo, 'clones')
133-
return pd.DataFrame(data['clones'], columns=['timestamp', 'count', 'uniques'])
144+
df = pd.DataFrame(data['clones'], columns=['timestamp', 'count', 'uniques'])
145+
df.rename(columns={'count': 'clones', 'uniques': 'unique_cloners'}, inplace=True)
146+
LOGGER.info(f'Retrieved {len(df)} clones for {repo}.')
147+
return df
134148

135149
def generate_timeframe(cls, traffic_data):
136150
"""Generates a timeframe DataFrame with the start and end timestamps from traffic data.
137151
138152
Args:
139153
traffic_data (dict[str, pd.DataFrame]):
140-
Dictionary containing traffic data, including "Traffic Views" and "Traffic Clones".
154+
Dictionary containing traffic data, including "Traffic Visitors" and
155+
"Traffic Git Clones".
141156
142157
Returns:
143158
pd.DataFrame:
@@ -147,11 +162,11 @@ def generate_timeframe(cls, traffic_data):
147162
end_date = None
148163
all_timestamps = []
149164

150-
if 'Traffic Views' in traffic_data and not traffic_data['Traffic Views'].empty:
151-
all_timestamps.extend(traffic_data['Traffic Views']['timestamp'].tolist())
165+
if 'Traffic Visitors' in traffic_data and not traffic_data['Traffic Visitors'].empty:
166+
all_timestamps.extend(traffic_data['Traffic Visitors']['timestamp'].tolist())
152167

153-
if 'Traffic Clones' in traffic_data and not traffic_data['Traffic Clones'].empty:
154-
all_timestamps.extend(traffic_data['Traffic Clones']['timestamp'].tolist())
168+
if 'Traffic Git Clones' in traffic_data and not traffic_data['Traffic Git Clones'].empty:
169+
all_timestamps.extend(traffic_data['Traffic Git Clones']['timestamp'].tolist())
155170

156171
if all_timestamps:
157172
start_date = min(all_timestamps)
@@ -175,10 +190,10 @@ def get_all_traffic(self, repo: str) -> dict[str, pd.DataFrame]:
175190
- `"clones"`: DataFrame with repository clones over time.
176191
"""
177192
traffic_data = {
178-
'Traffic Referrers': self.get_traffic_referrers(repo),
179-
'Traffic Paths': self.get_traffic_paths(repo),
180-
'Traffic Views': self.get_traffic_views(repo),
181-
'Traffic Clones': self.get_traffic_clones(repo),
193+
'Traffic Referring Sites': self.get_traffic_referrers(repo),
194+
'Traffic Popular Content': self.get_traffic_paths(repo),
195+
'Traffic Visitors': self.get_traffic_views(repo),
196+
'Traffic Git Clones': self.get_traffic_clones(repo),
182197
}
183198
traffic_data['Timeframe'] = self.generate_timeframe(traffic_data)
184199
return traffic_data

0 commit comments

Comments
 (0)