app-store-reviews

1.0.0

Swift Package to download user reviews from the Apple App Store.
jcoynel/app-store-reviews-swift

What's New

2021-04-27T21:25:08Z
  • Initial release

Swift 5.3 CI codecov SPM compatible

About AppStoreReviews

AppStoreReviews is a Swift Package to download user reviews from the iTunes Store and the Mac App Store.

It supports:

  • All countries
  • All apps on the iTunes Store
  • All apps on the Mac App Store

This module uses the public feed to customer reviews: https://itunes.apple.com/rss/customerreviews/page=1/id=1510826067/sortby=mostrecent/json?l=en&cc=gb

Installation

Swift Package Manager

Adding AppStoreReviews as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/jcoynel/app-store-reviews-swift.git", .upToNextMajor(from: "1.0.0")),
]

Mint

$ mint install jcoynel/app-store-reviews-swift

Usage

As a command line tool when installed with Mint

app-store-reviews includes several subcommands and options:

OVERVIEW: Fetch user reviews from the Apple App Stores.

USAGE: app-store-reviews [--version] <subcommand>

OPTIONS:
  -v, --version           Print the version and exit. 
  -h, --help              Show help information.

SUBCOMMANDS:
  reviews                 Fetch all the reviews from the App Store Reviews feed for the provided app ID and territory.
  page                    Fetch the App Store Reviews feed page for the provided app ID, territory and page number.
  territories             Print the list of territories reviews can be fetched for.

  See 'app-store-reviews help <subcommand>' for detailed help.

territories

OVERVIEW: Print the list of territories reviews can be fetched for.

USAGE: app-store-reviews territories

OPTIONS:
  -h, --help              Show help information.

Examples:

$ app-store-reviews territories

reviews

OVERVIEW: Fetch all the reviews from the App Store Reviews feed for the provided app ID and territory.

USAGE: app-store-reviews reviews <app-id> <territory> <file-output>

ARGUMENTS:
  <app-id>                The ID of the app. 
  <territory>             App Store country or region. 
  <file-output>           The reviews file output. 

OPTIONS:
  -h, --help              Show help information.

Examples:

$ app-store-reviews reviews 555731861 GB reviews_555731861_GB.json
$ app-store-reviews reviews 497799835 US reviews_497799835_US.json

page

OVERVIEW: Fetch the App Store Reviews feed page for the provided app ID, territory and page number.

USAGE: app-store-reviews page <app-id> <territory> <page> <file-output>

ARGUMENTS:
  <app-id>                The ID of the app. 
  <territory>             App Store country or region. 
  <page>                  The page number. 
  <file-output>           The reviews file output. 

OPTIONS:
  -h, --help              Show help information.

Examples:

$ app-store-reviews page 555731861 GB 1 page_555731861_1_GB.json
$ app-store-reviews page 497799835 US 1 page_497799835_1_US.json
$ app-store-reviews page 497799835 US 5 page_497799835_5_US.json

As a library

Add the following to your Package.swift file's dependencies:

.package(url: "https://github.com/jcoynel/app-store-reviews-swift.git", .upToNextMajor(from: "1.0.0")),

And then import wherever needed:

import AppStoreReviews

Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

Last updated: Wed Nov 10 2021 20:01:59 GMT-0500 (GMT-05:00)