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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for nnsnodnb from gravatar.com nnsnodnb

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

app-store-download-count-badge-maker

uv Ruff

PyPI Package version Python Supported versions format implementation LICENSE

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 :sparkles:

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

Examples

Frequency Badge Style
YEARLY year-flat year-flat-square year-plastic year-for-the-badge year-social
MONTHLY month-flat month-flat-square month-plastic month-for-the-badge month-social
WEEKLY week-flat week-flat-square week-plastic week-for-the-badge week-social
DAILY day-flat day-flat-square day-plastic day-for-the-badge day-social

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

License

This software is licensed under the MIT License.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for nnsnodnb from gravatar.com nnsnodnb

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.4.0

0.3.0

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0 yanked

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

app_store_download_count_badge_maker-0.4.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

app_store_download_count_badge_maker-0.4.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file app_store_download_count_badge_maker-0.4.0.tar.gz.

File metadata

File hashes

Hashes for app_store_download_count_badge_maker-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a510670c6f08589bc938c615a0ccf5fa9a0b2a0932b50a2981f01915f8b22e6e
MD5 8c3946267b4654ebcea282ef9df99fd7
BLAKE2b-256 80af0e41078ba1944ed3e413b2971bc7308f988bb0621155022802230d26a9c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for app_store_download_count_badge_maker-0.4.0.tar.gz:

Publisher: release.yml on nnsnodnb/app-store-download-count-badge-maker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file app_store_download_count_badge_maker-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for app_store_download_count_badge_maker-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9b026f313e3ce202157f699084a06a38e57663f0096a043db4c3fa6f2e81617c
MD5 fcb067d0281448e6f5edc63cdf1eae07
BLAKE2b-256 eecc57a046c1239ac1c9ad95a4a2d7aa0280007f140c23ae370faa9e7e7e70d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for app_store_download_count_badge_maker-0.4.0-py3-none-any.whl:

Publisher: release.yml on nnsnodnb/app-store-download-count-badge-maker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page