Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info badges to readme #72

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Add info badges to readme #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@

# fredapi: Python API for FRED (Federal Reserve Economic Data)

[![Build and test GitHub](https://github.com/mortada/fredapi/actions/workflows/main.yml/badge.svg)](https://github.com/mortada/fredapi/actions)
[![version](https://img.shields.io/badge/version-0.5.1-success.svg)](#)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just realized this is actually hardcoded to 0.5.1, any idea how to update this, or maybe this should be removed because the latest release is already shown by the line below? thanks!

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @LucaMingarelli

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mortada : ideally they would always show the same version, but they relate to different things: the former is the version on github, the second is the version actually published on pypi. If they differ they serve as a reminder that the latest version available has not been published yet.

One option is of course to update the badge manually, however this master...LucaMingarelli:fredapi:patch-1 can also be used within the workflow to have it done automatically.

It needs to be called from the main.yml like so:
master...LucaMingarelli:fredapi:patch-2

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uff, there's a typo on this master...LucaMingarelli:fredapi:patch-1: line 25 should be f.write(README_NEW) ...

[![PyPI Latest Release](https://img.shields.io/pypi/v/fredapi.svg)](https://pypi.org/project/fredapi/)
[![Downloads](https://static.pepy.tech/personalized-badge/fredapi?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/fredapi)

`fredapi` is a Python API for the [FRED](http://research.stlouisfed.org/fred2/) data provided by the
Federal Reserve Bank of St. Louis. `fredapi` provides a wrapper in python to the
[FRED web service](http://api.stlouisfed.org/docs/fred/), and also provides several convenient methods
Expand Down
Loading