Home: Provide samples for coding against NuGet 3 codebase

[yishaigalatzer]

Need to enumerate common scenarios we want to show as samples, going to take a quick stab and will keep refining as feedback comes in

• [ ] Get latest version for a given package ID
• [ ] Search results for a given search string
• [ ] Download a package given ID and version (or just ID and get latest)
• [ ] Restore a project.json
• [ ] Restore a packages.config
• [ ] Control package extraction mode

Would be nice to contrast samples from nuget.core with the NuGet3 codebase.

We will gladly take pull requests to https://github.com/NuGet/docs.microsoft.com-nuget as folks find good ways to port over, and of course sample projects to https://github.com/nuget/samples utilizing the new API. I'm also open to running a CI on top of the samples to ensure breaking changes are at least known, if not immediately addressed.

[ferventcoder]

Thanks! Original request was https://github.com/NuGet/Home/issues/1870

[dazinator]

This will be a massive help, thank you.

[SimonCropp]

any update on this?

[devlead]

Last info I've seen is a comment on this blog post which stated

Actually, you can do it now. If you are interested ping us at [email protected] and I can send you a snippet. We haven't blogged about the API since there might be some changes to it in the future.

[daveaglick]

FWIW, I've got a blog series looking at the v3 APIs, though it's all based on spelunking through the code so I may have gotten some aspects wrong:

• Part 1 (Intro): http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-1
• Part 2 (Search): http://daveaglick.com/posts/exploring-the-nuget-v3-libraries-part-2
• Part 3 (Install): Should be coming this week or next

[devlead]

@daveaglick nice will definitely check those out :+1:

[agc93]

@devlead That's the reply to my comment! I've emailed them asking for anything they have, even referencing this issue, just waiting for a response now..

[devlead]

@agc93 ok cool :+1: Please ping back if you get any solid info,

[agc93]

I got a reply back from the team basically outlining that they don't have much information and actually indicating that Dave's blog posts are their best source currently!

Full response below:

Dave's blog is currently the best we got. We will gladly help unblock you with anything you are trying to do, but we don't currently plan to document the v3 API in the coming weeks at least. We unfortunately have to deliver things we can't shift and have no extra folks idling.

The Uber plan is to actually make the v3 libraries into supported apis and then we will document them. Currently they are not more than our internal implementation details published as courtesy.

We will gladly take pull requests for sample docs, and I hope we will be able to fund this effort soon, and give you better replies than this one.

[pvandervelde]

Any progress on this one. The API is not very well documented and using it involves lots of guessing with regards to how to do things.

[fhchina]

@ferventcoder did you find the replacement of ZipPackage in NuGet.Client?