Tenduke.Core 3.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.7.1 This package targets .NET Framework 4.7.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Tenduke.Core --version 3.0.0                

                    
                

            
NuGet\Install-Package Tenduke.Core -Version 3.0.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="Tenduke.Core" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Tenduke.Core --version 3.0.0                

                    
                

            
#r "nuget: Tenduke.Core, 3.0.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 Tenduke.Core as a Cake Addin
#addin nuget:?package=Tenduke.Core&version=3.0.0

// Install Tenduke.Core as a Cake Tool
#tool nuget:?package=Tenduke.Core&version=3.0.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.

Releasing

To release a new version, the revision should be tagged in the format vMajor.minor.patch (for example v2.2.0) and the tag pushed.

This will build both the Tenduke.Core and Tenduke.Core.Tests nuget package and publish them to the project package registry. The packages can be downloaded from there and pushed to nuget.org (this step is manual).

Additionally the example projects should be updated to use the new version.

A script update-version.sh is provided to automate tagging the revision and updating the project files for the examples to use the new version of the nuget package.

If you want to create a new release from the current revision, then call it with the version number as a command line parameter:

./update-version.sh 2.2.3

The changes in ./examples/ will be left uncommitted for you to review and to add to a new revision.

Once you are happy, push the new tag. This will trigger a release being created in GitLab.

Getting involved

We welcome contributions! Contributing explains what kind of contributions we welcome.

Resources

License

10Duke .NET core library is licensed under the MIT license.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.

Version Downloads Last updated
3.0.2 183 10/30/2024
3.0.1 253 10/29/2024
3.0.0 423 8/7/2024
2.2.0 168 6/7/2024
2.1.0 128 6/6/2024
2.0.0 137 6/6/2024
1.2.0 188 5/14/2024
1.1.1 126 4/25/2024
1.1.0 199 4/19/2024
1.0.1 605 2/8/2024
1.0.0 118 2/8/2024