Skip to content
/ atrium Public

Rust libraries for Bluesky's AT Protocol services.

License

Notifications You must be signed in to change notification settings

sugyan/atrium

Repository files navigation

ATrium

ATrium is a collection of Rust libraries designed to work with the AT Protocol, providing a versatile and coherent ecosystem for developers. The name is inspired by the concept of an "atrium" with a view of the open bluesky, reflecting the open nature of the project.

Our goal is to provide a comprehensive, easy-to-use, and efficient library that caters to various use cases and scenarios involving the AT Protocol.

Please note that ATrium is still under active development and many features may be subject to change or enhancement. We appreciate your understanding and patience during this phase.

Overview

ATrium is divided into several sub-projects to address different aspects of the AT Protocol and provide a modular design:

A library consisting of models and messaging definitions for XRPC, primarily generated using the codegen library.

Definitions for XRPC request/response, and their associated errors.

A library provides clients that implement the XrpcClient defined in atrium-xrpc

ATrium-based SDK for Bluesky.

A command-line app using this API library.

Code generation

The models and messaging definitions for XRPC are generated with these crates:

A library that provides type definitions for parsing the AT Protocol's Lexicon schema, ensuring compatibility with the lexicon.

A library that generates Rust code for the atrium-api based on the analyzed lexicon definitions.

lexgen command

cd lexicon && cargo run -p lexgen -- --lexdir $HOME/.ghq/github.com/bluesky-social/atproto/lexicons

Contribution

We welcome contributions from the community to help us improve and expand ATrium. If you're interested in contributing, please feel free to submit issues or pull requests on the GitHub repository. We appreciate your support!

License

ATrium is released under the MIT License.

Related works

Below are some related projects that might be of interest: