Skip to main content

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

Project description

app-store-download-count-badge-maker

Code style: black

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.9 or later

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


Download files

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

Source Distribution

Built Distribution

File details

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

File metadata

File hashes

Hashes for app_store_download_count_badge_maker-0.2.2.tar.gz
Algorithm Hash digest
SHA256 2d9914ac77b24d5ec956a4f28b24f9e4e32b929bf780e8819d0e9869b7c0b75a
MD5 1d801253cd110af1bc928b494d8288d1
BLAKE2b-256 831bc9a18d383a702521400b42bb2950addfcabb02a99103f4ec983d68518174

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for app_store_download_count_badge_maker-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 93b60e7808577436edda26ee25e83ef7900b261d3f3799b1f3719c0b413892d8
MD5 e2cdad36ac7136d945c567c0ed8a0f7f
BLAKE2b-256 b708588bb62930c290e2af3b4528c91ba20fd98e2dda881fc9532fa73b89c05a

See more details on using hashes here.

Supported by

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