A GitHub API client library for .NET
C# Other
Latest commit aa80eaa Jan 16, 2017 @ryangribble ryangribble committed on GitHub Add "Bot" AccountType, was causing a deserialization exception when r…
…unning the integration test "SearchForExcludedLanguage" (#1541)
Permalink
Failed to load latest commit information.
Octokit.Next.Tests adding .NET Core solution and projects Sep 12, 2016
Octokit.Next adding .NET Core solution and projects Sep 12, 2016
Octokit.Reactive Add multiple assignees to issues (#1339) Jan 11, 2017
Octokit.Tests.Conventions [WIP] Protected branches updates - granular methods (#1443) Sep 20, 2016
Octokit.Tests.Integration Add Id for PullRequest.cs (#1537) Jan 14, 2017
Octokit.Tests Update ApiErrorMessageSafe to return null for empty and whitespace st… Jan 16, 2017
Octokit Add "Bot" AccountType, was causing a deserialization exception when r… Jan 16, 2017
docs Add docs snippet for label coloring (#1530) Jan 9, 2017
ext Add Xamarin component store versions of Octokit.Reactive Oct 30, 2013
packages cleanup packages folder Dec 20, 2015
samples/linqpad-samples update linqpad tests to use correct APIs Jul 23, 2016
script Made change in configure-integration-tests Mar 7, 2016
tools Fixes for mono Dec 12, 2015
.gitattributes putting this back, just in case Dec 11, 2014
.gitignore adding .NET Core solution and projects Sep 12, 2016
.travis.yml brincg back linux since last build passed Sep 15, 2016
CODE_OF_CONDUCT.md changed the email address Jan 9, 2017
CONTRIBUTING.md Fix a broken link Apr 7, 2016
CustomDictionary.xml Updated git data commit response with signature verification object (#… Jun 26, 2016
DEPLOYMENT.md Update DEPLOYMENT.md Mar 30, 2014
LICENSE.txt Adding README, CONTRIBUTING, LICENSE Jan 9, 2013
OVERVIEW.md extract OVERVIEW.md document which introduces the overall Octokit cod… Mar 14, 2016
Octokit-Mono.sln Fixes for mono Dec 12, 2015
Octokit-XamarinStudio.sln Add VS-style code formatting settings into Xam Studio sln May 1, 2014
Octokit.Core.sln adding .NET Core solution and projects Sep 12, 2016
Octokit.Reactive.nuspec The nuget package includes the samples Oct 5, 2015
Octokit.nuspec Merge pull request #921 from naveensrinivasan/samples Nov 4, 2015
Octokit.ruleset Creates constructors for all Models.Response. Jan 25, 2015
Octokit.sln Repository invitations changes (#1410) Jul 23, 2016
Octokit.sln.DotSettings oops, corrected the test Jun 5, 2015
Octokit.vssettings Added VS settings file that contains the current project coding conve… Apr 22, 2014
README.md add mention in README May 11, 2016
ReleaseNotes.md it is now today, not yesterday Oct 7, 2016
SolutionInfo.cs added release notes Oct 4, 2016
appveyor.yml bring back original build tasks Sep 14, 2016
build.cmd update FAKE to get dotnet CLI support Sep 12, 2016
build.fsx add .NET Core targets in FAKE build script Sep 12, 2016
build.sh update FAKE to get dotnet CLI support Sep 12, 2016
mkdocs.yml added tests for new behaviour within pagination Feb 14, 2016
octokit-dotnet_2.png Changed the octokit logo to smaller size Oct 7, 2015

README.md

Octokit - GitHub API Client Library for .NET

Build status Build Status Join the chat at https://gitter.im/octokit/octokit.net

logo

Octokit is a client library targeting .NET 4.5 and above that provides an easy way to interact with the GitHub API.

Usage examples

Get public info on a specific user.

var github = new GitHubClient(new ProductHeaderValue("MyAmazingApp"));
var user = await github.User.Get("half-ogre");
Console.WriteLine(user.Followers + " folks love the half ogre!");

Supported Platforms

  • .NET 4.5 (Desktop / Server)
  • Xamarin.iOS / Xamarin.Android / Xamarin.Mac
  • Mono 3.x
  • Windows 8 / 8.1 Store Apps

Getting Started

Octokit is available on NuGet.

Install-Package Octokit

or an IObservable based GitHub API client library for .NET using Reactive Extensions

Install-Package Octokit.Reactive

Beta packages

Unstable NuGet packages that track the master branch of this repository are available at https://ci.appveyor.com/nuget/octokit-net

In Xamarin Studio you can find this option under the project's context menu: Add | Add Packages...*.

Documentation

Documentation is available at http://octokitnet.readthedocs.io/en/latest/.

Build

Octokit is a single assembly designed to be easy to deploy anywhere. If you prefer to compile it yourself, you’ll need:

  • Visual Studio 2015 or Xamarin Studio
  • Windows 8.1 or higher to build and test the WinRT projects

To clone it locally click the "Clone in Desktop" button above or run the following git commands.

git clone git@github.com:octokit/Octokit.net.git Octokit
cd Octokit
.\build.cmd

Contribute

Visit the Contributor Guidelines for more details. All contributors are expected to follow our Code of Conduct.

Problems?

Octokit is 100% certified to be bug free. If you find an issue with our certification, please visit the issue tracker and report the issue.

Please be kind and search to see if the issue is already logged before creating a new one. If you're pressed for time, log it anyways.

When creating an issue, clearly explain

  • What you were trying to do.
  • What you expected to happen.
  • What actually happened.
  • Steps to reproduce the problem.

Also include any other information you think is relevant to reproduce the problem.

Related Projects

Copyright and License

Copyright 2013 GitHub, Inc.

Licensed under the MIT License