Clerk.Net 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Clerk.Net --version 0.1.0                
NuGet\Install-Package Clerk.Net -Version 0.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Clerk.Net" Version="0.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Clerk.Net --version 0.1.0                
#r "nuget: Clerk.Net, 0.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Clerk.Net as a Cake Addin
#addin nuget:?package=Clerk.Net&version=0.1.0

// Install Clerk.Net as a Cake Tool
#tool nuget:?package=Clerk.Net&version=0.1.0                

Clerk API Client for .NET

Nuget (with prereleases) Nuget (with prereleases)

Note: This project is currently in alpha. Breaking changes may occur before release.

Packages

Clerk.Net: Provides the standalone API Client as a Kiota-generated wrapper over Clerk's OpenAPI spec.

Clerk.Net.DependencyInjection: Dependency Injection extensions to register the ClerkApiClient into your container.

Getting Started

Make sure to add your SecretKey to your application configuration, ideally via the dotnet secrets manager.

DI Container Configuration (ASP.NET Core & Worker Services)

  1. Install Clerk.Net.DependencyInjection from Nuget.
  2. Add the following code to your service configuration:
builder.Services.AddClerkApiClient(config =>
{
    config.SecretKey = builder.Configuration["Clerk:SecretKey"]!
});
  1. Request the ClerkApiClient in your services
public class MyBackgroundWorker : BackgroundService
{
    private readonly ClerkApiClient _clerkApiClient;

    public MyBackgroundWorker(ClerkApiClient clerkApiClient)
    {
        _clerkApiClient = clerkApiClient;
    }

    protected override Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // Do work with the client
    }
}

Standalone Client

If you want to use the client by itself, install Clerk.Net and call ClerkApiClientFactory.Create, passing in your secret key.

The returned client should be treated as a singleton and created once for the lifetime of your application.

Testing

(To be written)

Disclaimer

I am not affiliated with nor represent Clerk. All support queries regarding the underlying service should go to Clerk Support.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Clerk.Net:

Package Downloads
Clerk.Net.DependencyInjection

Clerk Backend API Wrapper for .NET. This package includes dependency injection extensions.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.7.0 1,098 9/27/2024
1.6.0 3,494 7/7/2024
1.5.0 1,799 5/1/2024
1.4.0 1,802 3/17/2024
1.3.0 790 12/18/2023
1.2.0 237 11/18/2023
1.1.0 143 11/4/2023
1.0.0 141 10/30/2023
0.1.0 177 10/28/2023