NuGet.Packaging 6.12.1

Nuget.Packaging

NuGet.Packaging is a NuGet client SDK library that provides a set of APIs to interact with .nupkg and .nuspec files from a stream. It provides a way for developers to create and read packages and work with the package metadata.

Usage

It is strongly recommended that NuGet packages are created using the official NuGet tooling and instead of this low-level API. There are a variety of characteristics important for a well-formed package and the latest version of tooling helps incorporate these best practices.

For more information about creating NuGet packages, see the overview of the package creation workflow and the documentation for official pack tooling (for example, using the dotnet CLI).

Examples

Create a package

Create a package, set metadata, and add dependencies.

PackageBuilder builder = new PackageBuilder();
builder.Id = "MyPackage";
builder.Version = new NuGetVersion("1.0.0-beta");
builder.Description = "My package created from the API.";
builder.Authors.Add("Sample author");
builder.DependencyGroups.Add(new PackageDependencyGroup(
    targetFramework: NuGetFramework.Parse("netstandard1.4"),
    packages: new[]
    {
        new PackageDependency("Newtonsoft.Json", VersionRange.Parse("10.0.1"))
    }));

using FileStream outputStream = new FileStream("MyPackage.nupkg", FileMode.Create);
builder.Save(outputStream);
Console.WriteLine($"Saved a package to {outputStream.Name}");

Read a package

Read a package from a file.

using FileStream inputStream = new FileStream("MyPackage.nupkg", FileMode.Open);
using PackageArchiveReader reader = new PackageArchiveReader(inputStream);
NuspecReader nuspec = reader.NuspecReader;
Console.WriteLine($"ID: {nuspec.GetId()}");
Console.WriteLine($"Version: {nuspec.GetVersion()}");
Console.WriteLine($"Description: {nuspec.GetDescription()}");
Console.WriteLine($"Authors: {nuspec.GetAuthors()}");

Console.WriteLine("Dependencies:");
foreach (PackageDependencyGroup dependencyGroup in nuspec.GetDependencyGroups())
{
    Console.WriteLine($" - {dependencyGroup.TargetFramework.GetShortFolderName()}");
    foreach (var dependency in dependencyGroup.Packages)
    {
        Console.WriteLine($"   > {dependency.Id} {dependency.VersionRange}");
    }
}

Additional documentation

More information about the NuGet.Packaging library can be found on the official Microsoft documentation page and NuGet API docs.

Showing the top 20 packages that depend on NuGet.Packaging.

Packages Downloads
NuGet.Protocol
NuGet's implementation for interacting with feeds. Contains functionality for all feed types.
2,871
NuGet.Protocol
NuGet's implementation for interacting with feeds. Contains functionality for all feed types.
1,756
Microsoft.VisualStudio.Web.CodeGeneration.Design
Code Generation tool for ASP.NET Core. Contains the dotnet-aspnet-codegenerator command used for generating controllers and views.
828
Microsoft.DotNet.Scaffolding.Shared
Contains interfaces for Project Model and messaging for scaffolding.
822
Microsoft.VisualStudio.Web.CodeGenerators.Mvc
Code Generators for ASP.NET Core MVC. Contains code generators for MVC Controllers and Views.
819
Microsoft.VisualStudio.Web.CodeGeneration.Core
Contains the core infrastructure used by ASP.NET Core Code Generators.
816
Microsoft.VisualStudio.Web.CodeGeneration.EntityFrameworkCore
Contains Entity Framework Core Services used by ASP.NET Core Code Generators.
812
Microsoft.VisualStudio.Web.CodeGeneration
Contains the CodeGenCommand that finds the appropriate code generator and invokes it from project dependencies.
811
Microsoft.VisualStudio.Web.CodeGeneration.Utils
Contains utilities used by ASP.NET Core Code Generation packages.
807
Microsoft.VisualStudio.Web.CodeGeneration.Templating
Contains Razor based templating host used by ASP.NET Core Code Generators.
805
Microsoft.VisualStudio.Web.CodeGeneration.EntityFrameworkCore
Contains Entity Framework Core Services used by ASP.NET Core Code Generators.
456
Microsoft.VisualStudio.Web.CodeGeneration.Utils
Contains utilities used by ASP.NET Core Code Generation packages.
447
Microsoft.VisualStudio.Web.CodeGeneration.Core
Contains the core infrastructure used by ASP.NET Core Code Generators.
445
Microsoft.VisualStudio.Web.CodeGeneration
Contains the CodeGenCommand that finds the appropriate code generator and invokes it from project dependencies.
445
Microsoft.VisualStudio.Web.CodeGenerators.Mvc
Code Generators for ASP.NET Core MVC. Contains code generators for MVC Controllers and Views.
444
Microsoft.VisualStudio.Web.CodeGeneration.Templating
Contains Razor based templating host used by ASP.NET Core Code Generators.
443
Microsoft.DotNet.Scaffolding.Shared
Contains interfaces for Project Model and messaging for scaffolding.
441
Microsoft.VisualStudio.Web.CodeGeneration.Design
Code Generation tool for ASP.NET Core. Contains the dotnet-aspnet-codegenerator command used for generating controllers and views.
440
NuGet.Protocol
NuGet's implementation for interacting with feeds. Contains functionality for all feed types.
137
Microsoft.DotNet.Cli.Utils
Package Description
45

.NET Framework 4.7.2

.NET Standard 2.0

.NET 5.0

Version Downloads Last updated
6.12.1 11 11/13/2024
6.12.0 9 11/13/2024
6.11.1 11 10/19/2024
6.11.0 13 08/14/2024
6.11.0-preview.2 17 06/05/2024
6.10.2 11 08/14/2024
6.10.1 14 07/04/2024
6.10.0 15 06/08/2024
6.9.1 15 02/27/2024
6.8.1 23 02/27/2024
6.8.0 17 12/30/2023
6.7.1 21 02/20/2024
6.7.0 19 11/08/2023
6.6.2 17 03/14/2024
6.6.1 134 08/05/2023
6.6.0 20 06/21/2023
6.6.0-preview.3 18 06/09/2023
6.5.1 15 11/17/2023
6.5.0 18 09/18/2023
6.4.3 18 03/09/2024
6.4.2 23 09/06/2023
6.4.0 15 09/23/2023
6.3.4 19 02/27/2024
6.3.3 21 09/30/2023
6.3.1 1,734 05/08/2023
6.2.4 18 10/27/2023
6.2.2 15 10/13/2023
6.2.1 450 07/22/2022
6.1.0 17 10/13/2023
6.0.6 16 02/27/2024
6.0.5 20 06/23/2023
6.0.3-rc.1 15 12/30/2023
6.0.2 18 06/07/2023
5.11.6 18 02/27/2024
5.11.5 16 11/18/2023
5.11.3 25 06/07/2023
5.11.0 2,481 11/12/2021
5.10.0 19 07/04/2023
5.9.3 20 10/04/2023
5.8.1 21 06/08/2023
5.7.3-rtm.5 21 06/09/2023
5.7.2 18 10/12/2023
5.6.0 15 12/30/2023
5.5.1 18 09/10/2023
5.4.0 16 07/26/2023
5.3.1 22 06/09/2023
5.2.1 18 10/13/2023
5.1.0 20 06/08/2023
5.0.2 21 07/04/2023
4.9.6 17 07/22/2023
4.8.2 19 06/19/2023
4.7.3 19 06/07/2023
4.6.4 17 06/19/2023
4.5.3 34 09/27/2023
4.4.3 17 10/12/2023
4.3.1 16 10/13/2023
4.2.0 18 07/26/2023
4.1.0 21 10/12/2023
4.0.0 21 06/09/2023
3.5.0 16 08/19/2023
3.4.4-rtm-final 20 10/16/2023
3.4.3 19 10/12/2023
3.3.0 22 09/30/2023
3.2.0 18 10/13/2023