https://github.com/MasterJ93/ATProtoKit
A straightforward solution for using the AT Protocol and Bluesky, written in Swift.
https://github.com/MasterJ93/ATProtoKit
api atproto atprotocol bluesky decentralized lexicon social-media swift swift-package-manager xrpc
Last synced: 2 months ago
JSON representation
A straightforward solution for using the AT Protocol and Bluesky, written in Swift.
- Host: GitHub
- URL: https://github.com/MasterJ93/ATProtoKit
- Owner: MasterJ93
- License: mit
- Created: 2024-02-15T17:50:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-02T05:14:41.000Z (3 months ago)
- Last Synced: 2025-10-02T07:14:13.312Z (3 months ago)
- Topics: api, atproto, atprotocol, bluesky, decentralized, lexicon, social-media, swift, swift-package-manager, xrpc
- Language: Swift
- Homepage: https://atprotokit.cjrriley.com/documentation/atprotokit/
- Size: 405 MB
- Stars: 174
- Watchers: 6
- Forks: 34
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
ATProtoKit
A straightforward solution for using the AT Protocol and Bluesky, written in Swift.
[](https://swiftpackageindex.com/MasterJ93/ATProtoKit)
[](https://swiftpackageindex.com/MasterJ93/ATProtoKit)
[](https://github.com/MasterJ93/ATProtoKit)
[](https://github.com/MasterJ93/ATProtoKit)
[](https://bsky.app/profile/cjrriley.ca)
[](https://github.com/sponsors/MasterJ93)
---
> [!CAUTION]
> ***This API library is highly unstable. Things will change. Things are incomplete. Things will break. Until the project reaches version 1.0.0, stability will not be guaranteed.***
ATProtoKit is an easy-to-understand API library that leverages the AT Protocol with the type-safety and ease-of-use you’ve come to expect with the Swift programming language. Whether you’re building a bot, a server app, or just another user-facing Bluesky client, this project should hopefully get you up to speed.
This Swift package mainly focuses on the client side of the AT Protocol. This is essentially a combination of the [`api`](https://github.com/bluesky-social/atproto/tree/main/packages/api) and [`xrpc`](https://github.com/bluesky-social/atproto/tree/main/packages/xrpc) packages from the official [`atproto`](https://github.com/bluesky-social/atproto) TypeScript repository.
## Example Usage
```swift
let config = ATProtocolConfiguration()
Task {
print("Starting application...")
do {
try await config.authenticate(with: "lucy.bsky.social", password: "hunter2")
let atProtoKit = await ATProtoKit(sessionConfiguration: config)
let atProtoBluesky = ATProtoBluesky(atProtoKitInstance: atProtoKit)
let postResult = try await atProtoBluesky.createPostRecord(text: "Hello Bluesky!")
print(postResult)
} catch {
print("Error: \(error)")
}
}
```
## Motivation
I believe Bluesky and its accompanying AT Protocol gives the perfect balance between embracing decentralization and simplifying the user experience. Because of this, I wanted a way for Swift developers to use the AT Protocol in a way that feels right at home, both client-side with Apple's platforms, and server-side with Linux. For this reason, I decided to open source this project.
## Features
- [x] Full compatibility with Apple’s APIs for each of the platforms.
- [x] Written with adherence to the Swift API Design Guidelines.
- [ ] Well-written documentation for all of the AT Protocol and Bluesky APIs.
- [x] A RichText helper to parse text into the applicable facets.
- [x] Easily validate different identifiers.
- [ ] A powerful Firehose API that retrieves and filters events and records in real-time.
- [ ] A logging tool for easy debugging.
> [!NOTE]
> Not all features above have been implemented; however, they will be, soon.
## Installation
You can use the Swift Package Manager to download and import the library into your project:
```swift
dependencies: [
.package(url: "https://github.com/MasterJ93/ATProtoKit.git", from: "0.32.0")
]
```
Then under `targets`:
```swift
targets: [
.target(
// name: "[name of target]",
dependencies: [
.product(name: "ATProtoKit", package: "atprotokit")
]
)
]
```
## Roadmap
The Projects page isn't completed, but you can still view it through its [Projects](https://github.com/users/MasterJ93/projects/2) page.
## Quick Start
As shown in the Example Usage, it all starts with `ATProtocolConfiguration`:
```swift
import ATProtoKit
let config = ATProtocolConfiguration()
```
By default, `ATProtocolConfiguration` conforms to `https://bsky.social`. However, if you’re using a different distributed service, you can specify the URL:
```swift
let result = ATProtocolConfiguration(pdsURL: "https://example.social")
```
After that, use the `authenticate()` method, and pass in the handle and password of the user account. Once you've passed in the `ATProtocolConfiguration` object to the `ATProtoKit` `class`, use the `getUserSession()` method, as well as the `ATProtocolConfiguration.sessionConfiguration.keychainProtocol` property. These two contains all of the elements you need, such as the session tokens, decentralized identifier (DID), and service endpoint:
```swift
Task {
do {
try await config.authenticate(with: "lucy.bsky.social", appPassword: "hunter2")
// The session object is contains in the `ATProtoKit` object:
let atProtoKit = ATProtoKit(sessionConfiguration: config)
if let keychain = try await atProtoKit.keychainProtocol() {
print("Result (Access Token): \(keychain.retrieveAccessToken())")
print("Result (Refresh Token): \(keychain.retrieveRefreshToken())")
}
if let session = try await atProtoKit.getUserSession() {
print("Result (Service Endpoint): \(session.serviceEndpoint)")
print("Result (DID): \(session.sessionDID)")
}
} catch {
print("Error: \(error)")
}
}
```
## Requirements
To use ATProtoKit in your apps, your app should target the specific version numbers:
- **iOS** and **iPadOS** 14 or later.
- **macOS** 13 or later.
- **tvOS** 14 or later.
- **visionOS** 1 or later.
- **watchOS** 9 or later.
For Linux, you need to use Swift 6.0 or later. On Linux, the minimum requirements include:
- **Amazon Linux** 2
- **Debian** 12
- **Fedora** 39
- **Red Hat UBI** 9
- **Ubuntu** 20.04
For Windows, you'll need Swift 6.1 or later. On Windows, the minimum requirements include:
- **Windows 10** or later
- **Windows Server** 2022 or later.
> [!WARNING]
> Direct support for Windows 11 on ARM is not supported. x86 builds may not fully work on Windows on ARM, either.
For Android, you'll need Swift 6.1 or later. On Android, the minimum requirements include:
- **Android** 10 or later.
- **Android SDK** version 29 or later.
At the moment, Android is in its experimental phase. Plans to take it out of this phase will require testing all parts of the package.
You can also use this project for any programs you make using Swift and running on **Docker**.
> [!WARNING]
> Support for WebAssembly is currently not supported. Plans are underway to make this package a supported platform.
## Submitting Contributions and Feedback
While this project will change significantly, feedback, issues, and contributions are highly welcomed and encouraged. If you'd like to contribute to this project, please be sure to read both the [API Guidelines](https://github.com/MasterJ93/ATProtoKit/blob/main/API_GUIDELINES.md) as well as the [Contributor Guidelines](https://github.com/MasterJ93/ATProtoKit/blob/main/CONTRIBUTING.md) before submitting a pull request. Any issues (such as bug reports or feedback) can be submitted in the [Issues](https://github.com/MasterJ93/ATProtoKit/issues) tab. Finally, if there are any security vulnerabilities, please read [SECURITY.md](https://github.com/MasterJ93/ATProtoKit/blob/main/SECURITY.md) for how to report it.
If you have any questions, you can ask me on Bluesky ([@cjrriley.ca](https://bsky.app/profile/cjrriley.ca)). And while you're at it, give me a follow! I'm also active on the [ATProto Touchers](https://discord.gg/3srmDsHSZJ) Discord server.
## License and Acknowledgments
This Swift package is using the MIT License. Please view [LICENSE.md](https://github.com/MasterJ93/ATProtoKit/blob/main/LICENSE.md) for more details.
ATProtoKit contains a number of third-party Swift packages in order to run effectively. Please see [NOTICE.txt](NOTICE.txt) for more information.