atproto 0.6.0

The most famous and powerful Dart/Flutter library for AT Protocol.

The Most Famous and Powerful Dart/Flutter Library for AT Protocol 🎯

---

---

• 1. Guide 🌎
  • 1.1. Features ⭐
  • 1.2. Getting Started 💪
  • 1.3. Supported Endpoints 👀
  • 1.4. More Tips 🏄
  • 1.5. Contribution 🏆
  • 1.6. Support ❤️
  • 1.7. License 🔑
  • 1.8. More Information 🧐

1. Guide 🌎

This library provides the easiest way to use AT Protocol in Dart and Flutter apps.

Show some ❤️ and star the repo to support the project.

This package provides the most basic features of AT Protocol. If you want to use Bluesky's API, please use bluesky! The core HTTP request portion of this package is provided in the atproto_core and xrpc packages.

Check official documents for more details.

1.1. Features ⭐

• ✅ Zero Dependency
• ✅ Supports Powerful Built-In Retry using Exponential BackOff And Jitter
• ✅ Supports All Major Endpoints for com.atproto.*
• ✅ Well Documented and Well Tested
• ✅ Supports Powerful Firehose API
• ✅ 100% Null Safety
• ✅ Applicable to services other than Bluesky

1.2. Getting Started 💪

See example or official documents from following links.

• Install
• Import
• Instantiate ATProto
• Supported Services
• Let's Implement

1.3. Supported Endpoints 👀

See official documents from following links.

• com.atproto.*
  • com.atproto.server.*
  • com.atproto.identity.*
  • com.atproto.repo.*
  • com.atproto.moderation.*
  • com.atproto.sync.*

1.4. More Tips 🏄

See official documents from following links.

• Standardized Names
• Other Than bsky.social
• De/Serialize
• Thrown Exceptions
• Rate Limits
• Union Types
• Firehose API
• Timeout Duration
• Advanced Built-In Retry
• Lexicon/Object IDs
• Pagination
• Advanced Pagination

1.5. Contribution 🏆

If you would like to contribute to atproto, please create an issue or create a Pull Request.

There are many ways to contribute to the OSS. For example, the following subjects can be considered:

• There are request parameters or response fields that are not implemented.
• Documentation is outdated or incomplete.
• Have a better way or idea to achieve the functionality.
• etc...

You can see more details from resources below:

• Contributor Covenant Code of Conduct
• Contribution Guidelines
• Style Guide

Or you can create a discussion if you like.

Feel free to join this development, diverse opinions make software better!

1.6. Support ❤️

The simplest way to show us your support is by giving the project a star at GitHub and Pub.dev.

You can also support this project by becoming a sponsor on GitHub:

You can also show on your repository that your app is made with atproto by using one of the following badges:

[![Powered by atproto](https://img.shields.io/badge/Powered%20by-atproto-00acee.svg)](https://github.com/myConsciousness/atproto.dart)
[![Powered by atproto](https://img.shields.io/badge/Powered%20by-atproto-00acee.svg?style=flat-square)](https://github.com/myConsciousness/atproto.dart)
[![Powered by atproto](https://img.shields.io/badge/Powered%20by-atproto-00acee.svg?style=for-the-badge)](https://github.com/myConsciousness/atproto.dart)

1.7. License 🔑

All resources of atproto is provided under the BSD-3 license.

Copyright 2023 Shinya Kato. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided the conditions.

Note
License notices in the source are strictly validated based on .github/header-checker-lint.yml. Please check header-checker-lint.yml for the permitted standards.

1.8. More Information 🧐

atproto was designed and implemented by Shinya Kato (@myConsciousness).

• Creator Profile
• License
• API Document
• Release Note
• Bug Report