NuGet.Packaging 6.11.0-preview.2
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 |
|---|---|
|
Microsoft.DotNet.Scaffolding.Shared
Contains interfaces for Project Model and messaging for scaffolding.
|
6 |
|
Microsoft.VisualStudio.Web.CodeGeneration
Contains the CodeGenCommand that finds the appropriate code generator and invokes it from project dependencies.
|
6 |
|
Microsoft.VisualStudio.Web.CodeGeneration.Design
Code Generation tool for ASP.NET Core. Contains the dotnet-aspnet-codegenerator command used for generating controllers and views.
|
6 |
|
Microsoft.VisualStudio.Web.CodeGeneration.Templating
Contains Razor based templating host used by ASP.NET Core Code Generators.
|
6 |
|
Microsoft.VisualStudio.Web.CodeGenerators.Mvc
Code Generators for ASP.NET Core MVC. Contains code generators for MVC Controllers and Views.
|
7 |
|
NuGet.Packaging.Core
The (former home to) core data structures for NuGet.Packaging. Contains only the type forwarders to the new assembly.
|
6 |
|
NuGet.Repositories
NuGet v3 core library.
|
6 |
|
NuGet.Repositories
NuGet.Repositories
|
6 |
.NET Framework 4.7.2
- NuGet.Configuration (>= 6.11.0-preview.2)
- NuGet.Versioning (>= 6.11.0-preview.2)
- Newtonsoft.Json (>= 13.0.3)
.NET 5.0
- NuGet.Configuration (>= 6.11.0-preview.2)
- NuGet.Versioning (>= 6.11.0-preview.2)
- Newtonsoft.Json (>= 13.0.3)
- System.Security.Cryptography.Pkcs (>= 6.0.4)
.NET Standard 2.0
- NuGet.Configuration (>= 6.11.0-preview.2)
- NuGet.Versioning (>= 6.11.0-preview.2)
- Newtonsoft.Json (>= 13.0.3)
- System.Security.Cryptography.Pkcs (>= 6.0.4)
| Version | Downloads | Last updated |
|---|---|---|
| 6.11.1 | 4 | 16.10.2024 |
| 6.11.0 | 6 | 22.09.2024 |
| 6.11.0-preview.2 | 4 | 28.10.2024 |
| 6.10.2 | 6 | 22.09.2024 |
| 6.10.1 | 6 | 22.09.2024 |
| 6.10.0 | 0 | 21.05.2024 |
| 6.9.1 | 5 | 22.09.2024 |
| 6.8.1 | 6 | 22.09.2024 |
| 6.8.0 | 0 | 17.11.2023 |
| 6.7.1 | 6 | 22.09.2024 |
| 6.7.0 | 6 | 22.09.2024 |
| 6.6.2 | 4 | 22.09.2024 |
| 6.6.1 | 6 | 09.04.2024 |
| 6.6.0 | 4 | 19.10.2024 |
| 6.6.0-preview.3 | 4 | 19.10.2024 |
| 6.5.1 | 6 | 22.09.2024 |
| 6.5.0 | 4 | 19.10.2024 |
| 6.4.3 | 6 | 22.09.2024 |
| 6.4.2 | 4 | 19.10.2024 |
| 6.4.0 | 4 | 22.09.2024 |
| 6.3.4 | 4 | 19.10.2024 |
| 6.3.3 | 6 | 22.09.2024 |
| 6.3.1 | 7 | 28.02.2024 |
| 6.2.4 | 4 | 19.10.2024 |
| 6.2.2 | 4 | 20.10.2024 |
| 6.1.0 | 5 | 22.09.2024 |
| 6.0.6 | 6 | 22.09.2024 |
| 6.0.5 | 6 | 22.09.2024 |
| 6.0.3-rc.1 | 6 | 22.09.2024 |
| 6.0.2 | 6 | 22.09.2024 |
| 5.11.6 | 5 | 22.09.2024 |
| 5.11.5 | 3 | 19.10.2024 |
| 5.11.3 | 6 | 22.09.2024 |
| 5.10.0 | 5 | 22.09.2024 |
| 5.9.3 | 6 | 22.09.2024 |
| 5.8.1 | 3 | 27.10.2024 |
| 5.7.3-rtm.5 | 3 | 22.10.2024 |
| 5.7.2 | 3 | 21.10.2024 |
| 5.6.0 | 4 | 22.09.2024 |
| 5.5.1 | 5 | 22.09.2024 |
| 5.4.0 | 6 | 22.09.2024 |
| 5.3.1 | 0 | 25.10.2019 |
| 5.2.1 | 5 | 22.09.2024 |
| 5.1.0 | 4 | 19.10.2024 |
| 5.0.2 | 3 | 19.10.2024 |
| 4.9.6 | 5 | 22.09.2024 |
| 4.8.2 | 4 | 19.10.2024 |
| 4.7.3 | 6 | 22.09.2024 |
| 4.6.4 | 4 | 22.09.2024 |
| 4.5.3 | 5 | 22.09.2024 |
| 4.4.3 | 4 | 19.10.2024 |
| 4.3.1 | 6 | 22.09.2024 |
| 4.2.0 | 6 | 22.09.2024 |
| 4.1.0 | 5 | 22.09.2024 |
| 4.0.0 | 4 | 19.10.2024 |
| 3.5.0 | 0 | 14.12.2016 |
| 3.4.4-rtm-final | 4 | 19.10.2024 |
| 3.4.3 | 4 | 20.10.2024 |
| 3.3.0 | 0 | 01.12.2015 |
| 3.2.0 | 4 | 22.09.2024 |