Swiftpack.co - Package - TonyTang2001/HummingKit

HummingKit

HummingKit is an SDK (Software Development Kit) designed to ease the use of Apple Music API. Written in Swift 5.2, HummingKit takes advantage of Swift's outstanding performance and latest features, offering an approachable entry for developers dealing with the Apple Music API.


NEWS

HummingKit 1.1.0 has been RELEASED! HummingKit 1.1.0 contains functionality improvements and addition, compatibility changes, and bug fixes.


Features

HummingKit provides a friendly way to deal with the Apple Music API by handling burdensome works, such as composing and conducting requests, handling status and errors, parsing responses and more.

  • ☑ Apple Music API High Coverage
  • ☑ Apple Music API User Privacy Verification
  • ☑ Apple Music API Request Authentication
  • ☑ Apple Music API Request URL / JSON Parameter Encoding
  • ☑ Apple Music API Request Pagination
  • ☑ Apple Music API Request Asynchronous Status Handling
  • ☑ Apple Music API Response Decoding
  • ☑ Apple Music API Resource Relationships Fetching
  • Documentation

Requirements

  • Swift 5.2+
  • Xcode 11+
  • iOS 11.0+ / macOS 10.13+ * / tvOS 11.0+ / watchOS 4.0+ * (*) For certain functionalities, macOS 11.0+ / watchOS 7.0+ are required.

Integration

HummingKit comes with flexibility in terms of integration. From importing it as a dependency of your projects, to building frameworks upon it, HummingKit provides an optimal integration solution.

Swift Package Manager

Swift Package Manager is a tool for automating the distribution of Swift code specifically. HummingKit supports Swift Package from design.


NOTE

Once a Swift Package is added to an Xcode project, the package's dependency repositories are also added to the project automatically. HummingKit is of no exception of this rule.


In Your Xcode Project

When your project is opened in Xcode, select File > Swift Packages > Add Package Dependency from the menu bar. Enter https://github.com/TonyTang2001/HummingKit.git once prompted to do so. After specifying Rules in accordance to your need and select Target to add to, HummingKit is successfully added to your project as a Swift Package.

In Your Framework

Once your Swift package is set up, add HummingKit as a dependency by adding it to the dependencies value of your Package.swift.

dependencies: [
.package(url: "https://github.com/TonyTang2001/HummingKit.git", .upToNextMajor(from: "1.0.0"))
]

Community

HummingKit embraces developer community as an indispensable factor for creations and improvements. Everyone is welcome to collaborate on this project and providing feedbacks and suggestions.

Feel free to ask questions if you have one!

Collaboration

All scales of collaboration are welcome. From introducing a grand feature to fixing a typo among in-line comments, you are improving this project and contributing to the whole open-source community.

Q&A

There might be questions regarding certain functionality or blocks of codes, or you may have found a serious bug in this project. Please file an issue in this repository. Your words are important!

Dependencies

HummingKit is built upon widely-adopted frameworks for a portion of its functionality.

Github

link
Stars: 9

Used By

Total: 0

Releases

HummingKit v.1.1.1 - 2020-09-27 07:33:41

Version 1.1.1 of HummingKit is now published! This update contains fix of a fatal bug.

Bug Fixes

  • Fixed a bug preventing all CatalogSong related parsing to fail for the current version of Apple Music API.

HummingKit v.1.1.0 - 2020-09-26 23:21:30

First Minor Update Version 1.1.0 of HummingKit is now published! This minor update contains functionality improvements and addition, compatibility changes, and bug fixes.

Functionality Changes

  • HummingKitEnvironmentError now supports systemVersionIncompatible case, which describes API functionality incompatibility issues that occurred due to environment, not necessarily caused by system version being outdated. (Addition)
  • HummingKitAuthentication now supports fetchSubscriptionStatus() function, which fetch user's Apple Music account subscription status. (Addition)

Compatibility Changes

  • HummingKitAuthentication no longer causes compilation errors on certain versions of macOS. (Compatibility Improvement)

Bug Fixes

  • Fixed a few typos in code comment and documentation.

HummingKit v.1.0.0 - 2020-08-30 03:03:17

First Release Version 1.0.0 of HummingKit is now published!

HummingKit is an SDK (Software Development Kit) designed to ease the use of Apple Music API. Written in Swift 5.2, HummingKit takes advantage of Swift's outstanding performance and latest features, offering an approachable entry for developers dealing with the Apple Music API. Refer README for more.

HummingKit 1.0.0, is considered to be the first released version that can be widely adopted as a swift package dependency in projects or other frameworks.

Compared to HummingKit 0.9.0, version 1.0.0 comes with Documentation generated using Jazzy, and hosted as a GitHub page as per users' convenience.

The following minor versions (1.x.x) of HummingKit will be focusing on improving performance and fixing existing bugs, along with a limited number of new APIs.

The following major versions (2.x.x) of HummingKit will be bringing whole new sets of functionalities, including integration with MediaPlayer framework by Apple, aiming to provide all-in-one media control and playback features.

HummingKit 1.0.0 Major Functionality Completed - 2020-08-03 03:46:39

Release Version 0.9.0 of HummingKit is published for use.

HummingKit is an SDK (Software Development Kit) designed to ease the use of Apple Music API. Written in Swift 5.2, HummingKit takes advantage of Swift's outstanding performance and latest features, offering an approachable entry for developers dealing with the Apple Music API. Refer README for more.

Current Version, HummingKit 0.9.0, is considered to be the first version that is usable as a swift package in projects or other frameworks in the wild.

  • The majority of HummingKit 1.0.0 functionality has finished development and passed the first tests.
  • README is written, providing a general guidance of HummingKit.
  • Documentation is being drafted for the 1.0.0 release.