gitlytics 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- gitlytics-0.1.1/LICENSE +201 -0
- gitlytics-0.1.1/PKG-INFO +201 -0
- gitlytics-0.1.1/README.md +178 -0
- gitlytics-0.1.1/github_traffic/__init__.py +4 -0
- gitlytics-0.1.1/github_traffic/api.py +76 -0
- gitlytics-0.1.1/github_traffic/automation.py +122 -0
- gitlytics-0.1.1/github_traffic/cli.py +154 -0
- gitlytics-0.1.1/github_traffic/core.py +147 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/assets/axios-BATw4G7Y.js +9 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/assets/index-BJy89P_N.js +44 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/assets/index-DHekp9vT.css +1 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/favicon.svg +1 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/icons.svg +24 -0
- gitlytics-0.1.1/github_traffic/frontend/dist/index.html +14 -0
- gitlytics-0.1.1/github_traffic/frontend/node_modules/flatted/python/flatted.py +144 -0
- gitlytics-0.1.1/github_traffic/process.py +43 -0
- gitlytics-0.1.1/gitlytics.egg-info/PKG-INFO +201 -0
- gitlytics-0.1.1/gitlytics.egg-info/SOURCES.txt +25 -0
- gitlytics-0.1.1/gitlytics.egg-info/dependency_links.txt +1 -0
- gitlytics-0.1.1/gitlytics.egg-info/entry_points.txt +2 -0
- gitlytics-0.1.1/gitlytics.egg-info/requires.txt +12 -0
- gitlytics-0.1.1/gitlytics.egg-info/top_level.txt +1 -0
- gitlytics-0.1.1/pyproject.toml +43 -0
- gitlytics-0.1.1/setup.cfg +4 -0
- gitlytics-0.1.1/tests/test_automation.py +72 -0
- gitlytics-0.1.1/tests/test_cli.py +56 -0
- gitlytics-0.1.1/tests/test_core.py +55 -0
gitlytics-0.1.1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright (c) 2026 Ameya Sanjay Chopade
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
gitlytics-0.1.1/PKG-INFO
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: gitlytics
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Monitor and automate your GitHub repository traffic analytics.
|
|
5
|
+
Keywords: github,traffic,analytics,automation,cli
|
|
6
|
+
Classifier: Programming Language :: Python :: 3
|
|
7
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
8
|
+
Classifier: Operating System :: OS Independent
|
|
9
|
+
Requires-Python: >=3.9
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: requests
|
|
13
|
+
Requires-Dist: pandas
|
|
14
|
+
Requires-Dist: python-dotenv
|
|
15
|
+
Provides-Extra: dashboard
|
|
16
|
+
Requires-Dist: fastapi; extra == "dashboard"
|
|
17
|
+
Requires-Dist: uvicorn; extra == "dashboard"
|
|
18
|
+
Requires-Dist: python-multipart; extra == "dashboard"
|
|
19
|
+
Provides-Extra: dev
|
|
20
|
+
Requires-Dist: pytest>=8.0.0; extra == "dev"
|
|
21
|
+
Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
<div align="center">
|
|
25
|
+
|
|
26
|
+
# Gitlytics
|
|
27
|
+
## ๐ GitHub Traffic Monitor ๐
|
|
28
|
+
|
|
29
|
+
[](LICENSE)
|
|
30
|
+
[](https://www.python.org/)
|
|
31
|
+
[](https://pypi.org/project/gitlytics/)
|
|
32
|
+
[](https://react.dev/)
|
|
33
|
+
[](https://fastapi.tiangolo.com/)
|
|
34
|
+
|
|
35
|
+
**Beautiful GitHub traffic analytics for all your repositories โ public and private.** ๐
|
|
36
|
+
|
|
37
|
+
Please consider giving this project a โญ if you find it helpful!
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
> **โ ๏ธ NOTE: NAME AND TECH STACK UPGRADE!**
|
|
44
|
+
> This library was formerly known as `github-traffic-monitor`. We have officially rebranded to **`gitlytics`**!
|
|
45
|
+
>
|
|
46
|
+
> In addition to the name change, we have migrated away from Streamlit. The dashboard is currently a base version working on a new and better **React + Vite** architecture, powered by a **FastAPI** backend!
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
A local-only GitHub traffic analytics tool with two modes:
|
|
51
|
+
- **๐ฅ๏ธ Web UI** โ Beautiful React + FastAPI dashboard (recommended)
|
|
52
|
+
- **โจ๏ธ CLI** โ Terminal output + CSV export
|
|
53
|
+
|
|
54
|
+
View 14-day views, clones, referrers, and popular paths for **all** your repositories. Everything runs on your machine. Your token never leaves your device.
|
|
55
|
+
|
|
56
|
+

|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## ๐จ The 14-Day Catch (And How to Fix It!)
|
|
61
|
+
|
|
62
|
+
> **โ ๏ธ Did you know?** GitHub normally **only saves your repository traffic data for 14 days**. After two weeks, your valuable views and clones data is permanently deleted.
|
|
63
|
+
|
|
64
|
+
**Don't lose your data!** We built a companion automation tool that runs silently in the background every 13 days using GitHub Actions to fetch and save your data permanently.
|
|
65
|
+
|
|
66
|
+
๐ **[Set up GitHub Traffic Automation here](https://github.com/ameyac11/github-traffic-monitor-automation)** (It takes literally 2 minutes to set up!)
|
|
67
|
+
|
|
68
|
+
Once you have your automated data saved, you can seamlessly plug it right into this dashboard to visualize your beautiful, long-term historical charts.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## โจ Features
|
|
73
|
+
|
|
74
|
+
| Feature | React UI | CLI |
|
|
75
|
+
|---|:---:|:---:|
|
|
76
|
+
| **Dual Mode Interface** (Live API & CSV Upload) | โ
| โ |
|
|
77
|
+
| Token input (no hardcoding) | โ
| โ
|
|
|
78
|
+
| Upload & visualize historical CSV data | โ
| โ |
|
|
79
|
+
| Summary metrics (views, clones, stars, forks) | โ
| โ
|
|
|
80
|
+
| Animated Area & Pie charts per repository | โ
| โ |
|
|
81
|
+
| Per-repo daily views & clones chart | โ
| โ
|
|
|
82
|
+
| Top referrers & popular paths | โ
| โ
|
|
|
83
|
+
| Expandable repository list | โ
| โ |
|
|
84
|
+
| Export to CSV | โ
(download button) | โ
(file) |
|
|
85
|
+
| Runs 100% locally | โ
| โ
|
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## ๐ ๏ธ Installation
|
|
90
|
+
|
|
91
|
+
You can install the package directly from PyPI.
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
# Basic CLI installation
|
|
95
|
+
pip install gitlytics
|
|
96
|
+
|
|
97
|
+
# Installation with Dashboard UI support
|
|
98
|
+
pip install "gitlytics[dashboard]"
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Generating a GitHub Personal Access Token (PAT)
|
|
102
|
+
To use either the CLI or Dashboard, you'll need a GitHub token.
|
|
103
|
+
|
|
104
|
+
1. Go to **[GitHub โ Settings โ Developer settings โ Personal access tokens โ Tokens (classic)](https://github.com/settings/tokens)**
|
|
105
|
+
2. Click **Generate new token (classic)**
|
|
106
|
+
3. Select the **`repo`** scope โ required to read traffic data for private repositories
|
|
107
|
+
4. Click **Generate token** and **copy it immediately**
|
|
108
|
+
|
|
109
|
+
> **๐ Security Note:** Your token is completely safe, used only on your machine, and never sent to any external server.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## ๐ฅ๏ธ Run: React Dashboard (Recommended)
|
|
114
|
+
|
|
115
|
+
If you installed with the `[dashboard]` extra, you can launch the beautiful web UI with a single command:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
gitlytics dashboard
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
The server opens automatically in your terminal and you can view your dashboard at `http://localhost:8000`.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## โจ๏ธ Run: CLI (Terminal Mode)
|
|
126
|
+
|
|
127
|
+
If you just want terminal output or to export CSV files, you can use the CLI commands.
|
|
128
|
+
|
|
129
|
+
**Fetch data and print to terminal:**
|
|
130
|
+
```bash
|
|
131
|
+
gitlytics fetch --token ghp_your_token_here
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
**Fetch data and save to a specific CSV file:**
|
|
135
|
+
```bash
|
|
136
|
+
gitlytics fetch --token ghp_your_token_here --output my_report.csv
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
**Sync data (Append today's traffic to historical monthly CSVs):**
|
|
140
|
+
```bash
|
|
141
|
+
gitlytics sync --token ghp_your_token_here --dir ./data
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
You can also store your token in a `.env` file as `GITHUB_TOKEN=ghp_...` so you don't have to type it out every time.
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## ๐ CSV Output Columns
|
|
149
|
+
|
|
150
|
+
| Column | Description |
|
|
151
|
+
|---|---|
|
|
152
|
+
| `Repository` | Full repo name (`user/repo`) |
|
|
153
|
+
| `Private` | `True` / `False` |
|
|
154
|
+
| `Stars` | Current star count |
|
|
155
|
+
| `Forks` | Current fork count |
|
|
156
|
+
| `Total Views` | Page views in last 14 days |
|
|
157
|
+
| `Unique Visitors` | Unique visitors in last 14 days |
|
|
158
|
+
| `Total Clones` | Clone count in last 14 days |
|
|
159
|
+
| `Unique Cloners` | Unique cloners in last 14 days |
|
|
160
|
+
| `Top Referrer` | Highest-traffic referral source |
|
|
161
|
+
| `Top Referrer Views` | View count from top referrer |
|
|
162
|
+
| `Top Path` | Most visited path |
|
|
163
|
+
| `Top Path Views` | View count for top path |
|
|
164
|
+
| `Fetched At` | UTC timestamp of the fetch |
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## โ ๏ธ Requirements
|
|
169
|
+
|
|
170
|
+
- **Python 3.9+**
|
|
171
|
+
- A GitHub account with at least one repository
|
|
172
|
+
- A GitHub Personal Access Token with the `repo` scope
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## ๐ ๏ธ Development Install
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
git clone https://github.com/ameyac11/github-traffic-monitor
|
|
180
|
+
cd github-traffic-monitor
|
|
181
|
+
pip install -e ".[dev,dashboard]"
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
## ๐งช Running Tests
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
pip install pytest
|
|
188
|
+
pytest
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## ๐ Show Your Support
|
|
194
|
+
|
|
195
|
+
If you find this project useful, please consider giving it a โญ on [GitHub](https://github.com/ameyac11/github-traffic-monitor)! It helps more people discover the tool.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## ๐ License
|
|
200
|
+
|
|
201
|
+
This project is licensed under the [Apache License 2.0](LICENSE).
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# Gitlytics
|
|
4
|
+
## ๐ GitHub Traffic Monitor ๐
|
|
5
|
+
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://www.python.org/)
|
|
8
|
+
[](https://pypi.org/project/gitlytics/)
|
|
9
|
+
[](https://react.dev/)
|
|
10
|
+
[](https://fastapi.tiangolo.com/)
|
|
11
|
+
|
|
12
|
+
**Beautiful GitHub traffic analytics for all your repositories โ public and private.** ๐
|
|
13
|
+
|
|
14
|
+
Please consider giving this project a โญ if you find it helpful!
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
> **โ ๏ธ NOTE: NAME AND TECH STACK UPGRADE!**
|
|
21
|
+
> This library was formerly known as `github-traffic-monitor`. We have officially rebranded to **`gitlytics`**!
|
|
22
|
+
>
|
|
23
|
+
> In addition to the name change, we have migrated away from Streamlit. The dashboard is currently a base version working on a new and better **React + Vite** architecture, powered by a **FastAPI** backend!
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
A local-only GitHub traffic analytics tool with two modes:
|
|
28
|
+
- **๐ฅ๏ธ Web UI** โ Beautiful React + FastAPI dashboard (recommended)
|
|
29
|
+
- **โจ๏ธ CLI** โ Terminal output + CSV export
|
|
30
|
+
|
|
31
|
+
View 14-day views, clones, referrers, and popular paths for **all** your repositories. Everything runs on your machine. Your token never leaves your device.
|
|
32
|
+
|
|
33
|
+

|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## ๐จ The 14-Day Catch (And How to Fix It!)
|
|
38
|
+
|
|
39
|
+
> **โ ๏ธ Did you know?** GitHub normally **only saves your repository traffic data for 14 days**. After two weeks, your valuable views and clones data is permanently deleted.
|
|
40
|
+
|
|
41
|
+
**Don't lose your data!** We built a companion automation tool that runs silently in the background every 13 days using GitHub Actions to fetch and save your data permanently.
|
|
42
|
+
|
|
43
|
+
๐ **[Set up GitHub Traffic Automation here](https://github.com/ameyac11/github-traffic-monitor-automation)** (It takes literally 2 minutes to set up!)
|
|
44
|
+
|
|
45
|
+
Once you have your automated data saved, you can seamlessly plug it right into this dashboard to visualize your beautiful, long-term historical charts.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## โจ Features
|
|
50
|
+
|
|
51
|
+
| Feature | React UI | CLI |
|
|
52
|
+
|---|:---:|:---:|
|
|
53
|
+
| **Dual Mode Interface** (Live API & CSV Upload) | โ
| โ |
|
|
54
|
+
| Token input (no hardcoding) | โ
| โ
|
|
|
55
|
+
| Upload & visualize historical CSV data | โ
| โ |
|
|
56
|
+
| Summary metrics (views, clones, stars, forks) | โ
| โ
|
|
|
57
|
+
| Animated Area & Pie charts per repository | โ
| โ |
|
|
58
|
+
| Per-repo daily views & clones chart | โ
| โ
|
|
|
59
|
+
| Top referrers & popular paths | โ
| โ
|
|
|
60
|
+
| Expandable repository list | โ
| โ |
|
|
61
|
+
| Export to CSV | โ
(download button) | โ
(file) |
|
|
62
|
+
| Runs 100% locally | โ
| โ
|
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## ๐ ๏ธ Installation
|
|
67
|
+
|
|
68
|
+
You can install the package directly from PyPI.
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Basic CLI installation
|
|
72
|
+
pip install gitlytics
|
|
73
|
+
|
|
74
|
+
# Installation with Dashboard UI support
|
|
75
|
+
pip install "gitlytics[dashboard]"
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Generating a GitHub Personal Access Token (PAT)
|
|
79
|
+
To use either the CLI or Dashboard, you'll need a GitHub token.
|
|
80
|
+
|
|
81
|
+
1. Go to **[GitHub โ Settings โ Developer settings โ Personal access tokens โ Tokens (classic)](https://github.com/settings/tokens)**
|
|
82
|
+
2. Click **Generate new token (classic)**
|
|
83
|
+
3. Select the **`repo`** scope โ required to read traffic data for private repositories
|
|
84
|
+
4. Click **Generate token** and **copy it immediately**
|
|
85
|
+
|
|
86
|
+
> **๐ Security Note:** Your token is completely safe, used only on your machine, and never sent to any external server.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## ๐ฅ๏ธ Run: React Dashboard (Recommended)
|
|
91
|
+
|
|
92
|
+
If you installed with the `[dashboard]` extra, you can launch the beautiful web UI with a single command:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
gitlytics dashboard
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
The server opens automatically in your terminal and you can view your dashboard at `http://localhost:8000`.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## โจ๏ธ Run: CLI (Terminal Mode)
|
|
103
|
+
|
|
104
|
+
If you just want terminal output or to export CSV files, you can use the CLI commands.
|
|
105
|
+
|
|
106
|
+
**Fetch data and print to terminal:**
|
|
107
|
+
```bash
|
|
108
|
+
gitlytics fetch --token ghp_your_token_here
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**Fetch data and save to a specific CSV file:**
|
|
112
|
+
```bash
|
|
113
|
+
gitlytics fetch --token ghp_your_token_here --output my_report.csv
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
**Sync data (Append today's traffic to historical monthly CSVs):**
|
|
117
|
+
```bash
|
|
118
|
+
gitlytics sync --token ghp_your_token_here --dir ./data
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
You can also store your token in a `.env` file as `GITHUB_TOKEN=ghp_...` so you don't have to type it out every time.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## ๐ CSV Output Columns
|
|
126
|
+
|
|
127
|
+
| Column | Description |
|
|
128
|
+
|---|---|
|
|
129
|
+
| `Repository` | Full repo name (`user/repo`) |
|
|
130
|
+
| `Private` | `True` / `False` |
|
|
131
|
+
| `Stars` | Current star count |
|
|
132
|
+
| `Forks` | Current fork count |
|
|
133
|
+
| `Total Views` | Page views in last 14 days |
|
|
134
|
+
| `Unique Visitors` | Unique visitors in last 14 days |
|
|
135
|
+
| `Total Clones` | Clone count in last 14 days |
|
|
136
|
+
| `Unique Cloners` | Unique cloners in last 14 days |
|
|
137
|
+
| `Top Referrer` | Highest-traffic referral source |
|
|
138
|
+
| `Top Referrer Views` | View count from top referrer |
|
|
139
|
+
| `Top Path` | Most visited path |
|
|
140
|
+
| `Top Path Views` | View count for top path |
|
|
141
|
+
| `Fetched At` | UTC timestamp of the fetch |
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## โ ๏ธ Requirements
|
|
146
|
+
|
|
147
|
+
- **Python 3.9+**
|
|
148
|
+
- A GitHub account with at least one repository
|
|
149
|
+
- A GitHub Personal Access Token with the `repo` scope
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## ๐ ๏ธ Development Install
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
git clone https://github.com/ameyac11/github-traffic-monitor
|
|
157
|
+
cd github-traffic-monitor
|
|
158
|
+
pip install -e ".[dev,dashboard]"
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## ๐งช Running Tests
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
pip install pytest
|
|
165
|
+
pytest
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## ๐ Show Your Support
|
|
171
|
+
|
|
172
|
+
If you find this project useful, please consider giving it a โญ on [GitHub](https://github.com/ameyac11/github-traffic-monitor)! It helps more people discover the tool.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## ๐ License
|
|
177
|
+
|
|
178
|
+
This project is licensed under the [Apache License 2.0](LICENSE).
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
"""
|
|
2
|
+
api.py
|
|
3
|
+
This file powers the FastAPI backend, serving our data and React dashboard to the browser!
|
|
4
|
+
"""
|
|
5
|
+
import os
|
|
6
|
+
from pathlib import Path
|
|
7
|
+
from fastapi import FastAPI, HTTPException, Header, Body, File, UploadFile
|
|
8
|
+
from fastapi.staticfiles import StaticFiles
|
|
9
|
+
from fastapi.responses import FileResponse, JSONResponse
|
|
10
|
+
from fastapi.middleware.cors import CORSMiddleware
|
|
11
|
+
import pandas as pd
|
|
12
|
+
|
|
13
|
+
from github_traffic.core import validate_token, fetch_all_traffic
|
|
14
|
+
from github_traffic.process import process_uploaded_csv
|
|
15
|
+
|
|
16
|
+
app = FastAPI(title="GitHub Traffic API")
|
|
17
|
+
|
|
18
|
+
# Allow CORS for local development (Vite runs on 5173 usually)
|
|
19
|
+
app.add_middleware(
|
|
20
|
+
CORSMiddleware,
|
|
21
|
+
allow_origins=["http://localhost:5173", "http://127.0.0.1:5173"],
|
|
22
|
+
allow_credentials=True,
|
|
23
|
+
allow_methods=["*"],
|
|
24
|
+
allow_headers=["*"],
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
@app.post("/api/auth")
|
|
28
|
+
def auth(token: str = Body(..., embed=True)):
|
|
29
|
+
ok, username, avatar_url, name = validate_token(token)
|
|
30
|
+
if not ok:
|
|
31
|
+
raise HTTPException(status_code=401, detail=username) # validate_token returns error msg in username slot
|
|
32
|
+
return {
|
|
33
|
+
"authenticated": True,
|
|
34
|
+
"username": username,
|
|
35
|
+
"name": name or username,
|
|
36
|
+
"avatar_url": avatar_url
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
@app.post("/api/traffic")
|
|
40
|
+
def get_traffic(token: str = Body(..., embed=True)):
|
|
41
|
+
ok, _, _, _ = validate_token(token)
|
|
42
|
+
if not ok:
|
|
43
|
+
raise HTTPException(status_code=401, detail="Invalid token")
|
|
44
|
+
|
|
45
|
+
df = fetch_all_traffic(token)
|
|
46
|
+
# Convert dataframe to JSON response
|
|
47
|
+
# Replacing NaN/Inf with None so it serializes correctly to JSON
|
|
48
|
+
df = df.replace([float('inf'), float('-inf')], None).where(pd.notnull(df), None)
|
|
49
|
+
return df.to_dict(orient="records")
|
|
50
|
+
|
|
51
|
+
@app.post("/api/upload-csv")
|
|
52
|
+
def upload_csv(file: UploadFile = File(...)):
|
|
53
|
+
try:
|
|
54
|
+
df = process_uploaded_csv(file.file)
|
|
55
|
+
df = df.replace([float('inf'), float('-inf')], None).where(pd.notnull(df), None)
|
|
56
|
+
return df.to_dict(orient="records")
|
|
57
|
+
except Exception as e:
|
|
58
|
+
raise HTTPException(status_code=400, detail=str(e))
|
|
59
|
+
|
|
60
|
+
# Mount the React frontend assets (if built)
|
|
61
|
+
frontend_dist = Path(__file__).parent / "frontend" / "dist"
|
|
62
|
+
|
|
63
|
+
@app.get("/")
|
|
64
|
+
def serve_index():
|
|
65
|
+
index_file = frontend_dist / "index.html"
|
|
66
|
+
if index_file.exists():
|
|
67
|
+
return FileResponse(index_file)
|
|
68
|
+
return JSONResponse(
|
|
69
|
+
status_code=404,
|
|
70
|
+
content={"error": "Frontend not built. Run 'npm run build' in the frontend directory."}
|
|
71
|
+
)
|
|
72
|
+
|
|
73
|
+
# Mount all other static files
|
|
74
|
+
if frontend_dist.exists():
|
|
75
|
+
app.mount("/", StaticFiles(directory=frontend_dist), name="static")
|
|
76
|
+
|