Skip to content
/ pnpcore Public

The PnP Core SDK is a modern .NET SDK designed to work for Microsoft 365. It provides a unified object model for working with SharePoint Online and Teams which is agnostic to the underlying API's being called

License

Notifications You must be signed in to change notification settings

pnp/pnpcore

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

The PnP Core SDK is an SDK designed to work for Microsoft 365. It provides a unified object model for working with SharePoint Online and Teams which is agnostic to the underlying APIs being called. The initial goal for this library will be to cover the needs of developers working with either SharePoint Online or Teams, but we're also open to extend this library further towards other Microsoft 365 workloads if there's community demand for doing so.

Packages and status 🏭

Build and Test codecov Refresh documentation Nightly nuget release

Nuget package Downloads Stable Preview
PnP.Core Downloads PnP.Core Nuget package PnP.Core Nuget package
PnP.Core.Auth Downloads PnP.Core.Auth Nuget package PnP.Core.Auth Nuget package
PnP.Core.Admin Downloads PnP.Core.Admin Nuget package PnP.Core.Admin Nuget package
PnP.Core.Transformation Downloads soon PnP.Core.Transformation Nuget package
PnP.Core.Transformation.SharePoint Downloads soon PnP.Core.Transformation Nuget package

Getting started πŸš€

For more details on how to get started with the PnP.Core SDK checkout our documentation.

I want to help πŸ™‹β€β™‚οΈ

If you want to join our team and help, then checkout the How can I help section in our docs.

Supportability and SLA πŸ’πŸΎβ€β™€οΈ

This library is an open-source and community provided library backed by an active community supporting it. This is not a Microsoft provided library, so there's no SLA or direct support for this open-source component from Microsoft. Please report any issues using the issues list.

Frequently Asked Questions ❓

Will this work in modern .NET

Absolutely! One of the key reasons for building PnP Core SDK is to nicely fit into modern .NET development:

What underlying APIs are used

The SDK provides an object model that's API agnostic, when you as a developer for example load a model (List, Team, Web,...) the SDK will use the best possible API for loading that model being for the most part Microsoft Graph v1.0 and SharePoint REST. Depending on the needs the SDK will use Microsoft Graph Beta calls and in some cases the CSOM endpoint (client.svc) is called. But the good thing is that all of this is transparent for you as developer! You'll have a consistent development experience regardless of the underlying APIs being called.

As Microsoft Graph is our recommended API to work with Microsoft 365, the SDK will favor Microsoft Graph whenever it makes sense, the "fall back" to SharePoint REST only happens when Microsoft Graph can't provide the needed data or consistency.

What's the relationship with the existing PnP Framework library

The PnP Framework library is very popular library that extends SharePoint using mainly CSOM. This library contains the PnP Provisioning engine, tons of extension methods, etc...but this library has also organically grown into a complex and hard to maintain code base. One of the reasons why the PnP Core SDK development started is to provide a new clean replacement for PnP Framework with a strong focus on quality (test coverage above 80%, automation). As this transition will take quite some time and effort, we plan to gradually move things over from PnP Framework to the PnP Core SDK. Going forward PnP Framework features will move to the PnP Core SDK in a phased approach.

Community rocks, sharing is caring!

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

About

The PnP Core SDK is a modern .NET SDK designed to work for Microsoft 365. It provides a unified object model for working with SharePoint Online and Teams which is agnostic to the underlying API's being called

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages