NuGet Package Download API

[zhili1208]

Initial Spec: https://github.com/NuGet/Home/wiki/%5BSpec%5D-Package-download-API

[zhili1208]

@jeffkl -jeff, I wrote a initial spec for this API, Please provide feedback.

[jeffkl]

I think it would be better if the method had this signature:

public static string DownloadPackage(
  string packageId,
  string version,
  ISettings settings,
  ILogger logger)

From my perspective, I just need NuGet to acquire the package and tell me where it put it. I think taking an ISettings which would be more flexible.

I also don't care about target framework for this particular case as the packages won't have any TFM-specific folders. In my opinion, this API is just requesting that NuGet download the package to where ever NuGet would put it. I do not want to tell NuGet where to put the package. That seems like legacy packages.config behavior.

I'll also need logging so passing in an ILogger is a necessity.

We do not need an MSBuild task for this API. It can just exist in the object model and I'll be implementing an SdkResolver which runs before targets and tasks execute.

Does NuGet need to support downloading multiple packages in one call?

At this time no, but perhaps the API should take a list? That would save us from having to add this functionality later.

Does NuGet need to provide a way to find all dependency packages after the top package downloaded?

I'm on the fence on this one. SDK packages can't currently have dependencies so I don't need this right now but I can see in the future needing to make that work.

[isaacabraham]

Can we also see how this is documented in terms of the actual HTTP API (if there are any changes planned that impact that)?

[zhili1208]

@jeffkl Why you need ISettings ? it only contains NuGet.Config, I think this interface should be used only in nuget, it's not for public use.

[zhili1208]

@isaacabraham I don't think there are any changes that impact actual HTTP API.

[jeffkl]

Passing ISettings would make things a little more flexible for the caller than just passing in a root directory. But either one works. My code will be restoring a package for a particular project so I could also pass in that path and your API could use that as the root directory for creating an ISettings object.

[emgarten]

There are a lot of pitfalls around creating ISettings, unless you really need to customize this you are better off just passing the path as you described.