---
name: "Net::GitHub::V3::Users"
section: "3pm"
platform: "linux"
package: "libnet-github-perl"
version: "1.05-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Net::GitHub::V3::Users"
---

# Net::GitHub::V3::Users(3pm)

GitHub Users API

## NAME

Net::GitHub::V3::Users - GitHub Users API

## SYNOPSIS

```
    use Net::GitHub::V3;
    my $gh = Net::GitHub::V3->new; # read L<Net::GitHub::V3> to set right authentication info
    my $user = $gh->user;
```

## DESCRIPTION

### METHODS

*Users*

\<http://developer.github.com/v3/users/\>

- show

  ```
      my $uinfo = $user->show(); # /user
      my $uinfo = $user->show( 'nothingmuch' ); # /users/:user
  ```

- update

  ```
      $user->update(
          bio  => 'another Perl programmer and Father',
      );
  ```

*Emails*

\<http://developer.github.com/v3/users/emails/\>

- emails

  - add\_email

  - remove\_email

  ```
      $user->add_email( 'another@email.com' );
      $user->add_email( 'batch1@email.com', 'batch2@email.com' );
      my $emails = $user->emails;
      while ($email = $user->next_email) { ...; }
      $user->remove_email( 'another@email.com' );
      $user->remove_email( 'batch1@email.com', 'batch2@email.com' );
  ```

*Followers*

\<http://developer.github.com/v3/users/followers/\>

- followers

  - following

  - next\_follower

  - next\_following

  ```
      my $followers = $user->followers;
      my $followers = $user->followers($user);
      my $following = $user->following;
      my $following = $user->following($user);
      my $next_follower = $user->next_follower
      my $next_follower = $user->next_follower($user)
      my $next_following = $user->next_following
      my $next_following = $user->next_following($user)
  ```

- is\_following

  ```
      my $is_following = $user->is_following($user);
  ```

- follow

  - unfollow

  ```
      $user->follow( 'nothingmuch' );
      $user->unfollow( 'nothingmuch' );
  ```

*Keys*

\<http://developer.github.com/v3/users/keys/\>

- keys

  - key

  - create\_key

  - update\_key

  - delete\_key

  ```
      my $keys = $user->keys;
      while (my $key = $user->next_key) { ...; }
      my $key  = $user->key($key_id); # get key
      $user->create_key({
          title => 'title',
          key   => $key
      });
      $user->update_key($key_id, {
          title => $title,
          key   => $key
      });
      $user->delete_key($key_id);
  ```

- contributions

  ```
      my $contributions = $user->contributions($username);
      # $contributions = ( ..., ['2013/09/22', 3], [ '2013/09/23', 2 ] )
  ```

  Unpublished GitHub API used to build the 'Public contributions' graph on a users' profile page.  The data structure is a list of 365 arrayrefs, one per day. Each array has two elements, the date in YYYY/MM/DD format is the first element, the second is the number of contrubtions for that day.stree .

## AUTHOR & COPYRIGHT & LICENSE

Refer Net::GitHub
