Skip to content

A GitHub API client library for .NET

License

Notifications You must be signed in to change notification settings

abadaa/octokit.net

This branch is 1348 commits behind octokit/octokit.net:main.

Folders and files

NameName
Last commit message
Last commit date
May 20, 2016
Apr 19, 2016
May 20, 2016
May 20, 2016
May 23, 2016
Mar 14, 2016
Oct 30, 2013
Dec 20, 2015
Dec 9, 2015
Mar 7, 2016
Dec 12, 2015
Dec 11, 2014
Jan 27, 2016
Apr 3, 2016
Apr 7, 2016
Jan 28, 2016
Mar 30, 2014
Jan 9, 2013
Mar 14, 2016
Dec 12, 2015
May 1, 2014
Oct 5, 2015
Nov 4, 2015
Jan 25, 2015
Dec 11, 2015
Jun 5, 2015
Apr 22, 2014
May 5, 2016
Mar 10, 2016
Mar 30, 2016
Dec 13, 2015
Mar 16, 2016
Feb 2, 2016
Mar 16, 2016
Feb 14, 2016
Oct 7, 2015

Repository files navigation

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 [email protected]:octokit/Octokit.net.git Octokit
cd Octokit
.\build.cmd

Contribute

Visit the Contributor Guidelines for more details.

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

About

A GitHub API client library for .NET

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.5%
  • Other 0.5%