readme.md

idunno.Bluesky

A .NET 8 class library for the AT Protocol and APIs for the Bluesky social network.

Getting Started

Add the idunno.Bluesky package to your project, and then

BlueskyAgent agent = new ();

var loginResult = await agent.Login(username, password);
if (loginResult.Succeeded)
{
    var response = await agent.CreatePost("Hello World");
    if (response.Succeeded)
    {
    }
}

Please see the documentation for much more useful documentation and samples.

The API status page shows what APIs are currently implemented.

Current Build Status

Release History

The releases page provides details of each release and what was added, changed or removed.

License

idunno.Bluesky, idunno.AtProto and idunno.AtProto.OAuthCallBack are available under the MIT license, see the LICENSE file for more information.

Planned work

Major

• Logging in idunno.Bluesky
• GIF attaching
• AOT & trimming support
• Firehose support
• Wider test coverage
• More deserialization tests with captured responses

Awaiting external

• Automatic Open Graph card generation when link facets detected.

Dependencies

idunno.AtProto takes a dependency on System.Text.Json v9 to support deserializing derived types where the $type property is not the first property in the JSON object.

External dependencies

• Microsoft.Extensions.Logging - used to provide log messages.
• Microsoft.IdentityModel.Tokens - used to extract the expiry date and time of the JWT tokens issued by Bluesky.
• IdentityModel.OidcClient - used to do the OAuth heavy lifting.
• DnsClient - used in Handle to DID resolution.

External analyzers used during builds

• DotNetAnalyzers.DocumentationAnalyzers - used to validate XML docs on public types.
• SonarAnalyzer.CSharp - used for common code smell detection.

External build & testing tools

• xunit - used for unit tests.
• NerdBank.GitVersioning - used for version stamping assemblies and packages.
• DotNet.ReproducibleBuilds - used to easily set .NET reproducible build settings.
• ReportGenerator - used to produce code coverage reports.
• JunitXml.TestLogger - used in CI builds to produce test results in a format understood by the test-summary GitHub action.
• sign - used to code sign assemblies and nuget packages.
• docfx - used to generate the documentation site.

Other .NET Bluesky libraries

• FishyFlip
• X.Bluesky
• atprotosharp
• atompds - an implementation of an AtProto Personal Data Server in C#