NAME

Pithub::Repos - Github v3 Repos API

VERSION

version 0.01003

METHODS

branches

• List Branches

  GET /repos/:user/:repo/branches

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->branches( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->branches( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->branches;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->branches( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->branches( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->branches;

contributors

• List contributors

  GET /repos/:user/:repo/contributors

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->contributors( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->contributors( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->contributors;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->contributors( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->contributors( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->contributors;

create

• Create a new repository for the authenticated user.

  POST /user/repos

  Examples:

  $result = $p->repos->create( data => { name => 'some-repo' } );

• Create a new repository in this organization. The authenticated user must be a member of this organization.

  POST /orgs/:org/repos

  Examples:

  $result = $p->repos->create(
      org  => 'CPAN-API',
      data => { name => 'some-repo' }
  );

get

• Get a repo

  GET /repos/:user/:repo

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->get( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->get( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->get;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->get( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->get( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->get;

languages

• List languages

  GET /repos/:user/:repo/languages

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->languages( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->languages( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->languages;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->languages( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->languages( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->languages;

list

• List repositories for the authenticated user.

  GET /user/repos

• List public repositories for the specified user.

  GET /users/:user/repos

• List repositories for the specified org.

  GET /orgs/:org/repos

  Examples:

  $result = $p->repos->list( user => 'plu' );
  $result = $p->repos->list( org => 'CPAN-API' );
  $result = $p->repos->list;

tags

• List Tags

  GET /repos/:user/:repo/tags

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->tags( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->tags( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->tags;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->tags( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->tags( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->tags;

teams

• List Teams

  GET /repos/:user/:repo/teams

  Examples:

  $p      = Pithub->new;
  $result = $p->repos->teams( user => 'plu', repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu' );
  $result = $p->repos->teams( repo => 'Pithub' );
  
  $p      = Pithub->new( user => 'plu', repo => 'Pithub' );
  $result = $p->repos->teams;
  
  $r      = Pithub::Repos->new;
  $result = $r->repos->teams( user => 'plu', repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu' );
  $result = $r->repos->teams( repo => 'Pithub' );
  
  $r      = Pithub::Repos->new( user => 'plu', repo => 'Pithub' );
  $result = $r->repos->teams;

update

• Edit

  PATCH /repos/:user/:repo

  Examples:

  # update a repo for the authenticated user
  $result = $p->repos->update(
      repo => Pithub,
      data => { description => 'Github API v3' },
  );

AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.