https://github.com/lnxpy/pypi-chart-badge

PyPI download rate badge generator.
https://github.com/lnxpy/pypi-chart-badge

Last synced: 5 months ago
JSON representation

PyPI download rate badge generator.

• Host: GitHub
• URL: https://github.com/lnxpy/pypi-chart-badge
• Owner: lnxpy
• License: mit
• Created: 2024-10-02T01:09:23.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-02-12T12:16:24.000Z (5 months ago)
• Last Synced: 2026-02-12T21:01:28.672Z (5 months ago)
• Language: Python
• Homepage:
• Size: 271 KB
• Stars: 13
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## PyPI Chart Badge [![pyaction](https://img.shields.io/badge/PyAction-black?style=flat&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2MDAgNjAwIj4KICA8ZGVmcz4KICAgIDxzdHlsZT4KICAgICAgLmNscy0xIHsKICAgICAgICBmaWxsOiAjZmZmOwogICAgICAgIGZpbGwtcnVsZTogZXZlbm9kZDsKICAgICAgfQogICAgPC9zdHlsZT4KICA8L2RlZnM+CiAgPGcgaWQ9IlNWR1JlcG9faWNvbkNhcnJpZXIiIGRhdGEtbmFtZT0iU1ZHUmVwbyBpY29uQ2FycmllciI+CiAgICA8cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik0zNjAuNywyMjAuNDNsMjMzLjUzLDI1Mi4zMkwzMzEuNTksMTguODksNS45Niw1ODEuM0gzNzUuMmwtMjI0LjMxLTY1LjUzYy0xMi42MS0zLjY5LTE3Ljc5LTE4Ljc0LTEwLjA3LTI5LjRMMzMxLjM5LDIyMi4xOGM2Ljk4LTkuNzIsMjEuMTgtMTAuNTcsMjkuMy0xLjc0WiIvPgogIDwvZz4KPC9zdmc+)](https://pyaction.imsadra.me/)

This action allows you to create and put fancy-looking chart badges indicating the recent download rate of your Python packages in the README.

> [!NOTE]

> Read [this article](https://blog.imsadra.me/display-your-package-download-rate-on-github) to learn how this action works and how to use it in your repositories.

### Examples

This chart depicts the download rate of some popular Python packages over the last 15 days. (It dynamically updates every 24 hours)

| fastapi | django | requests | pydantic |

| ------- | ------ | -------- | ---- |

| ![](.pypi_chart/artifact/fastapi_badge.svg) | ![](.pypi_chart/artifact/django_badge.svg) | ![](.pypi_chart/artifact/requests_badge.svg) | ![](.pypi_chart/artifact/pydantic_badge.svg) |

### Basic Usage

```yml

name: Update the PyPI chart badge

on:

  schedule:

    - cron: "0 0 1 * *"  # <= runs every month

jobs:

  update-chart-badge:

    name: Updating the pypi chart badge

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Updating the badge

        uses: lnxpy/pypi-chart-badge@v1.4

        with:

          package_name: ''

      - uses: EndBug/add-and-commit@v9

        with:

          default_author: github_actions

          message: 'chart badge updated'

```

After each run, you'll have your badge stored in `.pypi_chart/badge.svg` of your repository.

> [!IMPORTANT]

> You have to give the "Write Access" to your workflow so that changes can be committed back into the repo.

### Options

| Option              | Default value  | Description                                                                                     | Required |

| :-----------------: | :------------: |-------------------------------------------------------------------------------------------------|:--------:|

| `package_name`      | -              | The Package name                                                                                | Yes      |

| `badge_width`       | `60`           | Badge width size in pixels                                                                      | No       |

| `badge_height`      | `20`           | Badge height size in pixels                                                                     | No       |

| `badge_color`       | `'#4492F9'`    | Badge plot color (HEX or CSS color names)                                                       | No       |

| `badge_dark_color`  | `'#4492F9'`    | Badge plot dark color (HEX or CSS color names)                                                  | No       |

| `days_limit`        | `15`           | The amount of selected days                                                                     | No       |

| `output_path`       | `.pypi_chart/` | Badge file path directory                                                                       | No       |

| `file_name`         | `badge.svg`    | Badge file name and extension (`.png`, `.jpg`, `.jpeg`, `.webp`, and `.pdf` are also supported) | No       |

### License

MIT license terms.