Git Product home page Git Product logo

octokit.net's Introduction

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.org/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

octokit.net's People

Contributors

shiftkey avatar haacked avatar hahmed avatar alexander-efremov avatar ryangribble avatar hnrkndrssn avatar half-ogre avatar m-zuber avatar tclem avatar ammeep avatar khellang avatar pltaylor avatar jrsconfitto avatar ninjanye avatar forki avatar gabrielweyer avatar trsneed avatar anaisbetts avatar prayankmathur avatar andycross avatar kristianhald avatar heytherewill avatar jpsullivan avatar samth3d3v avatar spraints avatar lbargaoanu avatar rogertinsley avatar kzu avatar devkhan avatar phantomtypist avatar

Watchers

James Cloos avatar rosa maria palacios juncosa avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.