app-store-download-count-badge-maker

A command-line tool to create badges displaying the number of app downloads from App Store

Installation

$ pip install app-store-download-count-badge-maker

or

$ pipx install app-store-download-count-badge-maker

Required

• Python 3.10 or later

Features

• Generate badges for the App Store download count.
  • app-store-download-count-badge-maker generate command.
• Generate index.html from config.yml.
  • app-store-download-count-badge-maker make-index command.

Usage

$ app-store-download-count-badge-maker generate \
  --config config.yml \
  --output dist

By default, the --config (or -c) option is set to config.yml and the --output (or -o) options is set to dist.

Note

The count is based on 3 days prior to the execution date.

Configuration

Create a configuration file in YAML format.
The recommended name is config.yml.

Configuration Details

The configuration file config.yml should contain the following sections:

• secrets: This section holds the credentials required to access the App Store Connect API.
  • private_key: Path to the private key file (e.g., private.p8). The private key must have access Finance.
  • issuer_id: The issuer ID from App Store Connect.
  • key_id: The key ID from App Store Connect.
  • vendor_number: The vendor number associated with your App Store account. View payments and proceeds
• apps: A list of applications for which you want to create download count badges.
  • apple_identifier: The unique identifier for the app in the App Store.
  • frequency: The frequency at which you want to generate the badge. Must be one of DAILY, WEEKLY, MONTHLY, YEARLY.
  • badge_style (Optional): The style of the badge. Must be one of flat (default), flat-square, plastic, for-the-badge, social.

Example Configuration

secrets:
  private_key: private.p8
  issuer_id: 12345678-1234-1234-1234-123456789012
  key_id: 12345678
  vendor_number: 12345678
apps:
  - apple_identifier: 1289764391
    frequency: MONTHLY
  - apple_identifier: 1234567890
    frequency: WEEKLY
    badge_style: flat-square

Badge Creation ✨

This tool uses Shields.io to create badges displaying the number of app downloads from App Store.

Examples

Frequency	Badge Style
YEARLY
MONTHLY
WEEKLY
DAILY

Projects using app-store-download-count-badge-maker

• nnsnodnb/self-app-store-download-count-badges

License

This software is licensed under the MIT License.