Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bdrelling/kipple
A collection of tools and scripts for use across a variety of Swift projects.
https://github.com/bdrelling/kipple
swift
Last synced: about 2 months ago
JSON representation
A collection of tools and scripts for use across a variety of Swift projects.
- Host: GitHub
- URL: https://github.com/bdrelling/kipple
- Owner: bdrelling
- License: mit
- Created: 2020-08-06T06:09:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-04T02:05:20.000Z (7 months ago)
- Last Synced: 2024-10-14T09:08:39.833Z (2 months ago)
- Topics: swift
- Language: Swift
- Homepage: https://swiftpackageindex.com/swift-kipple/Core
- Size: 19.4 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kipple
[](https://github.com/bdrelling/Kipple/tags)
[](https://swiftpackageindex.com/bdrelling/Kipple)
[](https://swiftpackageindex.com/bdrelling/Kipple)
[](https://github.com/bdrelling/Kipple/blob/main/LICENSE)
[](https://github.com/bdrelling/Kipple/actions/workflows/apple_tests.yml)
[](https://github.com/bdrelling/Kipple/actions/workflows/linux_tests.yml)
[](https://codecov.io/gh/bdrelling/Kipple)
**Kipple** is a collection of Swift modules providing common Swift functionality for rapid prototyping, quick reference, education, discovery, and personal use, covering concepts from logging to error handling to running Swift excutables and more.
> [!WARNING]
> The code in this library has been made public as-is solely for the purposes of reference, education, discovery, and personal use. As such, stability for production applications **CANNOT** be guaranteed; however, if you're interested in leveraging code within this library in your own projects, feel free to do so at your own risk.
>
> Please open GitHub issues for any problems you encounter or requests you have and we will do my best to provide support.
## Table of Contents
- [Documentation](#documentation)
- [Modules](#modules)
- [Dependencies](#dependencies)
- [Component Libraries](#component-libraries)
- [Installation](#installation)
- [Compatibility](#compatibility)
- [Stability](#stability)
- [Contributing](#contributing)
- [FAQ](#faq)
- [License](#license)
## Documentation
### Modules
> [!NOTE]
> All documentation links below are for `main`, which is unstable. For version-specific documentation, use the **View latest release documentation** link at the top of the documentation's page.
| Name | Documentation | Description |
| ---- | ------------- | ----------- |
| [Kipple](/Sources/Kipple) | | An umbrella module that implicitly imports all other modules. |
| [KippleCodable](/Sources/KippleCodable) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplecodable) | Convenience functionality for `Codable`. |
| [KippleCollections](/Sources/KippleCollections) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplecollections) | Convenience functionality for `Collections`. Imports `OrderedCollections`. |
| [KippleCombine](/Sources/KippleCombine) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplecombine) | Convenience functionality for `Combine`. |
| [KippleFoundation](/Sources/KippleFoundation) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplefoundation) | Convenience functionality for `Foundation`. |
| [KippleDevice](/Sources/KippleDevice) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kippledevice) | Convenience functionality around `UIDevice`. Imports `DeviceKit` on iOS, tvOS, and watchOS, but returns hardcode values on macOS. |
| [KippleKeychain](/Sources/KippleKeychain) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplekeychain) | Convenience functionality for [Apple Keychain Services](https://developer.apple.com/documentation/security/keychain_services/). Imports `KeychainAccess`. |
| [KippleLocalStorage](/Sources/KippleLocalStorage) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplelocalstorage) | Convenience Functionality for `UserDefaults`. |
| [KippleLogging](/Sources/KippleLogging) | [Documentation](https://swiftpackageindex.com/bdrelling/Kipple/main/documentation/kipplelogging) | Convenience functionality for all things logging. Imports `swift-log` on Linux, but uses `OSLog` on Apple platforms. |
### Dependencies
**Kipple** aims to keep third-party dependencies very light. That said, there are some that have become absolutely critical to everyday functionality, which **Kipple** depends upon as needed.
Thankfully, the Swift compiler is efficient and dependent modules are _only_ compiled if your project references them. For example, `swift-log` will only be compiled if you depend upon `KippleLogging`, but if you only depend upon `KippleFoundation`, then `swift-log` is not compiled.
Please note that Swift Package Manager will still check out all dependencies (except for those only depended upon by the test targets of other packages), but these should all be light enough to checkout and resolve extremely quickly.
- [apple/swift-collections](https://github.com/apple/swift-collections) — Commonly used data structures for Swift.
- [apple/swift-log](https://github.com/apple/swift-log) — A cross-platform Logging API for Swift.
- [devicekit/DeviceKit](https://github.com/devicekit/DeviceKit) — A value-type replacement of UIDevice.
- [kishikawakatsumi/KeychainAccess](https://github.com/kishikawakatsumi/KeychainAccess) — Simple Swift wrapper for Keychain that works on iOS, macOS, tvOS and watchOS.
> [!NOTE]
> This package also utilizes [KippleTools](https://github.com/bdrelling/KippleTools) as a development dependency, which handles linting, formatting, and other core scripting needs for [Kipple](https://github.com/bdrelling/Kipple) projects.
> This dependency is not pulled into your project in any way, as it is not referenced directly by any product of this package.
## Component Libraries
To keep **Kipple** focused on core functionality, there are additional components that live in external packages. Each package provides functionality around a more complex topic, such as Networking or UI, which some applications won't need.
Each package essentially does what it says on the tin — check out their respective READMEs for more information!
| Package | Version | CI | Coverage | Swift | Platforms |
| ------- | ------- | -- | -------- | ----- | --------- |
| [KippleNetworking](https://github.com/bdrelling/KippleNetworking) | [](https://github.com/bdrelling/KippleNetworking/tags) | [](https://github.com/bdrelling/KippleNetworking/actions/workflows/apple_tests.yml) | [](https://codecov.io/gh/bdrelling/KippleNetworking) | [](https://swiftpackageindex.com/bdrelling/KippleNetworking) | [](https://swiftpackageindex.com/bdrelling/KippleNetworking) |
| [KipplePlugins](https://github.com/bdrelling/KipplePlugins) | [](https://github.com/bdrelling/KipplePlugins/tags) | [](https://github.com/bdrelling/KipplePlugins/actions/workflows/apple_tests.yml) | [](https://codecov.io/gh/bdrelling/KipplePlugins) | [](https://swiftpackageindex.com/bdrelling/KipplePlugins) | [](https://swiftpackageindex.com/bdrelling/KipplePlugins) |
| [KippleTools](https://github.com/bdrelling/KippleTools) | [](https://github.com/bdrelling/KippleTools/tags) | [](https://github.com/bdrelling/KippleTools/actions/workflows/apple_tests.yml) | [](https://codecov.io/gh/bdrelling/KippleTools) | [](https://swiftpackageindex.com/bdrelling/KippleTools) | [](https://swiftpackageindex.com/bdrelling/KippleTools) |
| [KippleUI](https://github.com/bdrelling/KippleUI) | [](https://github.com/bdrelling/KippleUI/tags) | [](https://github.com/bdrelling/KippleUI/actions/workflows/tests.yml) | [](https://codecov.io/gh/bdrelling/KippleUI) | [](https://swiftpackageindex.com/bdrelling/KippleUI) | [](https://swiftpackageindex.com/bdrelling/KippleUI) |
## Installation
### Swift Package Manager (SPM)
> [!WARNING]
> Please read the [Stability](#stability) section before considering this installation method.
[Swift Package Manager (SPM)](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
You can add **Kipple** to your Swift project like so:
```swift
let package = Package(
...
dependencies: [
// Use .upToNextMinor to ensure you avoid breaking changes as much as possible.
.package(url: "https://github.com/bdrelling/Kipple", .upToNextMinor(from: "0.x.0")),
// Better yet, link to an explicit git commit to ensure stability.
.package(url: "https://github.com/bdrelling/Kipple", revision: "abcd123"),
],
...
)
```
Swift Package Manager is included in Swift 3.0 and above.
### Manual
Alternatively, feel free to copy any module, file, or line of code into your own Swift project!
All **Kipple** libraries are released under the MIT license. See [LICENSE](LICENSE) for details.
## Compatibility
[](https://swiftpackageindex.com/bdrelling/Kipple)
[](https://swiftpackageindex.com/bdrelling/Kipple)
**Swift Versions**: Packages will aim to support a minimum of all versions of Swift bundled with the two most recent major versions of Xcode. (Example: At time of writing, Xcode 15.2 is currently out, so Kipple supports Xcode 14.0 and up, which means that Swift 5.7 is the minimum version for all packages.) See [swiftversion.net](https://swiftversion.net/) for a reference of Swift and Xcode versions.
> [!Note]
> Because of SwiftUI's major leap forward with `@Observable` in iOS 17 / Swift 5.9, `KippleUI`'s minimum version is 5.9 instead of 5.7.
**Platforms**: All packages are meant to be platform-agnostic and run everywhere that Swift can run, with few exceptions such as a package like [KippleUI](https://github.com/bdrelling/KippleUI) which is closely tied to Apple platform SDKs (SwiftUI, UIKit, AppKit, etc.), so there is no consideration for Linux, Windows, or Android and the packages will fail to build on those platforms. For new and emerging platforms (such as visionOS with Xcode 15), Kipple packages may not be supported until the following Xcode major version release.
**Platform Versions**: Similarly to Swift Version support, minimum versions of all platforms are dictated by the SDKs introduced with the two most recent major versions of Xcode. (Example: At time of writing, Xcode 15.2 is currently out, so Kipple supports iOS 16.0+, macOS 13.0+, watchOS 9.0+, tvOS 16.0+, and Linux.) See [xcodereleases.com](https://xcodesreleases.com/) for a reference of Xcode versions and their bundled SDKs.
**Package Managers**: Given that these projects are largely for reference and education and not intended to be directly depended upon, Kipple packages only support [Swift Package Manager](https://github.com/apple/swift-package-manager) for ease of maintenance.
## Stability
[](https://github.com/bdrelling/Kipple/actions/workflows/apple_tests.yml)
[](https://github.com/bdrelling/Kipple/actions/workflows/linux_tests.yml)
[](https://codecov.io/gh/bdrelling/Kipple)
Kipple is **inactively maintained**, meaning that updates are made to the packages above as needed, whether to squash bugs, remove outdated content, update Swift and platform compatibilities, or include new content for educational purposes.
As such, every repository in this organization includes the following disclaimer:
> [!WARNING]
> The code in this library has been made public as-is solely for the purposes of reference, education, discovery, and personal use. As such, stability for production applications **CANNOT** be guaranteed; however, if you're interested in leveraging code within this library in your own projects, feel free to do so at your own risk.
>
> Please open GitHub issues for any problems you encounter or requests you have and we will do my best to provide support.
That said, I use all of these repositories in numerous applications and projects myself, many of them in production. I also leverage two CI reports (GitHub Actions and Swift Package Index) and try my best to cover core functionality with tests as much as possible.
I will make an effort to address any and all Issues and Pull Requests that are opened into my repository as thanks for your help in improving the stability for these packages and therefore my own (and others') applications. **If you don't receive a timely response from me on an Issue or Pull Request**, please don't hesitate to ping me again.
An important note to package maintainers: **Please do not include these packages as a dependency of your own packages!** Doing so can introduce transitive risk to your consumers, who may not have opted into using unstable packages such as these.
## Contributing
Feel free to open GitHub Issues or Pull Requests for any problems you encounter or requests you have.
## FAQ
### What does "Kipple" mean?
The concept of "**Kipple**" comes from the [Philip K. Dick](https://en.wikipedia.org/wiki/Philip_K._Dick) book [Do Androids Dream of Electric Sheep?](https://en.wikipedia.org/wiki/Do_Androids_Dream_of_Electric_Sheep%3F).
> **Kipple** is useless objects, like junk mail or match folders after you use the last match or gum wrappers of yesterday's homeopape. **When nobody's around, kipple reproduces itself.** For instance, if you go to bed leaving any kipple around your apartment, when you wake up the next morning there's twice as much of it. It always gets more and more.
>
> No one can win against kipple, except temporarily and maybe in one spot,[...] It's a universal principle operating throughout the universe; the entire universe is moving toward a final state of total, absolute kippleization.
With every new project, developers write a lot of the same boilerplate code again and again, which piles up quickly. It's not _useless_ code, per se, but it's usually fairly trivial solutions repeated over and over per-project that never _quite_ warrant pulling in bloated third-party dependencies, but can be a burden to recreate time and time again.
### Why do these libraries use a major version of zero (0.y.z)?
> Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable. — [SemVer Spec #4](https://semver.org/spec/v2.0.0.html#spec-item-4).
**Kipple** uses a major version of zero to indicate that [volatile nature](#stability) of the project.
## License
All **Kipple** libraries are released under the MIT license. See [LICENSE](LICENSE) for details.