:warning: GatheredKit it currently in a pre-release beta. The API is unstable, although the only large planned breaking fix is to introduce structured concurrency for thread safety.
GatheredKit a protocol-oriented API for various data sources offered by macOS, iOS, watchOS, and tvOS.
The code originated from Gathered, hence the name and logo. Prior to version 2.0 Gathered used a closed-source version of GatheredKit. Version 2.0 is currently in beta and can accessed via TestFlight.
GatheredKit provides multiple libraries that each provide one or more data sources. This is done to allow the a subset of the data sources to be included, which aids with documentation, discovery, and ensures that consumers do not accidentally include APIs that require extra permissions, such as accessing the IDFA.
Each of these libraries roughly correlates to one of Apple's frameworks.
GatheredKit library is the core library that provides the types used by data sources, but it does not provide any of the data sources itself.
GatheredKitCamera provides access to cameras, both built-in and external. The
CameraProvider can be used to query for connected cameras. It wraps the
GatheredKitDevice provides various sources relating to the current device.
GatheredKitLocation provides the
Location data source, which is used to access location-based information provided by the GPS and associated sensors. It relies on the Core Location framework.
GatheredKitMotion provides data sources that utilise the
CoreMotion framework, such as an
GatheredKitProcessInfo provides information relating to the computer the process is running on.
GatheredKitScreen provides access to the screens associated with the device.
Below are the sources that are available in the Gathered app but have not yet been added to this open source project.
To install via SwiftPM add the package to the dependencies section and as the dependency of a target:
let package = Package( ... dependencies: [ .package(url: "https://github.com/JosephDuffy/GatheredKit.git", from: "0.1.0"), ], targets: [ .target(name: "MyApp", dependencies: ["GatheredKit"]), ], ... )
Documentation for GatheredKit is provided in the source code. Browsable documentation is available at https://josephduffy.github.io/GatheredKit/.
The project is released under the MIT license. View the LICENSE file for the full license.