# app-store-download-count-badge-maker
[](https://github.com/psf/black)
[](https://pypi.org/project/app-store-download-count-badge-maker)
[](https://pypi.org/project/app-store-download-count-badge-maker)
[](https://pypi.org/project/app-store-download-count-badge-maker)
[](https://pypi.org/project/app-store-download-count-badge-maker)
[](https://pypi.org/project/app-store-download-count-badge-maker)
A command-line tool to create badges displaying the number of app downloads from App Store
## Installation
```shell
$ pip install app-store-download-count-badge-maker
```
or
```shell
$ pipx install app-store-download-count-badge-maker
```
## Required
- Python 3.9 or later
## Usage
```shell
$ 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](https://developer.apple.com/help/app-store-connect/getting-paid/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
```yaml
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](https://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](https://github.com/nnsnodnb/self-app-store-download-count-badges)
## License
This software is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/nnsnodnb/app-store-download-count-badge-maker",
"name": "app-store-download-count-badge-maker",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": "apple, app store, badge, download count",
"author": "nnsnodnb",
"author_email": "nnsnodnb@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/34/50/4934c377424284fab8f105721be9b4176d9586c8a3a7f6a613f6631e1d31/app_store_download_count_badge_maker-0.2.3.tar.gz",
"platform": null,
"description": "# app-store-download-count-badge-maker\n\n[](https://github.com/psf/black)\n\n[](https://pypi.org/project/app-store-download-count-badge-maker)\n[](https://pypi.org/project/app-store-download-count-badge-maker)\n[](https://pypi.org/project/app-store-download-count-badge-maker)\n[](https://pypi.org/project/app-store-download-count-badge-maker)\n[](https://pypi.org/project/app-store-download-count-badge-maker)\n\n\nA command-line tool to create badges displaying the number of app downloads from App Store\n\n## Installation\n\n```shell\n$ pip install app-store-download-count-badge-maker\n```\n\nor\n\n```shell\n$ pipx install app-store-download-count-badge-maker\n```\n\n## Required\n\n- Python 3.9 or later\n\n## Usage\n\n```shell\n$ app-store-download-count-badge-maker generate \\\n --config config.yml \\\n --output dist\n```\n\nBy default, the `--config (or -c)` option is set to `config.yml` and the `--output (or -o)` options is set to `dist`.\n\n> [!NOTE]\n> The count is based on 3 days prior to the execution date.\n\n## Configuration\n\nCreate a configuration file in YAML format. \nThe recommended name is `config.yml`.\n\n### Configuration Details\n\nThe configuration file `config.yml` should contain the following sections:\n\n- `secrets`: This section holds the credentials required to access the App Store Connect API.\n - `private_key`: Path to the private key file (e.g., `private.p8`). The private key must have access **Finance**.\n - `issuer_id`: The issuer ID from App Store Connect.\n - `key_id`: The key ID from App Store Connect.\n - `vendor_number`: The vendor number associated with your App Store account. [View payments and proceeds](https://developer.apple.com/help/app-store-connect/getting-paid/view-payments-and-proceeds)\n- `apps`: A list of applications for which you want to create download count badges.\n - `apple_identifier`: The unique identifier for the app in the App Store.\n - `frequency`: The frequency at which you want to generate the badge. Must be one of `DAILY`, `WEEKLY`, `MONTHLY`, `YEARLY`.\n - `badge_style` (Optional): The style of the badge. Must be one of `flat` (default), `flat-square`, `plastic`, `for-the-badge`, `social`.\n\n### Example Configuration\n\n```yaml\nsecrets:\n private_key: private.p8\n issuer_id: 12345678-1234-1234-1234-123456789012\n key_id: 12345678\n vendor_number: 12345678\napps:\n - apple_identifier: 1289764391\n frequency: MONTHLY\n - apple_identifier: 1234567890\n frequency: WEEKLY\n badge_style: flat-square\n```\n\n## Badge Creation :sparkles:\n\nThis tool uses [Shields.io](https://shields.io/) to create badges displaying the number of app downloads from App Store.\n\n### Examples\n\n| Frequency | Badge Style |\n|:-----------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| YEARLY |      |\n| MONTHLY |      |\n| WEEKLY |      |\n| DAILY |      |\n\n## Projects using `app-store-download-count-badge-maker`\n\n- [nnsnodnb/self-app-store-download-count-badges](https://github.com/nnsnodnb/self-app-store-download-count-badges)\n\n## License\n\nThis software is licensed under the MIT License.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool to create badges displaying the number of app downloads from App Store",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/nnsnodnb/app-store-download-count-badge-maker",
"Repository": "https://github.com/nnsnodnb/app-store-download-count-badge-maker"
},
"split_keywords": [
"apple",
" app store",
" badge",
" download count"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6ebb26f74ed5e1f4c9d1cb899d37ca73675f412cca04f94df773344ccc6a0de",
"md5": "e7767829d334566dfc49e33f9e2ca695",
"sha256": "dbdca242d25b8239235fd7e8835e1eeb4b444d64dd9814e519c618a4a861e226"
},
"downloads": -1,
"filename": "app_store_download_count_badge_maker-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7767829d334566dfc49e33f9e2ca695",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 9255,
"upload_time": "2024-12-10T11:18:12",
"upload_time_iso_8601": "2024-12-10T11:18:12.573753Z",
"url": "https://files.pythonhosted.org/packages/c6/eb/b26f74ed5e1f4c9d1cb899d37ca73675f412cca04f94df773344ccc6a0de/app_store_download_count_badge_maker-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "34504934c377424284fab8f105721be9b4176d9586c8a3a7f6a613f6631e1d31",
"md5": "ffa02c8dfdd3865775e5fcb778b0c311",
"sha256": "d5d90274df2505f65dad842654d1ed9f423c5c91404117ed2f28168e24cd0d98"
},
"downloads": -1,
"filename": "app_store_download_count_badge_maker-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "ffa02c8dfdd3865775e5fcb778b0c311",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 8447,
"upload_time": "2024-12-10T11:18:14",
"upload_time_iso_8601": "2024-12-10T11:18:14.917519Z",
"url": "https://files.pythonhosted.org/packages/34/50/4934c377424284fab8f105721be9b4176d9586c8a3a7f6a613f6631e1d31/app_store_download_count_badge_maker-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 11:18:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nnsnodnb",
"github_project": "app-store-download-count-badge-maker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "app-store-download-count-badge-maker"
}
JSON
