Installation¶

NuGet¶

After publication, install the package with:

dotnet add package Newfoundcodes.Okatana

The package targets .NET 8. The core client uses HttpClient and System.Text.Json; dependency-injection support uses the standard Microsoft.Extensions.Http typed-client integration.

Repository development¶

When working directly from this source tree:

dotnet restore Okatana.sln
dotnet build Okatana.sln -c Release
dotnet test Okatana.sln -c Release

A project can also reference the SDK directly:

<ItemGroup>
  <ProjectReference Include="../okatana-csharp/src/Newfoundcodes.Okatana/Newfoundcodes.Okatana.csproj" />
</ItemGroup>

Documentation dependencies¶

The documentation site uses Material for MkDocs:

python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Build documentation in strict mode before release:

mkdocs build --strict

Namespace map¶

The package uses these main namespaces:

Newfoundcodes.Okatana
Newfoundcodes.Okatana.Api
Newfoundcodes.Okatana.Models
Newfoundcodes.Okatana.Requests
Newfoundcodes.Okatana.Exceptions

Most applications need the root namespace plus Models and Requests.