A GitHub API client library for .NET
C# Other
ryangribble Release v0.31 - Check yo' self! (#1851)
* Fix whitespace/formatting with /FormatCode build option

* Update release notes

* fix a few failing integration tests

* Adjust required fields on UpdateCheckRun and NewCheckRun request models and fix tests
Tidy up field accessors and XmlDoc comments

* Update date in ReleaseNotes

* Keeping request models simple (avoid inheritance) - makes it easier when we move to generated models
Latest commit 1015220 Jul 21, 2018
Permalink
Failed to load latest commit information.
Octokit.Reactive Release v0.31 - Check yo' self! (#1851) Jul 21, 2018
Octokit.Tests.Conventions Adding a convention test to detect whether a model has a constructor … Apr 25, 2018
Octokit.Tests.Integration Release v0.31 - Check yo' self! (#1851) Jul 21, 2018
Octokit.Tests Release v0.31 - Check yo' self! (#1851) Jul 21, 2018
Octokit Release v0.31 - Check yo' self! (#1851) Jul 21, 2018
build Release v0.30 - Where Have You Been All My Life? (#1816) Jun 17, 2018
docs Update github-apps.md (#1843) Jul 4, 2018
samples/linqpad-samples Merge master into dotnetcore (#1599) May 2, 2017
script Implement Check Suites API (#1846) Jul 14, 2018
tools Migrate dotnetcore to vs2017 tooling (#1567) Mar 30, 2017
.gitattributes putting this back, just in case Dec 11, 2014
.gitignore Migrate dotnetcore to vs2017 tooling (#1567) Mar 30, 2017
.travis.yml Release v0.30 - Where Have You Been All My Life? (#1816) Jun 17, 2018
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 add GitVersion configuration file (#1555) Jan 29, 2017
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 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 NET Core (#1744) Jan 22, 2018
ReleaseNotes.md Release v0.31 - Check yo' self! (#1851) Jul 21, 2018
appveyor.yml Implement new Project Card archiving (#1842) Jul 11, 2018
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
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 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

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?

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 2017 GitHub, Inc.

Licensed under the MIT License