Skip to content

Commit f0d7ecb

Browse files
committed
ci: add automated traffic clone tracking workflow and badge
1 parent 5ed1602 commit f0d7ecb

2 files changed

Lines changed: 22 additions & 4 deletions

File tree

.github/workflows/clones.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Update Clone Badge
2+
on:
3+
schedule:
4+
- cron: '0 0 * * *' # Runs daily at midnight
5+
workflow_dispatch:
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
update-badge:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: yi-Xu-0100/traffic-to-badge@v1.4.0
15+
with:
16+
my_token: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# tsauditor
22
[![CI](https://github.com/imann128/tsauditor/actions/workflows/ci.yml/badge.svg)](https://github.com/imann128/tsauditor/actions/workflows/ci.yml)
3+
![Total Clones](https://raw.githubusercontent.com/imann128/tsauditor/traffic/clones.svg)
34
[![codecov](https://codecov.io/github/imann128/tsauditor/graph/badge.svg)](https://codecov.io/github/imann128/tsauditor)
45
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
56

@@ -37,7 +38,9 @@ cd tsauditor
3738
pip install -e ".[dev]"
3839
```
3940

40-
## **Note:** Set domain="None" for domain agnostic usage. Similarly, it works well withuut defining a domain at all.
41+
## **Note:** Set domain="None" for domain agnostic usage. Similarly, it works well without defining a domain at all.
42+
43+
**For usage snippets, scroll down in the readme or check out the [examples](./examples) directory for sample scripts**
4144

4245
## Quickstart
4346

@@ -75,7 +78,7 @@ url = "[https://raw.githubusercontent.com/jbrownlee/Datasets/master/daily-min-te
7578
try:
7679
df = pd.read_csv(url, parse_dates=["Date"], index_col="Date")
7780
df.columns = ["air_temperature"]
78-
print(" Dataset successfully loaded into memory!")
81+
print(" Dataset successfully into memory")
7982
except Exception as e:
8083
print(f" Error loading dataset: {e}")
8184

@@ -89,8 +92,7 @@ df.iloc[300:310] = None
8992
# 3. Electrical surge: an impossible 75°C transient spike
9093
df.iloc[500] = 75.0
9194

92-
print("\n Running `tsauditor` validation sweep...")
93-
print("-" * 60)
95+
print("\n Running `tsauditor` validation sweep")
9496

9597
# Execute the audit using the optimized sensor preset
9698
report = tsa.scan(df, domain="sensor")

0 commit comments

Comments
 (0)