Tenduke.Core
2.2.0
See the version list below for details.
dotnet add package Tenduke.Core --version 2.2.0
NuGet\Install-Package Tenduke.Core -Version 2.2.0
<PackageReference Include="Tenduke.Core" Version="2.2.0" />
paket add Tenduke.Core --version 2.2.0
#r "nuget: Tenduke.Core, 2.2.0"
// Install Tenduke.Core as a Cake Addin #addin nuget:?package=Tenduke.Core&version=2.2.0 // Install Tenduke.Core as a Cake Tool #tool nuget:?package=Tenduke.Core&version=2.2.0
10Duke .NET core library
This repository contains the shared code between the 10Duke Enterprise and 10Duke Scale SDKs.
For more information please see the documentation.
Contents
Why?
The 10Duke Enterprise and 10Duke Scale SDK client libraries both need similar
functionality in areas such as authentication, configuration, handling HttpClient
life-cycle.
In order to reduce complexity in those libraries, promote similar developer experience using those libraries, and reduce effort developing and maintaining those libraries, this project established a shared, core library that provides that functionality to both client libraries.
Installation
Using the .NET Core command-line interface (CLI) tools:
dotnet add package Tenduke.Core
Using the NuGet Command Line Interface (CLI):
nuget install Tenduke.Core
Using the Package Manager Console:
Install-Package Tenduke.Core
From within Visual Studio:
Open the Solution Explorer. Right-click on a project within your solution. Click on Manage NuGet Packages... Click on the Browse tab and search for "Tenduke.Core". Click on the Tenduke.Core package, select the appropriate version in the right-tab and click Install.
For more information, refer to the documentation.
Accessing builds from gitlab package registry
To use nuget packages from the gitlab package registry, you need to add that registry as a nuget source.
dotnet nuget add source "https://gitlab.com/api/v4/projects/51515286/packages/nuget/index.json" \
--name core --username <your_username> --password <your_token> --store-password-in-clear-text
Development
First download and install the .NET SDK. The latest LTS version is recommended (currently version 8).
To get started with working on the code, clone this repository.
git clone git@gitlab.com:10Duke/core/dotnet-core.git
Then you need to install the tools and dependencies.
dotnet tool restore
dotnet restore .
The code can be build as follows
dotnet build
The tests can be run using
dotnet test
This will attempt to run the tests for all target .NET versions, including .NET Framework 4.7.1. That will not work on linux or macOS using the .NET SDK.
For linux or macOS, you can specify the .NET version to test with (dependent on the SDK version you are using).
dotnet test --framework NET8.0
or
dotnet test --framework NET6.0
For linux or macOS, a Makefile
is provided to automate these, and other, development tasks.
Test output
Some of the unit tests (specifically for the LocalhostCallbackListener
used in the Authorization
code flow with PKCE), use the XUnit ITestOutputHelper
to capture test output.
This can be useful to follow the flow of the asynchronous operations used in the tests to simulate the three-legged OAuth handshake.
To view the output when running the tests from the CLI, append --logger "console;verbosity=detailed"
to the command, as follows:
dotnet test --framework NET8.0 --logger "console;verbosity=detailed"
Code formatting / linting
This project is using CSharpier for C# code formatting, .NET Roslyn Analyzers and Sonarlint for linting C# code, and markdownlint for linting markdown.
Getting involved
We welcome contributions! Contributing explains what kind of contributions we welcome.
Resources
- 10Duke Enterprise documentation
- 10Duke Scale documentation
- 10Duke.com - Find more information about 10Duke products and services
License
10Duke .NET core library is licensed under the MIT license.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 is compatible. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.1
- Hocon.Extensions.Configuration (>= 2.0.4)
- IdentityModel (>= 6.2.0)
- IdentityModel.OidcClient (>= 5.2.1)
- IdentityModel.OidcClient.IdentityTokenValidator (>= 5.2.1)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.1)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.IdentityModel.JsonWebTokens (>= 7.2.0)
- Microsoft.IdentityModel.Tokens (>= 7.2.0)
- refit (>= 7.0.0)
- System.Configuration.ConfigurationManager (>= 8.0.0)
- YamlDotNet (>= 13.7.1)
-
.NETStandard 2.0
- Hocon.Extensions.Configuration (>= 2.0.4)
- IdentityModel (>= 6.2.0)
- IdentityModel.OidcClient (>= 5.2.1)
- IdentityModel.OidcClient.IdentityTokenValidator (>= 5.2.1)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.1)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.IdentityModel.JsonWebTokens (>= 7.2.0)
- Microsoft.IdentityModel.Tokens (>= 7.2.0)
- refit (>= 7.0.0)
- System.Configuration.ConfigurationManager (>= 8.0.0)
- YamlDotNet (>= 13.7.1)
-
net6.0
- Hocon.Extensions.Configuration (>= 2.0.4)
- IdentityModel (>= 6.2.0)
- IdentityModel.OidcClient (>= 5.2.1)
- IdentityModel.OidcClient.IdentityTokenValidator (>= 5.2.1)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.1)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.IdentityModel.JsonWebTokens (>= 7.2.0)
- Microsoft.IdentityModel.Tokens (>= 7.2.0)
- refit (>= 7.0.0)
- System.Configuration.ConfigurationManager (>= 8.0.0)
- YamlDotNet (>= 13.7.1)
-
net8.0
- Hocon.Extensions.Configuration (>= 2.0.4)
- IdentityModel (>= 6.2.0)
- IdentityModel.OidcClient (>= 5.2.1)
- IdentityModel.OidcClient.IdentityTokenValidator (>= 5.2.1)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.1)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.IdentityModel.JsonWebTokens (>= 7.2.0)
- Microsoft.IdentityModel.Tokens (>= 7.2.0)
- refit (>= 7.0.0)
- System.Configuration.ConfigurationManager (>= 8.0.0)
- YamlDotNet (>= 13.7.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Tenduke.Core:
Package | Downloads |
---|---|
Tenduke.Scale
Client library for 10Duke Scale APIs. |
|
Tenduke.Core.Tests
Tests for the Tenduke.Core library. Includes utilities used in testing of the 10Duke Enterprise and 10Duke Scale SDKs. |
|
Tenduke.Enterprise
Client library for 10Duke Enterprise APIs. |
GitHub repositories
This package is not used by any popular GitHub repositories.