Module: Octokit::Client::CommunityProfile

Included in:

Octokit::Client

Defined in:

lib/octokit/client/community_profile.rb

Overview

Methods for the Community Profile API

See Also:

• https://developer.github.com/v3/repos/community/

Instance Method Summary

• #community_profile(repo, options = {}) ⇒ Sawyer::Resource

  Get community profile metrics for a repository.

Instance Method Details

#community_profile(repo, options = {}) ⇒ Sawyer::Resource

Get community profile metrics for a repository

Examples:

Get community profile metrics for octokit/octokit.rb

@client.community_profile('octokit/octokit.rb')

Parameters:

• repo (Integer, String, Hash, Repository) —

  A GitHub repository

Returns:

• (Sawyer::Resource) —

  Community profile metrics

See Also:

• https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics

# File 'lib/octokit/client/community_profile.rb', line 16

def community_profile(repo, options = {})
  get "#{Repository.path repo}/community/profile", options
end