Skip to content

Commit c5468c1

Browse files
committed
docs: add PyPI install instructions, finalize badges
1 parent 9f98676 commit c5468c1

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# tsauditor
2+
[![CI](https://github.com/<your-username>/tsauditor/actions/workflows/ci.yml/badge.svg)](https://github.com/<your-username>/tsauditor/actions/workflows/ci.yml)
3+
[![codecov](https://codecov.io/gh/<your-username>/tsauditor/branch/main/graph/badge.svg)](https://codecov.io/gh/<your-username>/tsauditor)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
25

36
A data-quality auditing library for **time-series tabular data**, with a focus on
47
financial and sensor domains. `tsauditor` scans a `DataFrame` and returns a
@@ -99,9 +102,18 @@ tsauditor/
99102
pytest -q
100103
```
101104

105+
## Contributing
106+
107+
Contributions are welcome. Check [open issues](https://github.com/imann128/tsauditor/issues)
108+
for ideas, or look for the `good first issue` label. Run `pytest -q` before opening a PR —
109+
all 93 tests must pass, and CI will verify this across Python 3.9–3.14 on Linux, Windows, and macOS.
110+
111+
102112
## Status
103113

104-
Alpha (`0.1.0`). Profiler, anomaly, and leakage modules are implemented and tested.
114+
Beta (`0.1.0`). Profiler, anomaly, and leakage modules are implemented and tested
115+
(93 tests passing, CI across Python 3.9–3.14 on Linux, Windows, macOS).
116+
Not yet on PyPI — see Installation above for the development install.
105117

106118
## License
107119

0 commit comments

Comments
 (0)