Oakrey.Applications.Reporting 2.0.0

dotnet add package Oakrey.Applications.Reporting --version 2.0.0
                    
NuGet\Install-Package Oakrey.Applications.Reporting -Version 2.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="Oakrey.Applications.Reporting" Version="2.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oakrey.Applications.Reporting" Version="2.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Oakrey.Applications.Reporting" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Oakrey.Applications.Reporting --version 2.0.0
                    
#r "nuget: Oakrey.Applications.Reporting, 2.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.
#:package Oakrey.Applications.Reporting@2.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Oakrey.Applications.Reporting&version=2.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Oakrey.Applications.Reporting&version=2.0.0
                    
Install as a Cake Tool

Oakrey.Applications.Reporting

The "Reporting" project is a .NET 8 library designed to provide a flexible and extensible framework for generating and managing reports. It supports structured reporting with metadata, multiple output formats, and integration with evidence-based systems.

Features

Report Generation:

Generate structured reports with metadata using FileReporter and RunnableReporter. Supports hierarchical reporting with blocks, items, and overall summaries.

Customizable Output:

IReportFilePathProvider allows customization of report file paths. IReporterTypeNameProvider provides naming conventions for report components.

Evidence Integration:

Supports evidence-based reporting with IEvidence integration.

Extensibility:

Interfaces like IReporter, IReporterEngine, and IReportFilePathProvider allow for easy extension and customization.

Batch Reporting:

RunnableReporter enables broadcasting reports to multiple engines simultaneously.

Metadata Support:

ReportMetadata allows adding properties and traces to reports for detailed context.

Thread-Safe File Writing:

FileReporter ensures thread-safe writing to report files.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Applications.Reporting and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Applications.Reporting

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Applications.Reporting

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net8.0-windows7.0 is compatible.  net9.0-windows was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.0 163 8/4/2025
1.0.0 213 4/17/2025