https://github.com/wumphlett/repostats
https://github.com/wumphlett/repostats
github-actions graph traffic views views-count
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wumphlett/repostats
- Owner: wumphlett
- License: mit
- Created: 2022-08-25T01:47:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-22T23:58:43.000Z (4 months ago)
- Last Synced: 2026-01-23T16:56:00.818Z (4 months ago)
- Topics: github-actions, graph, traffic, views, views-count
- Language: Python
- Homepage:
- Size: 1.11 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Repository Traffic
This Github action can be used to store traffic data beyond the two-week period currently supported.
It uses the Github API to pull down the traffic data and stores it into a configurable directory and commits it to your
repository. In addition, ascii charts are generated and can be automatically inserted into your README to display traffic.
# Usage
## Permissions
1. Create a personal access token (PAT) with repo permissions
2. Store it in your repository secrets with the key `TRAFFIC_ACTION_TOKEN`
## Workflow
Create a `workflow.yml` file in your `.github/workflows` directory. An example is provided.
```yaml
name: Repository Traffic
on:
schedule:
- cron: "55 23 * * 1"
workflow_dispatch:
jobs:
traffic:
runs-on: ubuntu-latest
steps:
- name: Repository Traffic
uses: wumphlett/repostats@v2.1.0
env:
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRAFFIC_ACTION_TOKEN }}
```
The `env` directive with the `TRAFFIC_ACTION_TOKEN` is required. Any variables defined in `with` are optional.
## Configuration
Three values can be configured in the `with` directive of the action.
```
format_readme (true/false) - control whether the action will format a template readme with traffic data (see below)
default: false
commit_msg (str) - The commit message used when updating traffic data
default: "Updating repository traffic"
traffic_dir (str) - The directory used to store and update traffic data
default: ".traffic"
```
## README Formatting
Optionally, you can use this action to format your readme with traffic data. This works best if you schedule this action
daily.
1. Create a `TEMPLATE_README.` file in your `.github` directory
2. Include either {VIEWS_CHART} or {CLONES_CHART} in your template file
1. Note: its recommended that you wrap your formatting directive in triple backticks to preserve spacing
3. Enable `format_readme` in your `workflow.yml` file
4. Trigger the action to format your readme which will automatically commit the changes
1. Note, all changes that you want to make to your readme must now be made to the template instead of the readme in the root of the repo
## Running `github-repo-traffic` locally
You can use the package responsible for metric collection/aggregation locally instead of in a github action.
1. `pip install github-repo-stats`
2. Set the environment variables in `.env.example`
1. `TRAFFIC_ACTION_TOKEN` - a personal access token with repo permissions
2. `GITHUB_REPOSITORY` - the repo you're trying to collect metrics for (e.g. wumphlett/repostats)
3. `GITHUB_WORKSPACE` - your root directory (can be anything if you're not using readme formatting, else root of a repo)
4. `TRAFFIC_DIR` - the directory to store collected metrics (default `.traffic`)
3. Invoke the commands
1. `repo-data` - collects and aggregates metric data (make sure to run at least every two weeks for complete data)
2. `repo-readme` - formats a template readme with a views/clones chart
```
Total Views per Day from 2025-11-02 to 2026-01-30
Repository Views
2 ┼ ╭╮ ╭╮
2 ┤ ││ ││
2 ┤ ││ ││
2 ┤ ││ ││
1 ┤ ││ ││
1 ┤ ││ ││
1 ┤ ││ ││
1 ┤╭╮ ││ ╭╮ ╭╮ ╭╮ ╭╮ ╭╮ ╭╯│
1 ┤││ ││ ││ ││ ││ ││ ││ │ │
1 ┤││ ││ ││ ││ ││ ││ ││ │ │
1 ┤││ ││ ││ ││ ││ ││ ││ │ │
1 ┤││ ││ ││ ││ ││ ││ ││ │ │
0 ┤││ ││ ││ ││ ││ ││ ││ │ │
0 ┤││ ││ ││ ││ ││ ││ ││ │ │
0 ┤││ ││ ││ ││ ││ ││ ││ │ │
0 ┼╯╰──────╯╰──────────────╯╰────────╯╰────╯╰───╯╰──────╯╰──────────────────────────────╯ ╰─
Chart last updated - Fri Jan 30 00:00:33 2026 UTC
```