Rename to swift-kafka-client (swift-server#108)

Modifications:

* change project name to `swift-kafka-client`
* replace package name `SwiftKafka` with `Kafka`

Author: felixschlegel

CONTRIBUTING.md

@@ -10,8 +10,8 @@ that your contributions are licensed under the Apache 2.0 license (see
 
 Please ensure to specify the following:
 
-* swift-kafka-gsoc commit hash
-* Contextual information (e.g. what you were trying to achieve with swift-kafka-gsoc)
+* swift-kafka-client commit hash
+* Contextual information (e.g. what you were trying to achieve with swift-kafka-client)
 * Simplest possible steps to reproduce
   * More complex the steps are, lower the priority will be.
   * A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
@@ -24,10 +24,10 @@ Please ensure to specify the following:
 ### Example
 
 ```
-swift-kafka-gsoc commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
+swift-kafka-client commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
 
 Context:
-While load testing my program written with swift-kafka-gsoc, I noticed
+While load testing my program written with swift-kafka-client, I noticed
 that one file descriptor is leaked per request.
 
 Steps to reproduce:
@@ -50,7 +50,7 @@ My system has IPv6 disabled.
 
 ## Writing a Patch
 
-A good swift-kafka-gsoc patch is:
+A good swift-kafka-client patch is:
 
 1. Concise, and contains as few changes as needed to achieve the end result.
 2. Tested, ensuring that any tests provided failed before the patch and pass after it.
@@ -65,4 +65,4 @@ We require that your commit messages match our template. The easiest way to do t
 
 ## How to contribute your work
 
-Please open a pull request at https://github.com/swift-server/swift-kafka-gsoc. Make sure the CI passes, and then wait for code review.
+Please open a pull request at https://github.com/swift-server/swift-kafka-client. Make sure the CI passes, and then wait for code review.

CONTRIBUTORS.txt

@@ -1,5 +1,5 @@
 For the purpose of tracking copyright, this is the list of individuals and
-organizations who have contributed source code to swift-kafka-gsoc.
+organizations who have contributed source code to swift-kafka-client.
 
 For employees of an organization/company where the copyright of work done
 by employees of that company is held by the company itself, only the company

NOTICE.txt

@@ -4,7 +4,7 @@
 
 Please visit the Swift Kafka Client web site for more information:
 
-  * https://github.com/swift-server/swift-kafka-gsoc
+  * https://github.com/swift-server/swift-kafka-client
 
 Copyright 2023 The Swift Kafka Client Project
 

Package.swift

@@ -1,13 +1,13 @@
 // swift-tools-version: 5.7
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //
@@ -27,7 +27,7 @@ let rdkafkaExclude = [
 ]
 
 let package = Package(
-    name: "swift-kafka-gsoc",
+    name: "swift-kafka-client",
     platforms: [
         .macOS(.v13),
         .iOS(.v16),
@@ -36,8 +36,8 @@ let package = Package(
     ],
     products: [
         .library(
-            name: "SwiftKafka",
-            targets: ["SwiftKafka"]
+            name: "Kafka",
+            targets: ["Kafka"]
         ),
         .library(
             name: "KafkaFoundationCompat",
@@ -74,7 +74,7 @@ let package = Package(
             ]
         ),
         .target(
-            name: "SwiftKafka",
+            name: "Kafka",
             dependencies: [
                 "Crdkafka",
                 .product(name: "NIOCore", package: "swift-nio"),
@@ -85,7 +85,7 @@ let package = Package(
         .target(
             name: "KafkaFoundationCompat",
             dependencies: [
-                "SwiftKafka",
+                "Kafka",
             ]
         ),
         .systemLibrary(
@@ -97,12 +97,12 @@ let package = Package(
             ]
         ),
         .testTarget(
-            name: "SwiftKafkaTests",
-            dependencies: ["SwiftKafka"]
+            name: "KafkaTests",
+            dependencies: ["Kafka"]
         ),
         .testTarget(
             name: "IntegrationTests",
-            dependencies: ["SwiftKafka"]
+            dependencies: ["Kafka"]
         ),
     ]
 )

README.md

@@ -1,29 +1,29 @@
-# 🚧WIP🚧: SwiftKafka
+# 🚧WIP🚧: Swift Kafka Client
 
-SwiftKafka is a Swift Package in development that provides a convenient way to communicate with [Apache Kafka](https://kafka.apache.org) servers. The main goal was to create an API that leverages [Swift's new concurrency features](https://docs.swift.org/swift-book/LanguageGuide/Concurrency.html). Under the hood, this package uses the [`librdkafka`](https://github.com/confluentinc/librdkafka) C library.
+Swift Kafka Client is a Swift Package in development that provides a convenient way to communicate with [Apache Kafka](https://kafka.apache.org) servers. The main goal was to create an API that leverages [Swift's new concurrency features](https://docs.swift.org/swift-book/LanguageGuide/Concurrency.html). Under the hood, this package uses the [`librdkafka`](https://github.com/confluentinc/librdkafka) C library.
 
-## Adding SwiftKafka as a Dependency
+## Adding Kafka as a Dependency
 
-To use the `SwiftKafka` library in a SwiftPM project,
+To use the `Kafka` library in a SwiftPM project,
 add the following line to the dependencies in your `Package.swift` file:
 
 ```swift
-.package(url: "https://github.com/swift-server/swift-kafka-gsoc", branch: "main")
+.package(url: "https://github.com/swift-server/swift-kafka-client", branch: "main")
 ```
 
-Include `"SwiftKafka"` as a dependency for your executable target:
+Include `"Kafka"` as a dependency for your executable target:
 
 ```swift
 .target(name: "<target>", dependencies: [
-    .product(name: "SwiftKafka", package: "swift-kafka-gsoc"),
+    .product(name: "Kafka", package: "swift-kafka-client"),
 ]),
 ```
 
-Finally, add `import SwiftKafka` to your source code.
+Finally, add `import Kafka` to your source code.
 
 ## Usage
 
-`SwiftKafka` should be used within a [`Swift Service Lifecycle`](https://github.com/swift-server/swift-service-lifecycle)
+`Kafka` should be used within a [`Swift Service Lifecycle`](https://github.com/swift-server/swift-service-lifecycle)
 [`ServiceGroup`](https://swiftpackageindex.com/swift-server/swift-service-lifecycle/main/documentation/servicelifecycle/servicegroup) for proper startup and shutdown handling.
 Both the `KafkaProducer` and the `KafkaConsumer` implement the [`Service`](https://swiftpackageindex.com/swift-server/swift-service-lifecycle/main/documentation/servicelifecycle/service) protocol.
 
@@ -116,7 +116,7 @@ await withThrowingTaskGroup(of: Void.self) { group in
 
 #### Consumer Groups
 
-SwiftKafka also allows users to subscribe to an array of topics as part of a consumer group.
+Kafka also allows users to subscribe to an array of topics as part of a consumer group.
 
 ```swift
 let broker = KafkaConfiguration.Broker(host: "localhost", port: 9092)

Sources/SwiftKafka/Configuration/KafkaConfiguration+Security.swift renamed to Sources/Kafka/Configuration/KafkaConfiguration+Security.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Configuration/KafkaConfiguration.swift renamed to Sources/Kafka/Configuration/KafkaConfiguration.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Configuration/KafkaConsumerConfiguration.swift renamed to Sources/Kafka/Configuration/KafkaConsumerConfiguration.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //
@@ -16,7 +16,7 @@ import Crdkafka
 import struct Foundation.UUID
 
 public struct KafkaConsumerConfiguration {
-    // MARK: - SwiftKafka-specific Config properties
+    // MARK: - Kafka-specific Config properties
 
     /// The time between two consecutive polls.
     /// Effectively controls the rate at which incoming events and messages are consumed.

Sources/SwiftKafka/Configuration/KafkaProducerConfiguration.swift renamed to Sources/Kafka/Configuration/KafkaProducerConfiguration.swift

@@ -1,19 +1,19 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //
 //===----------------------------------------------------------------------===//
 
 public struct KafkaProducerConfiguration {
-    // MARK: - SwiftKafka-specific Config properties
+    // MARK: - Kafka-specific Config properties
 
     /// The time between two consecutive polls.
     /// Effectively controls the rate at which incoming events are consumed.

Sources/SwiftKafka/Configuration/KafkaTopicConfiguration.swift renamed to Sources/Kafka/Configuration/KafkaTopicConfiguration.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Data/Array+KafkaContiguousBytes.swift renamed to Sources/Kafka/Data/Array+KafkaContiguousBytes.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Data/ByteBuffer+KafkaContiguousBytes.swift renamed to Sources/Kafka/Data/ByteBuffer+KafkaContiguousBytes.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Data/KafkaContiguousBytes.swift renamed to Sources/Kafka/Data/KafkaContiguousBytes.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Data/Never+KafkaContiguousBytes.swift renamed to Sources/Kafka/Data/Never+KafkaContiguousBytes.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/Data/String+KafkaContiguousBytes.swift renamed to Sources/Kafka/Data/String+KafkaContiguousBytes.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/KafkaAcknowledgedMessage.swift renamed to Sources/Kafka/KafkaAcknowledgedMessage.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/KafkaConsumer.swift renamed to Sources/Kafka/KafkaConsumer.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2022 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2022 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //

Sources/SwiftKafka/KafkaConsumerEvent.swift renamed to Sources/Kafka/KafkaConsumerEvent.swift

@@ -1,12 +1,12 @@
 //===----------------------------------------------------------------------===//
 //
-// This source file is part of the swift-kafka-gsoc open source project
+// This source file is part of the swift-kafka-client open source project
 //
-// Copyright (c) 2023 Apple Inc. and the swift-kafka-gsoc project authors
+// Copyright (c) 2023 Apple Inc. and the swift-kafka-client project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
-// See CONTRIBUTORS.txt for the list of swift-kafka-gsoc project authors
+// See CONTRIBUTORS.txt for the list of swift-kafka-client project authors
 //
 // SPDX-License-Identifier: Apache-2.0
 //