Pithub - Github v3 API


version 0.01017


    use Pithub;
    use Data::Dumper;

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

    # $result->content is either an arrayref or an hashref
    # depending on the API call that has been made
    printf "%s\n", $result->content->{html_url};     # prints
    printf "%s\n", $result->content->{clone_url};    # prints

    # if the result is an arrayref, you can use the result iterator
    my $result = $p->repos->list( user => 'plu' );
    while ( my $row = $result->next ) {
        printf "%s\n", $row->{name};


Pithub provides a set of modules to access the Github v3 API in an object oriented way. There is also Net::GitHub which does the same for all the versions (v1, v2, v3) of the Github API. Pithub supports all API calls so far, but only for v3.



Provides access to Pithub::Events.


Provides access to Pithub::Gists.


Provides access to Pithub::GitData.


Provides access to Pithub::Issues.


Provides access to Pithub::Orgs.


Provides access to Pithub::PullRequests.


Provides access to Pithub::Repos.

Provides access to Pithub::Search.


Provides access to Pithub::Users.


Quite a lot of the Pithub documentation has been taken directly from the great API documentation at Github. Please also read the documentation there, since it might be more complete and more up-to-date.


Pithub as well as the Github v3 API are still under development. So there might be things broken on both sides. Besides that it's possible that the API will change. This applies to Pithub itself as well as the Github v3 API.


This module is hosted on Github, so feel free to fork it and send pull requests. There are two different kinds of test suites, one is just checking the HTTP requests that are created by the method calls, without actually sending them. The second one is sending real requests to the Github API. If you want to contribute to this project, I highly recommend to run the live tests on a test account, because it will generate a lof of activity.


There are different ways of using the Pithub library. You can either use the main module Pithub to get access to all other modules, like Pithub::Repos for example. Or you can use Pithub::Repos directly and create an instance of it. All modules accept the same attributes, either in the constructor or later by calling the setters.

Besides that there are other modules involved. Every method call which maps directly to a Github API call returns a Pithub::Result object. This contains everything interesting about the response returned from the API call.

Pithub::Base might be interesting for two reasons:


Johannes Plunien <>


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.