NuGet.Packaging
6.7.0
dotnet add package NuGet.Packaging --version 6.7.0
NuGet\Install-Package NuGet.Packaging -Version 6.7.0
<PackageReference Include="NuGet.Packaging" Version="6.7.0" />
paket add NuGet.Packaging --version 6.7.0
#r "nuget: NuGet.Packaging, 6.7.0"
// Install NuGet.Packaging as a Cake Addin
#addin nuget:?package=NuGet.Packaging&version=6.7.0
// Install NuGet.Packaging as a Cake Tool
#tool nuget:?package=NuGet.Packaging&version=6.7.0
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.2
- Newtonsoft.Json (>= 13.0.1)
- NuGet.Configuration (>= 6.7.0)
- NuGet.Versioning (>= 6.7.0)
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.1)
- NuGet.Configuration (>= 6.7.0)
- NuGet.Versioning (>= 6.7.0)
- System.Security.Cryptography.Pkcs (>= 6.0.4)
-
net5.0
- Newtonsoft.Json (>= 13.0.1)
- NuGet.Configuration (>= 6.7.0)
- NuGet.Versioning (>= 6.7.0)
- System.Security.Cryptography.Pkcs (>= 6.0.4)
NuGet packages (103)
Showing the top 5 NuGet packages that depend on NuGet.Packaging:
Package | Downloads |
---|---|
NuGet.Protocol
NuGet's implementation for interacting with feeds. Contains functionality for all feed types. |
|
NuGet.Packaging.Core
The (former home to) core data structures for NuGet.Packaging. Contains only the type forwarders to the new assembly. |
|
NuGet.Repositories
NuGet v3 core library. |
|
Microsoft.DotNet.ProjectModel
Types to model a .NET Project |
|
NuGet.Protocol.Core.Types
NuGet's protocol-level base types used for connecting to API v2 and API v3 repositories. |
GitHub repositories (47)
Showing the top 5 popular GitHub repositories that depend on NuGet.Packaging:
Repository | Stars |
---|---|
dotnet/aspnetcore
ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
|
|
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
|
|
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
|
|
cake-build/cake
:cake: Cake (C# Make) is a cross platform build automation system.
|
|
dotnet/Open-XML-SDK
Open XML SDK by Microsoft
|
Version | Downloads | Last updated |
---|---|---|
6.7.0 | 130,658 | 8/9/2023 |
6.6.1 | 885,929 | 6/13/2023 |
6.6.0 | 56,976 | 5/17/2023 |
6.6.0-preview.3 | 148 | 5/17/2023 |
6.5.1 | 26,092 | 6/13/2023 |
6.5.0 | 291,646 | 2/22/2023 |
6.4.2 | 44,512 | 6/13/2023 |
6.4.0 | 824,322 | 11/9/2022 |
6.3.3 | 49,251 | 6/14/2023 |
6.3.1 | 7,316,922 | 10/11/2022 |
6.2.4 | 12,232 | 6/14/2023 |
6.2.2 | 38,668 | 10/11/2022 |
6.1.0 | 560,325 | 2/16/2022 |
6.0.5 | 28,977 | 6/13/2023 |
6.0.3-rc.1 | 508 | 10/11/2022 |
6.0.2 | 6,032 | 6/14/2022 |
5.11.5 | 451,902 | 6/15/2023 |
5.11.3 | 282,278 | 10/11/2022 |
5.10.0 | 3,786,006 | 6/15/2021 |
5.9.3 | 89,665 | 10/11/2022 |
5.8.1 | 193,043 | 1/16/2021 |
5.7.3-rtm.5 | 243 | 10/11/2022 |
5.7.2 | 4,843 | 6/14/2022 |
5.6.0 | 2,488,836 | 5/20/2020 |
5.5.1 | 1,117,506 | 4/3/2020 |
5.4.0 | 580,000 | 12/3/2019 |
5.3.1 | 6,291,904 | 10/25/2019 |
5.2.1 | 281 | 6/14/2022 |
5.1.0 | 251,423 | 5/21/2019 |
5.0.2 | 32,650 | 5/14/2019 |
4.9.6 | 3,146 | 10/11/2022 |
4.8.2 | 36,897 | 3/12/2019 |
4.7.3 | 716 | 3/15/2019 |
4.6.4 | 12,241 | 3/15/2019 |
4.5.3 | 12,371 | 3/15/2019 |
4.4.3 | 653 | 3/15/2019 |
4.3.1 | 10,992 | 3/12/2019 |
4.2.0 | 692,740 | 7/14/2017 |
4.1.0 | 5,574 | 7/14/2017 |
4.0.0 | 165,034 | 3/7/2017 |
3.5.0 | 484,116 | 12/14/2016 |
3.4.4-rtm-final | 2,619 | 6/3/2016 |
3.4.3 | 16,702 | 4/22/2016 |
3.3.0 | 127,103 | 12/1/2015 |
3.2.0 | 21,980 | 9/16/2015 |