gitlytics 0.1.1__tar.gz → 0.1.3__tar.gz

gitlytics-0.1.3/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: gitlytics
+Version: 0.1.3
+Summary: Monitor and automate your GitHub repository traffic analytics.
+Author: Ameya Chopade
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/ameyac11/gitlytics
+Project-URL: Repository, https://github.com/ameyac11/gitlytics
+Project-URL: Bug Tracker, https://github.com/ameyac11/gitlytics/issues
+Keywords: github,traffic,analytics,automation,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.0
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: croniter>=2.0.0
+Provides-Extra: dashboard
+Requires-Dist: fastapi>=0.111.0; extra == "dashboard"
+Requires-Dist: uvicorn>=0.30.0; extra == "dashboard"
+Requires-Dist: python-multipart>=0.0.9; extra == "dashboard"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: httpx>=0.27.0; extra == "dev"
+Requires-Dist: Faker>=20.0.0; extra == "dev"
+Requires-Dist: anyio[trio]>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+# 📊 Gitlytics
+### GitHub Traffic Analytics & Automation 
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org/)
+[![PyPI](https://img.shields.io/pypi/v/gitlytics?color=blue)](https://pypi.org/project/gitlytics/)
+[![React](https://img.shields.io/badge/UI-React-61dafb?logo=react)](https://react.dev/)
+[![FastAPI](https://img.shields.io/badge/Backend-FastAPI-009688?logo=fastapi)](https://fastapi.tiangolo.com/)
+[![Automation](https://img.shields.io/badge/Data%20Backup-Automation%20Tool-purple?logo=github-actions)](https://github.com/ameyac11/gitlytics-github-traffic-automation)
+
+**Beautiful GitHub traffic analytics for all your repositories — public and private.** <br/> Track views, clones, referrers, and popular paths indefinitely.
+
+Please consider giving this project a ⭐ if you find it helpful!
+
+</div>
+
+---
+
+> **⚠️ NOTE: V0.1.2 ARCHITECTURE UPGRADE!** <br/>
+> Formerly `github-traffic-monitor`, we have officially rebranded to **`gitlytics`**! We completely migrated away from Streamlit. The dashboard is now a **React + Vite** SPA, powered by a **FastAPI** backend!
+
+---
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_1.png" width="49%" />
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_2.png" width="49%" />
+</div>
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_3.png" width="98.5%" />
+</div>
+
+---
+
+## 📌 Table of Contents
+
+- [🚨 The 14-Day Catch (And How We Fix It)](#the-14-day-catch-and-how-we-fix-it)
+- [🛠️ Installation](#installation)
+  - [🔑 Generating a GitHub Personal Access Token](#generating-a-github-personal-access-token)
+- [⌨️ The 3 Core CLI Commands](#the-3-core-cli-commands)
+  - [1️⃣ `gitlytics fetch` (Live Terminal Data)](#1-gitlytics-fetch-live-terminal-data)
+  - [2️⃣ `gitlytics sync` (Background Database Cron)](#2-gitlytics-sync-background-database-cron)
+  - [3️⃣ `gitlytics dashboard` (React Web UI)](#3-gitlytics-dashboard-react-web-ui)
+- [🐍 Native Python API](#native-python-api)
+  - [1️⃣ `gitlytics.fetch_traffic()`](#1-gitlyticsfetch_traffic)
+  - [2️⃣ `gitlytics.sync()`](#2-gitlyticssync)
+  - [3️⃣ `gitlytics.serve_dashboard()`](#3-gitlyticsserve_dashboard)
+- [📊 CSV Output Columns](#csv-output-columns)
+- [🌟 Show Your Support](#show-your-support)
+- [📄 License](#license)
+
+---
+
+## 🚨 The 14-Day Catch (And How We Fix It)
+
+> **⚠️ 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.
+
+**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. 
+
+👉 **[Set up GitHub Traffic Automation here](https://github.com/ameyac11/gitlytics-github-traffic-automation)** (It takes literally 2 minutes to set up!)
+
+Once you have your automated CSV data saved from that tool, you can seamlessly plug it right into `gitlytics` to visualize beautiful, long-term historical charts stretching back months or years!
+
+---
+
+## 🛠️ Installation
+
+Install via PyPI:
+
+```bash
+# Basic CLI and Python Module installation
+pip install gitlytics
+
+# Full installation (includes React Dashboard dependencies)
+pip install "gitlytics[dashboard]"
+```
+
+### 🔑 Generating a GitHub Personal Access Token
+To use the tools, you'll need a GitHub token.
+1. Go to **[GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)](https://github.com/settings/tokens)**
+2. Click **Generate new token (classic)**
+3. Select the **`repo`** scope *(required to read traffic data for private repositories)*
+4. Click **Generate token** and copy it!
+
+---
+
+## ⌨️ The 3 Core CLI Commands
+
+Gitlytics is powered by 3 massive command-line tools. You can run them anywhere in your terminal.
+
+### 1️⃣ `gitlytics fetch` (Live Terminal Data)
+Fetch your live 14-day traffic and print a beautiful ASCII table directly in your console.
+```bash
+gitlytics fetch --token ghp_your_token_here --print-table
+```
+
+### 2️⃣ `gitlytics sync` (Background Database Cron)
+Tired of losing data? Use `sync` to permanently append today's traffic to a CSV database. You can even run it as a background cron job (perfect for Raspberry Pi or Linux/Cloud servers)!
+```bash
+# Sync once
+gitlytics sync --token ghp_your_token --data-dir ./data
+
+# Run permanently in the background as a cron job (runs at 11:00 PM every day)
+gitlytics sync --token ghp_your_token --data-dir ./data --schedule-cron "0 23 * * *"
+```
+
+### 3️⃣ `gitlytics dashboard` (React Web UI)
+Launch the beautiful React + FastAPI web interface. 
+```bash
+gitlytics dashboard
+```
+> **📺 Headless TV Mode:** Want to display the dashboard on an office TV monitor? Pass the historical database and token directly so the UI auto-loads without requiring a manual browser login!
+> ```bash
+> gitlytics dashboard --token "ghp_xxx" --data-dir "./data"
+> ```
+
+---
+
+## 🐍 Native Python API
+
+You can import Gitlytics natively into your own Python applications to build custom integrations, run custom cron workflows, or serve the dashboard programmatically on your own cloud servers.
+
+📚 **[Read the Full API Documentation](docs/api_documentation.md)**
+
+### 1️⃣ `gitlytics.fetch_traffic()`
+Fetches the last 14 days of traffic data (views, clones, referrers, paths) for one or more repositories.
+
+```python
+import gitlytics
+
+# Fetch traffic for all repositories accessible by the token
+df = gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    return_format="dataframe"  # Options: "dataframe" (Pandas), "timeseries" (chart-ready dict), or "summary" (per-repo totals dict)
+)
+
+# Fetch traffic for a single specific repository and print the table to stdout
+gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    repo_name="username/my-repo",
+    print_table=True
+)
+
+# Save output directly to a file (CSV or JSON depending on file extension)
+gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    return_format="dataframe",
+    save_file="./data/traffic.csv"
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `token` | `str` | *Required* | GitHub Personal Access Token with `repo` scope enabled. |
+| `repo_name` | `str` | `None` | Specific repository name (e.g. `"user/repo"`). If `None`, fetches all repositories. |
+| `print_table` | `bool` | `False` | If `True`, formats and prints a detailed ASCII traffic table to the console. |
+| `return_format` | `str` | `"dataframe"` | The format of returned data: `"dataframe"` (Pandas DataFrame), `"timeseries"` (chart-ready nested dict), or `"summary"` (per-repo totals dict). |
+| `save_file` | `str` | `None` | Optional. File path where the fetched data will be saved (CSV or JSON). |
+
+---
+
+### 2️⃣ `gitlytics.sync()`
+Fetches the live traffic data and appends it to a persistent CSV database. Handles merging overlaps and duplicates. Can be scheduled with an internal cron scheduler for cloud deployments.
+
+```python
+import gitlytics
+
+# Standard run: Syncs current snapshots to the CSV database and exports UI JSON
+gitlytics.sync(
+    token="ghp_your_token",
+    data_dir="./data",
+    export_json="./data/export.json",
+    export_public_only=True  # Security Firewall: Exclude private repos from the public-facing export.json
+)
+
+# Scheduled Cloud Worker: Run infinitely using standard cron schedule syntax
+gitlytics.sync(
+    token="ghp_your_token",
+    data_dir="./data",
+    schedule_cron="0 23 * * *",  # Runs everyday at 11:00 PM UTC
+    export_json="./data/export.json"
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `token` | `str` | *Required* | GitHub Personal Access Token. |
+| `repo_name` | `str` or `list` | `None` | Specific repository name(s) to sync. If `None`, syncs all repositories. |
+| `data_dir` | `str` | `"./data"` | Directory where CSV files are saved. |
+| `output_mode` | `str` | `"monthly"` | File grouping frequency: `"monthly"` (creates `traffic_YYYY-MM.csv`) or `"yearly"` (creates `traffic_YYYY.csv`). |
+| `schedule_cron` | `str` | `None` | Optional cron expression (e.g., `"*/15 * * * *"`). If set, runs an infinite scheduler loop. |
+| `export_json` | `str` | `None` | Optional. Path to compile and export a consolidated history JSON for the frontend. |
+| `export_public_only` | `bool` | `True` | Security firewall: if `True`, strips private repository data from the compiled `export_json`. |
+
+---
+
+### 3️⃣ `gitlytics.serve_dashboard()`
+Launches the FastAPI backend and hosts the embedded React SPA dashboard.
+
+```python
+import gitlytics
+
+# Host the dashboard programmatically on a custom host/port
+gitlytics.serve_dashboard(
+    host="0.0.0.0",
+    port=8080,
+    token="ghp_your_token",     # Pre-authenticates the dashboard session
+    data_dir="./data"           # Folder containing the historical databases
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `host` | `str` | `"127.0.0.1"` | Host IP to bind the FastAPI server. Use `"0.0.0.0"` to listen on all interfaces. |
+| `port` | `int` | `8000` | Port to run the web server on. |
+| `token` | `str` | `None` | Optional. Pre-authenticates the dashboard session to bypass the login screen. |
+| `data_dir` | `str` | `None` | Optional. Path to the folder containing your synced CSV or JSON databases. |
+
+---
+
+
+## 📊 CSV Output Columns
+
+When you sync data, the local CSV databases track 13 detailed metrics:
+
+| Column | Description | Column | Description |
+|---|---|---|---|
+| `repository` | Full repo name (`user/repo`) | `stars` | Current star count |
+| `is_private` | `True` / `False` | `forks` | Current fork count |
+| `views` | Page views today | `unique_visitors` | Unique visitors today |
+| `clones` | Clone count today | `unique_cloners` | Unique cloners today |
+| `top_referrer` | Highest-traffic referral source | `top_referrer_views` | Views from top referrer |
+| `top_path` | Most visited path | `top_path_views` | Views for top path |
+
+---
+
+## 🌟 Show Your Support
+
+If you find this project useful, please consider giving it a ⭐ on [GitHub](https://github.com/ameyac11/gitlytics)! It helps more people discover the tool.
+
+## 📄 License
+Licensed under the [Apache License 2.0](LICENSE).

gitlytics-0.1.3/README.md

@@ -0,0 +1,246 @@
+<div align="center">
+
+# 📊 Gitlytics
+### GitHub Traffic Analytics & Automation 
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org/)
+[![PyPI](https://img.shields.io/pypi/v/gitlytics?color=blue)](https://pypi.org/project/gitlytics/)
+[![React](https://img.shields.io/badge/UI-React-61dafb?logo=react)](https://react.dev/)
+[![FastAPI](https://img.shields.io/badge/Backend-FastAPI-009688?logo=fastapi)](https://fastapi.tiangolo.com/)
+[![Automation](https://img.shields.io/badge/Data%20Backup-Automation%20Tool-purple?logo=github-actions)](https://github.com/ameyac11/gitlytics-github-traffic-automation)
+
+**Beautiful GitHub traffic analytics for all your repositories — public and private.** <br/> Track views, clones, referrers, and popular paths indefinitely.
+
+Please consider giving this project a ⭐ if you find it helpful!
+
+</div>
+
+---
+
+> **⚠️ NOTE: V0.1.2 ARCHITECTURE UPGRADE!** <br/>
+> Formerly `github-traffic-monitor`, we have officially rebranded to **`gitlytics`**! We completely migrated away from Streamlit. The dashboard is now a **React + Vite** SPA, powered by a **FastAPI** backend!
+
+---
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_1.png" width="49%" />
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_2.png" width="49%" />
+</div>
+<div align="center">
+  <img src="https://raw.githubusercontent.com/ameyac11/gitlytics/main/assets/gitlytics_thumbnail_3.png" width="98.5%" />
+</div>
+
+---
+
+## 📌 Table of Contents
+
+- [🚨 The 14-Day Catch (And How We Fix It)](#the-14-day-catch-and-how-we-fix-it)
+- [🛠️ Installation](#installation)
+  - [🔑 Generating a GitHub Personal Access Token](#generating-a-github-personal-access-token)
+- [⌨️ The 3 Core CLI Commands](#the-3-core-cli-commands)
+  - [1️⃣ `gitlytics fetch` (Live Terminal Data)](#1-gitlytics-fetch-live-terminal-data)
+  - [2️⃣ `gitlytics sync` (Background Database Cron)](#2-gitlytics-sync-background-database-cron)
+  - [3️⃣ `gitlytics dashboard` (React Web UI)](#3-gitlytics-dashboard-react-web-ui)
+- [🐍 Native Python API](#native-python-api)
+  - [1️⃣ `gitlytics.fetch_traffic()`](#1-gitlyticsfetch_traffic)
+  - [2️⃣ `gitlytics.sync()`](#2-gitlyticssync)
+  - [3️⃣ `gitlytics.serve_dashboard()`](#3-gitlyticsserve_dashboard)
+- [📊 CSV Output Columns](#csv-output-columns)
+- [🌟 Show Your Support](#show-your-support)
+- [📄 License](#license)
+
+---
+
+## 🚨 The 14-Day Catch (And How We Fix It)
+
+> **⚠️ 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.
+
+**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. 
+
+👉 **[Set up GitHub Traffic Automation here](https://github.com/ameyac11/gitlytics-github-traffic-automation)** (It takes literally 2 minutes to set up!)
+
+Once you have your automated CSV data saved from that tool, you can seamlessly plug it right into `gitlytics` to visualize beautiful, long-term historical charts stretching back months or years!
+
+---
+
+## 🛠️ Installation
+
+Install via PyPI:
+
+```bash
+# Basic CLI and Python Module installation
+pip install gitlytics
+
+# Full installation (includes React Dashboard dependencies)
+pip install "gitlytics[dashboard]"
+```
+
+### 🔑 Generating a GitHub Personal Access Token
+To use the tools, you'll need a GitHub token.
+1. Go to **[GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)](https://github.com/settings/tokens)**
+2. Click **Generate new token (classic)**
+3. Select the **`repo`** scope *(required to read traffic data for private repositories)*
+4. Click **Generate token** and copy it!
+
+---
+
+## ⌨️ The 3 Core CLI Commands
+
+Gitlytics is powered by 3 massive command-line tools. You can run them anywhere in your terminal.
+
+### 1️⃣ `gitlytics fetch` (Live Terminal Data)
+Fetch your live 14-day traffic and print a beautiful ASCII table directly in your console.
+```bash
+gitlytics fetch --token ghp_your_token_here --print-table
+```
+
+### 2️⃣ `gitlytics sync` (Background Database Cron)
+Tired of losing data? Use `sync` to permanently append today's traffic to a CSV database. You can even run it as a background cron job (perfect for Raspberry Pi or Linux/Cloud servers)!
+```bash
+# Sync once
+gitlytics sync --token ghp_your_token --data-dir ./data
+
+# Run permanently in the background as a cron job (runs at 11:00 PM every day)
+gitlytics sync --token ghp_your_token --data-dir ./data --schedule-cron "0 23 * * *"
+```
+
+### 3️⃣ `gitlytics dashboard` (React Web UI)
+Launch the beautiful React + FastAPI web interface. 
+```bash
+gitlytics dashboard
+```
+> **📺 Headless TV Mode:** Want to display the dashboard on an office TV monitor? Pass the historical database and token directly so the UI auto-loads without requiring a manual browser login!
+> ```bash
+> gitlytics dashboard --token "ghp_xxx" --data-dir "./data"
+> ```
+
+---
+
+## 🐍 Native Python API
+
+You can import Gitlytics natively into your own Python applications to build custom integrations, run custom cron workflows, or serve the dashboard programmatically on your own cloud servers.
+
+📚 **[Read the Full API Documentation](docs/api_documentation.md)**
+
+### 1️⃣ `gitlytics.fetch_traffic()`
+Fetches the last 14 days of traffic data (views, clones, referrers, paths) for one or more repositories.
+
+```python
+import gitlytics
+
+# Fetch traffic for all repositories accessible by the token
+df = gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    return_format="dataframe"  # Options: "dataframe" (Pandas), "timeseries" (chart-ready dict), or "summary" (per-repo totals dict)
+)
+
+# Fetch traffic for a single specific repository and print the table to stdout
+gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    repo_name="username/my-repo",
+    print_table=True
+)
+
+# Save output directly to a file (CSV or JSON depending on file extension)
+gitlytics.fetch_traffic(
+    token="ghp_your_token",
+    return_format="dataframe",
+    save_file="./data/traffic.csv"
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `token` | `str` | *Required* | GitHub Personal Access Token with `repo` scope enabled. |
+| `repo_name` | `str` | `None` | Specific repository name (e.g. `"user/repo"`). If `None`, fetches all repositories. |
+| `print_table` | `bool` | `False` | If `True`, formats and prints a detailed ASCII traffic table to the console. |
+| `return_format` | `str` | `"dataframe"` | The format of returned data: `"dataframe"` (Pandas DataFrame), `"timeseries"` (chart-ready nested dict), or `"summary"` (per-repo totals dict). |
+| `save_file` | `str` | `None` | Optional. File path where the fetched data will be saved (CSV or JSON). |
+
+---
+
+### 2️⃣ `gitlytics.sync()`
+Fetches the live traffic data and appends it to a persistent CSV database. Handles merging overlaps and duplicates. Can be scheduled with an internal cron scheduler for cloud deployments.
+
+```python
+import gitlytics
+
+# Standard run: Syncs current snapshots to the CSV database and exports UI JSON
+gitlytics.sync(
+    token="ghp_your_token",
+    data_dir="./data",
+    export_json="./data/export.json",
+    export_public_only=True  # Security Firewall: Exclude private repos from the public-facing export.json
+)
+
+# Scheduled Cloud Worker: Run infinitely using standard cron schedule syntax
+gitlytics.sync(
+    token="ghp_your_token",
+    data_dir="./data",
+    schedule_cron="0 23 * * *",  # Runs everyday at 11:00 PM UTC
+    export_json="./data/export.json"
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `token` | `str` | *Required* | GitHub Personal Access Token. |
+| `repo_name` | `str` or `list` | `None` | Specific repository name(s) to sync. If `None`, syncs all repositories. |
+| `data_dir` | `str` | `"./data"` | Directory where CSV files are saved. |
+| `output_mode` | `str` | `"monthly"` | File grouping frequency: `"monthly"` (creates `traffic_YYYY-MM.csv`) or `"yearly"` (creates `traffic_YYYY.csv`). |
+| `schedule_cron` | `str` | `None` | Optional cron expression (e.g., `"*/15 * * * *"`). If set, runs an infinite scheduler loop. |
+| `export_json` | `str` | `None` | Optional. Path to compile and export a consolidated history JSON for the frontend. |
+| `export_public_only` | `bool` | `True` | Security firewall: if `True`, strips private repository data from the compiled `export_json`. |
+
+---
+
+### 3️⃣ `gitlytics.serve_dashboard()`
+Launches the FastAPI backend and hosts the embedded React SPA dashboard.
+
+```python
+import gitlytics
+
+# Host the dashboard programmatically on a custom host/port
+gitlytics.serve_dashboard(
+    host="0.0.0.0",
+    port=8080,
+    token="ghp_your_token",     # Pre-authenticates the dashboard session
+    data_dir="./data"           # Folder containing the historical databases
+)
+```
+
+#### ⚙️ Parameters:
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `host` | `str` | `"127.0.0.1"` | Host IP to bind the FastAPI server. Use `"0.0.0.0"` to listen on all interfaces. |
+| `port` | `int` | `8000` | Port to run the web server on. |
+| `token` | `str` | `None` | Optional. Pre-authenticates the dashboard session to bypass the login screen. |
+| `data_dir` | `str` | `None` | Optional. Path to the folder containing your synced CSV or JSON databases. |
+
+---
+
+
+## 📊 CSV Output Columns
+
+When you sync data, the local CSV databases track 13 detailed metrics:
+
+| Column | Description | Column | Description |
+|---|---|---|---|
+| `repository` | Full repo name (`user/repo`) | `stars` | Current star count |
+| `is_private` | `True` / `False` | `forks` | Current fork count |
+| `views` | Page views today | `unique_visitors` | Unique visitors today |
+| `clones` | Clone count today | `unique_cloners` | Unique cloners today |
+| `top_referrer` | Highest-traffic referral source | `top_referrer_views` | Views from top referrer |
+| `top_path` | Most visited path | `top_path_views` | Views for top path |
+
+---
+
+## 🌟 Show Your Support
+
+If you find this project useful, please consider giving it a ⭐ on [GitHub](https://github.com/ameyac11/gitlytics)! It helps more people discover the tool.
+
+## 📄 License
+Licensed under the [Apache License 2.0](LICENSE).

gitlytics-0.1.3/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gitlytics"
+version = "0.1.3"
+description = "Monitor and automate your GitHub repository traffic analytics."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+authors = [
+    { name = "Ameya Chopade" }
+]
+# Fix #20: Add version lower-bounds to prevent silent breakage on old environments.
+# These match the constraints already documented in requirements.txt.
+dependencies = [
+    "requests>=2.32.0",
+    "pandas>=2.2.0",
+    "python-dotenv>=1.0.1",
+    "croniter>=2.0.0"
+]
+keywords = [
+    "github",
+    "traffic",
+    "analytics",
+    "automation",
+    "cli"
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/ameyac11/gitlytics"
+Repository = "https://github.com/ameyac11/gitlytics"
+"Bug Tracker" = "https://github.com/ameyac11/gitlytics/issues"
+
+[project.optional-dependencies]
+# Fix #20: dashboard extras are optional — base package works without them.
+# requirements.txt was including them as mandatory; that was wrong.
+dashboard = [
+    "fastapi>=0.111.0",
+    "uvicorn>=0.30.0",
+    "python-multipart>=0.0.9"
+]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=5.0.0",
+    "httpx>=0.27.0",      # required by FastAPI TestClient (used in test_api.py)
+    "Faker>=20.0.0",      # used by pytest-faker plugin for generating test data
+    "anyio[trio]>=4.0.0"  # async test support
+]
+
+
+[project.scripts]
+gitlytics = "gitlytics.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["gitlytics*"]
+
+[tool.setuptools.package-data]
+"gitlytics" = ["static/**/*", "static/*"]
+
+[tool.pytest.ini_options]
+# Only collect files that match the offline test naming convention.
+# live_*.py scripts are excluded — they need a real GitHub token.
+testpaths = ["tests"]
+python_files  = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]