Tenduke.Scale 3.0.2

10Duke Scale SDK for .NET

The 10Duke Scale SDK for .NET is a library to facilitate building applications licensed using 10Duke Scale.

For more information please see the documentation.

Contents

• Why?
• Installation
• Development
• Getting involved
• Resources
• License

Why?

Providing a set of .NET client bindings for the 10Duke Scale REST API and a set of helper classes to configure the SDK, authenticate users, and provide authorization for API requests enables software vendors to focus on their software and their application domain. The SDK makes using 10Duke Scale in an application simpler and allows faster adoption.

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package Tenduke.Scale

Using the NuGet Command Line Interface (CLI):

nuget install Tenduke.Scale

Using the Package Manager Console:

Install-Package Tenduke.Scale

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.Scale". Click on the Tenduke.Scale package, select the appropriate version in the right-tab and click Install.

Accessing builds from gitlab package registry

To use nuget packages from the gitlab package registry, you need to add that registry and the package registry for Tenduke.Core as nuget sources.

dotnet nuget add source "https://gitlab.com/api/v4/projects/51515286/packages/nuget/index.json" \
    --name tenduke.core --username <your_username> --password <your_token> --store-password-in-clear-text
dotnet nuget add source "https://gitlab.com/api/v4/projects/51838363/packages/nuget/index.json" \
    --name tenduke.scale --username <your_username> --password <your_token> --store-password-in-clear-text

Development

As a pre-requisite, 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/scale/dotnet/dotnet-scale-sdk.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.

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 the Tenduke.Scale nuget package and publish it to the project package registry. The package 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 new 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

• 10Duke Scale Documentation
• 10Duke.com - Find more information about 10Duke products and services

License

The 10Duke Scale SDK for .NET is licensed under the MIT license.