Skip to content
A GitHub API client library for .NET
C# Other
  1. C# 99.7%
  2. Other 0.3%
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Octokit.Reactive Expose affiliation parameter when listing collaborators (#2043) Nov 18, 2019
Octokit.Tests.Conventions no need to build and run tests against net46 (#2005) Sep 20, 2019
Octokit.Tests.Integration Add get/update/delete methods for organization memberships (#2014) Oct 21, 2019
Octokit.Tests Expose affiliation parameter when listing collaborators (#2043) Nov 18, 2019
Octokit Expose affiliation parameter when listing collaborators (#2043) Nov 18, 2019
build (build) Update to Cake 0.35.0, update dependencies and improve dotnet… Oct 30, 2019
docs add support for multiple extension filters (#2019) Oct 3, 2019
samples/linqpad-samples Merge master into dotnetcore (#1599) May 2, 2017
script Begin implementation of Enterprise ManagementConsole API, redux (#2010) Sep 22, 2019
tools/LINQPad (build) Updated Cake.Frosting to version 0.34.1 (#1978) Aug 1, 2019
.gitattributes putting this back, just in case Dec 11, 2014
.gitignore Add missing ID property to Milestone (#2007) Sep 21, 2019
.travis.yml never email notification on success or error Sep 21, 2019
CODE_OF_CONDUCT.md changed the email address Jan 9, 2017
CONTRIBUTING.md Final tidyups for dotnetcore (#1600) May 4, 2017
CustomDictionary.xml Updated git data commit response with signature verification object (#… Jun 26, 2016
DEPLOYMENT.md Update DEPLOYMENT.md Mar 30, 2014
GitVersion.yml (build) Updated Cake.Frosting to version 0.34.1 (#1978) Aug 1, 2019
LICENSE.txt General updates (#1653) Aug 16, 2017
OVERVIEW.md extract OVERVIEW.md document which introduces the overall Octokit cod… Mar 14, 2016
Octokit.ruleset Remove unneeded files for .NET Core (#1549) Jan 28, 2017
Octokit.sln Added support for DateTime serialized as FileTime (#1735) Jan 18, 2018
Octokit.sln.DotSettings Additional GitHub Apps APIs (#1854) Sep 3, 2018
Octokit.vssettings Added VS settings file that contains the current project coding conve… Apr 22, 2014
README.md Generate code coverage output with coverlet (#1866) Sep 17, 2019
ReleaseNotes.md Release v0.32 - App-stravaganza! (#1864) Sep 9, 2018
appveyor.yml Generate code coverage output with coverlet (#1866) Sep 17, 2019
build.ps1 Release v0.30 - Where Have You Been All My Life? (#1816) Jun 17, 2018
build.sh Release v0.30 - Where Have You Been All My Life? (#1816) Jun 17, 2018
codecov.yml Generate code coverage output with coverlet (#1866) Sep 17, 2019
mkdocs.yml Adding initial support for GitHub Apps. (#1738) Apr 16, 2018
octokit-dotnet_2.png Wop optimized this repository (#1657) Aug 24, 2017

README.md

Octokit - GitHub API Client Library for .NET

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

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

Getting Started

Octokit is a GitHub API client library for .NET and is available on NuGet:

Install-Package Octokit

There is also 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.

To clone and build 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

To build the libraries, run the following command:

Windows: .\build.ps1

Linux/OSX: ./build.sh

Contribute

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

Problems?

If you find an issue with our library, 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 2017 GitHub, Inc.

Licensed under the MIT License

You can’t perform that action at this time.