Skip to content

Commit 3885f5a

Browse files
committed
Chore: Add badges and project links to README
1 parent 8d93056 commit 3885f5a

File tree

2 files changed

+41
-3
lines changed

2 files changed

+41
-3
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
![Tests](https://github.com/crate/tsperf/workflows/Tests/badge.svg)
1+
# TSPERF Time Series Database Benchmark Suite
22

3-
# `tsperf` - A tool to test performance of time-series databases
3+
TSPERF is a tool for evaluating and comparing the performance of time series databases,
4+
in the spirit of TimescaleDB's Time Series Benchmark Suite (TSBS).
5+
6+
» [Documentation]
7+
| [Changelog]
8+
| [PyPI]
9+
| [Issues]
10+
| [Source code]
11+
| [License]
12+
13+
14+
[![CI][badge-tests]][project-tests]
15+
[![Coverage Status][badge-coverage]][project-codecov]
16+
[![License][badge-license]][project-license]
17+
[![Downloads per month][badge-downloads-per-month]][project-downloads]
18+
19+
[![Supported Python versions][badge-python-versions]][project-pypi]
20+
[![Status][badge-status]][project-pypi]
21+
[![Package version][badge-package-version]][project-pypi]
422

523

624
## About
@@ -251,3 +269,24 @@ in one way or another and kudos to all authors of the foundational libraries.
251269

252270
## License
253271
This project is licensed under the terms of the Apache 2.0 license.
272+
273+
274+
[Changelog]: https://github.com/crate/tsperf/blob/main/CHANGES.md
275+
[Documentation]: https://tsperf.readthedocs.io/
276+
[Issues]: https://github.com/crate/tsperf/issues
277+
[License]: https://github.com/crate/tsperf/blob/main/LICENSE
278+
[PyPI]: https://pypi.org/project/tsperf/
279+
[Source code]: https://github.com/crate/tsperf
280+
281+
[badge-coverage]: https://codecov.io/gh/crate/tsperf/branch/main/graph/badge.svg
282+
[badge-downloads-per-month]: https://pepy.tech/badge/tsperf/month
283+
[badge-license]: https://img.shields.io/github/license/crate/tsperf.svg
284+
[badge-package-version]: https://img.shields.io/pypi/v/tsperf.svg
285+
[badge-python-versions]: https://img.shields.io/pypi/pyversions/tsperf.svg
286+
[badge-status]: https://img.shields.io/pypi/status/tsperf.svg
287+
[badge-tests]: https://github.com/crate/tsperf/actions/workflows/tests.yml/badge.svg
288+
[project-codecov]: https://codecov.io/gh/crate/tsperf
289+
[project-downloads]: https://pepy.tech/project/tsperf/
290+
[project-license]: https://github.com/crate/tsperf/blob/main/LICENSE
291+
[project-pypi]: https://pypi.org/project/tsperf
292+
[project-tests]: https://github.com/crate/tsperf/actions/workflows/tests.yml

setup.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363
"Intended Audience :: System Administrators",
6464
"License :: OSI Approved :: Apache Software License",
6565
"Operating System :: OS Independent",
66-
"Programming Language :: Python :: 3",
6766
"Programming Language :: Python :: 3.8",
6867
"Programming Language :: Python :: 3.9",
6968
"Programming Language :: Python :: 3.10",

0 commit comments

Comments
 (0)