From 1edfd52ce491c171ce8deb5ca2192e75a2b2640d Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 14:40:44 -0400 Subject: [PATCH 1/9] Add badges --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index cb6bd8e5..e558b4aa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # clp-ffi-py +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)](https://pepy.tech/project/clp-ffi-py) +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)](https://pepy.tech/project/clp-ffi-py) + This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library supplies built-in functions for serializing/deserializing log messages using [CLP][2]. From 68cc61f010e6882c2aa7e7951c24b6900b4e4f81 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 14:45:20 -0400 Subject: [PATCH 2/9] Update readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e558b4aa..e0bea9fc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # clp-ffi-py -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)](https://pepy.tech/project/clp-ffi-py) -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)](https://pepy.tech/project/clp-ffi-py) +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)][pypy/clp-ffi-py] +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)][pypy/clp-ffi-py] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library @@ -335,3 +335,5 @@ other package management tools such as `apt-get`: [17]: https://github.com/RaRe-Technologies/smart_open [18]: https://taskfile.dev/installation/ [19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html + +[pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py From 5414e958406aebc54e6ae7176fb00f8a0aed1c0b Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 14:46:22 -0400 Subject: [PATCH 3/9] Update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e0bea9fc..8a071873 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # clp-ffi-py -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)][pypy/clp-ffi-py] -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)][pypy/clp-ffi-py] +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)][pepy/clp-ffi-py] +[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)][pepy/clp-ffi-py] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library From 960ed598c91ece0be5d00a18d01d91b4f810ab61 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 15:49:39 -0400 Subject: [PATCH 4/9] Refactor links --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a071873..7900f9da 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # clp-ffi-py -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py)][pepy/clp-ffi-py] -[![Downloads](https://static.pepy.tech/badge/clp-ffi-py/month)][pepy/clp-ffi-py] +[![Downloads][clp-ffi-py-total-downloads]][pepy/clp-ffi-py] +[![Downloads][clp-ffi-py-monthly-downloads]][pepy/clp-ffi-py] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library @@ -336,4 +336,6 @@ other package management tools such as `apt-get`: [18]: https://taskfile.dev/installation/ [19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html +[clp-ffi-py-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py +[clp-ffi-py-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month [pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py From 6ee3094bbbe650fe3c84b22055bc129d91cb4d1d Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 16:05:54 -0400 Subject: [PATCH 5/9] Add more badges --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7900f9da..b7bd1dd9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # clp-ffi-py -[![Downloads][clp-ffi-py-total-downloads]][pepy/clp-ffi-py] -[![Downloads][clp-ffi-py-monthly-downloads]][pepy/clp-ffi-py] +[![PyPI platforms][badge-pypi]][16] +[![Downloads][badge-total-downloads]][pepy/clp-ffi-py] +[![Downloads][badge-monthly-downloads]][pepy/clp-ffi-py] +[![Actions Status][badge-actions]][gh-action] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library @@ -336,6 +338,8 @@ other package management tools such as `apt-get`: [18]: https://taskfile.dev/installation/ [19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html -[clp-ffi-py-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py -[clp-ffi-py-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month +[badge-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month +[badge-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py +[badge-pypi]: https://badge.fury.io/py/clp-ffi-py.svg +[gh-action]: https://github.com/y-scope/clp-ffi-py/actions [pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py From 25d61f19ed303298b61f5dc38f681ad836b1f947 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 16:08:43 -0400 Subject: [PATCH 6/9] Update readme --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b7bd1dd9..bd82037a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![PyPI platforms][badge-pypi]][16] [![Downloads][badge-total-downloads]][pepy/clp-ffi-py] [![Downloads][badge-monthly-downloads]][pepy/clp-ffi-py] -[![Actions Status][badge-actions]][gh-action] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library @@ -341,5 +340,4 @@ other package management tools such as `apt-get`: [badge-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month [badge-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py [badge-pypi]: https://badge.fury.io/py/clp-ffi-py.svg -[gh-action]: https://github.com/y-scope/clp-ffi-py/actions [pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py From f03955302787ff32a987857784cf098cf6814250 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 16:17:59 -0400 Subject: [PATCH 7/9] Fix readme --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bd82037a..55ab7e5c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # clp-ffi-py -[![PyPI platforms][badge-pypi]][16] -[![Downloads][badge-total-downloads]][pepy/clp-ffi-py] -[![Downloads][badge-monthly-downloads]][pepy/clp-ffi-py] +[![PyPI platforms][badge_pypi]][16] +[![Build Status][badge_build_status]][clp_ffi_py_gh_actions] +[![Downloads][badge_total_downloads]][pepy/clp_ffi_py] +[![Downloads][badge_monthly_downloads]][pepy/clp_ffi_py] This module provides Python packages to interface with [CLP Core Features][1] through CLP's FFI (foreign function interface). At present, this library @@ -337,7 +338,9 @@ other package management tools such as `apt-get`: [18]: https://taskfile.dev/installation/ [19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html -[badge-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month -[badge-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py -[badge-pypi]: https://badge.fury.io/py/clp-ffi-py.svg -[pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py +[badge_monthly_downloads]: https://static.pepy.tech/badge/clp-ffi-py/month +[badge_total_downloads]: https://static.pepy.tech/badge/clp-ffi-py +[badge_pypi]: https://badge.fury.io/py/clp-ffi-py.svg +[badge_build-status]: https://github.com/y-scope/clp-ffi-py/workflows/Build/badge.svg +[clp_ffi_py_gh_actions]: https://github.com/y-scope/clp-ffi-py/actions +[pepy/clp-ffi_py]: https://pepy.tech/project/clp-ffi-py From 75e530d9f743c167ed3483a5b40d2cd4f3a5e306 Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 16:20:38 -0400 Subject: [PATCH 8/9] Fix readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 55ab7e5c..383e9be3 100644 --- a/README.md +++ b/README.md @@ -341,6 +341,6 @@ other package management tools such as `apt-get`: [badge_monthly_downloads]: https://static.pepy.tech/badge/clp-ffi-py/month [badge_total_downloads]: https://static.pepy.tech/badge/clp-ffi-py [badge_pypi]: https://badge.fury.io/py/clp-ffi-py.svg -[badge_build-status]: https://github.com/y-scope/clp-ffi-py/workflows/Build/badge.svg +[badge_build_status]: https://github.com/y-scope/clp-ffi-py/workflows/Build/badge.svg [clp_ffi_py_gh_actions]: https://github.com/y-scope/clp-ffi-py/actions -[pepy/clp-ffi_py]: https://pepy.tech/project/clp-ffi-py +[pepy/clp_ffi_py]: https://pepy.tech/project/clp-ffi-py From 0fa167ea630afda0f6a92c6a3fda6fa45050e5bc Mon Sep 17 00:00:00 2001 From: LinZhihao-723 Date: Thu, 24 Oct 2024 20:27:39 -0400 Subject: [PATCH 9/9] Apply code review comments --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 383e9be3..91f8a063 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # clp-ffi-py [![PyPI platforms][badge_pypi]][16] -[![Build Status][badge_build_status]][clp_ffi_py_gh_actions] +[![Build status][badge_build_status]][clp_ffi_py_gh_actions] [![Downloads][badge_total_downloads]][pepy/clp_ffi_py] [![Downloads][badge_monthly_downloads]][pepy/clp_ffi_py] @@ -338,9 +338,9 @@ other package management tools such as `apt-get`: [18]: https://taskfile.dev/installation/ [19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html +[badge_build_status]: https://github.com/y-scope/clp-ffi-py/workflows/Build/badge.svg [badge_monthly_downloads]: https://static.pepy.tech/badge/clp-ffi-py/month -[badge_total_downloads]: https://static.pepy.tech/badge/clp-ffi-py [badge_pypi]: https://badge.fury.io/py/clp-ffi-py.svg -[badge_build_status]: https://github.com/y-scope/clp-ffi-py/workflows/Build/badge.svg +[badge_total_downloads]: https://static.pepy.tech/badge/clp-ffi-py [clp_ffi_py_gh_actions]: https://github.com/y-scope/clp-ffi-py/actions [pepy/clp_ffi_py]: https://pepy.tech/project/clp-ffi-py