Pithub(3pm)

📦

version 0.01043 · 4 versions

0.01043 · debian trixie, ubuntu resolute, ubuntu stonking (latest)
0.01036 · ubuntu jammy
0.01041 · ubuntu noble
0.01040 · debian bookworm

, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Okay bestie, welcome to Pithub — the Github v3 API in Perl form. This page is from the User Contributed Perl Documentation collection, and yes, it's called Pithub(3pm). Periodt. 💅

✨ VERSION ✨

version 0.01043 ✨

🫶 SYNOPSIS 🫶

Real talk, this is the vibe in code form:

use Pithub ();

my $p = Pithub->new;
# my $p = Pithub->new(utf8 => 0); # enable compatibility options for version 0.01029 or lower
my $repo = $p->repos->get( user => 'plu', repo => 'Pithub' );

# $repo->content is either an arrayref or an hashref
# depending on the API call that has been made
printf "%s\n", $repo->content->{html_url};     # prints https://github.com/plu/Pithub
printf "%s\n", $repo->content->{clone_url};    # prints https://github.com/plu/Pithub.git

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

# Connect to your local GitHub Enterprise instance
my $ghe_p = Pithub->new(
    api_uri => 'https://github.yourdomain.com/api/v3/'
);

# No need to provide user/repo to each module:
my $pit = Pithub->new(
  user  => 'plu',
  repo  => 'pithub',
  token => 'my_oauth_token',
);

$pit->repos->get;
$pit->repos->commits->list;

# Use a caching UserAgent
use CHI                    ();
use Pithub::Repos          ();
use WWW::Mechanize::Cached ();

my $cache = CHI->new(
    driver   => 'File',
    root_dir => '/tmp/pithub-example'
);

my $mech = WWW::Mechanize::Cached->new( cache => $cache );

my $cached_pithub = Pithub::Repos->new(
    auto_pagination => 1,
    per_page        => 100,
    ua              => $mech,
);

Obsessed with how clean that is, honestly. 🦋

🌸 DESCRIPTION 🌸

So Pithub (that's Perl + Github, iconic name behavior) hands you a whole set of modules to talk to the Github v3 API at http://developer.github.com/v3/ — and it does it all in an object oriented way, which is exactly the energy we're bringing today.

There's also Net::GitHub, which does the same thing but for all the versions (v1, v2, v3) of the Github API. Pithub? It supports all API calls so far, but only for v3. Pick your fighter. 💀

👑 ATTRIBUTES 👑

🎀 search_api 🎀

my $p = Pithub->new({ search_api => 'v3' });
my $search = $p->search; # $search->isa('Pithub::SearchV3');

This attribute is literally just you telling it which API to use for searches by default. The two accepted values are "v3" and "legacy". And because compatibility reasons, the default is "legacy". Not me still defaulting to legacy in this economy 😭 — but okay, it is what it is.

💅 METHODS 💅

Every one of these is your lil gateway module, and they all just provide access to their thing. Go off, king. 🔥

events — Provides access to Pithub::Events.
gists — Provides access to Pithub::Gists.
git_data — Provides access to Pithub::GitData.
issues — Provides access to Pithub::Issues.
markdown — Provides access to Pithub::Markdown.
orgs — Provides access to Pithub::Orgs.
pull_requests — Provides access to Pithub::PullRequests.
repos — Provides access to Pithub::Repos.

🌈 search 🌈

my $legacy_search  = $p->search(search_api => 'legacy');
my $v3_search      = $p->search(search_api => 'v3');
my $default_search = $p->search;

Provides access to Pithub::Search and Pithub::SearchV3. And here's the tea: when you don't pass a "search_api" option, the value it uses is whatever you gave the "search_api" attribute. Default behavior, no surprises. ✨

🫶 users 🫶

users — Provides access to Pithub::Users.

📚 DOCUMENTATION 📚

Ngl, a lot of the Pithub documentation has been taken directly from the genuinely great API documentation at Github — http://developer.github.com/v3/. Please also read the docs over there, because it might be more complete and more up-to-date. That's not a drag, that's just facts. 🙈

Also: Pithub::Base contains documentation for attributes inherited by all Pithub modules. So if you're wondering where an attribute came from, check there first, bestie. 🦋

⚠️ WARNING ⚠️

Pithub, as well as the Github v3 API at http://developer.github.com/v3/, are still under development. So like… 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 at http://developer.github.com/v3/.

Real talk: nothing here is set in stone. Guard your expectations accordingly. 🫶

🌟 CONTRIBUTE 🌟

This module is hosted on Github at https://github.com/plu/Pithub, so feel free to fork it and send pull requests. Queen behavior only. 👑

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. Chill, safe, no drama.
The second one is sending real requests to the Github API.

If you want to contribute to this project, I highly recommend running the live tests on a test account, because it will generate a lot of activity. Not me accidentally spamming my whole main account — use the burner, bestie. 😭

🧚 MODULES 🧚

There are different ways of using the Pithub library. You can either use the main module Pithub to get access to all the 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. It's giving little wrapped gift. 🎁

Pithub::Base might be interesting for two reasons:

The list of attributes which all modules accept.
The request method: In case Github adds a new API call which is not supported yet by Pithub, the request method can be used directly to perform this new API call — there's some documentation on how to use it.
- Pithub::Events

my $events = Pithub->new->events;
my $events = Pithub::Events->new;

Pithub::Gists

my $gists = Pithub->new->gists;
my $gists = Pithub::Gists->new;

Pithub::Gists::Comments

my $comments = Pithub->new->gists->comments;
my $comments = Pithub::Gists->new->comments;
my $comments = Pithub::Gists::Comments->new;

Pithub::GitData

my $git_data = Pithub->new->git_data;
my $git_data = Pithub::GitData->new;

Pithub::GitData::Blobs

my $blobs = Pithub->new->git_data->blobs;
my $blobs = Pithub::GitData->new->blobs;
my $blobs = Pithub::GitData::Blobs->new;

Pithub::GitData::Commits

my $commits = Pithub->new->git_data->commits;
my $commits = Pithub::GitData->new->commits;
my $commits = Pithub::GitData::Commits->new;

Pithub::GitData::References

my $references = Pithub->new->git_data->references;
my $references = Pithub::GitData->new->references;
my $references = Pithub::GitData::References->new;

Pithub::GitData::Tags

my $tags = Pithub->new->git_data->tags;
my $tags = Pithub::GitData->new->tags;
my $tags = Pithub::GitData::Tags->new;

Pithub::GitData::Trees

my $trees = Pithub->new->git_data->trees;
my $trees = Pithub::GitData->new->trees;
my $trees = Pithub::GitData::Trees->new;

Pithub::Issues

my $issues = Pithub->new->issues;
my $issues = Pithub::Issues->new;

Pithub::Issues::Assignees

my $assignees = Pithub->new->issues->assignees;
my $assignees = Pithub::Issues->new->assignees;
my $assignees = Pithub::Issues::Assignees->new;

Pithub::Issues::Comments

my $comments = Pithub->new->issues->comments;
my $comments = Pithub::Issues->new->comments;
my $comments = Pithub::Issues::Comments->new;

Pithub::Issues::Events

my $events = Pithub->new->issues->events;
my $events = Pithub::Issues->new->events;
my $events = Pithub::Issues::Events->new;

Pithub::Issues::Labels

my $labels = Pithub->new->issues->labels;
my $labels = Pithub::Issues->new->labels;
my $labels = Pithub::Issues::Labels->new;

Pithub::Issues::Milestones

my $milestones = Pithub->new->issues->milestones;
my $milestones = Pithub::Issues->new->milestones;
my $milestones = Pithub::Issues::Milestones->new;

Pithub::Orgs

my $orgs = Pithub->new->orgs;
my $orgs = Pithub::Orgs->new;

Pithub::Orgs::Members

my $members = Pithub->new->orgs->members;
my $members = Pithub::Orgs->new->members;
my $members = Pithub::Orgs::Members->new;

Pithub::Orgs::Teams

my $teams = Pithub->new->orgs->teams;
my $teams = Pithub::Orgs->new->teams;
my $teams = Pithub::Orgs::Teams->new;

Pithub::PullRequests

my $pull_requests = Pithub->new->pull_requests;
my $pull_requests = Pithub::PullRequests->new;

Pithub::PullRequests::Comments

my $comments = Pithub->new->pull_requests->comments;
my $comments = Pithub::PullRequests->new->comments;
my $comments = Pithub::PullRequests::Comments->new;

Pithub::PullRequests::Reviewers

And for the reviewers, the code is literally:

my $reviewers = Pithub->new->pull_requests->reviewers;
my $reviewers = Pithub::PullRequests->new->reviewers;
my $reviewers = Pithub::PullRequests::Reviewers->new;

Pithub::Repos — the repos hub, lowkey the main character of your GitHub adventures.

my $repos = Pithub->new->repos;
my $repos = Pithub::Repos->new;

Pithub::Repos::Collaborators — for when you need to see who's on the team, bestie.

my $collaborators = Pithub->new->repos->collaborators;
my $collaborators = Pithub::Repos->new->collaborators;
my $collaborators = Pithub::Repos::Collaborators->new;

Pithub::Repos::Commits — all the commit tea, fr fr.

my $commits = Pithub->new->repos->commits;
my $commits = Pithub::Repos->new->commits;
my $commits = Pithub::Repos::Commits->new;

Pithub::Repos::Contents — peek inside the repo files, no cap.

my $contents = Pithub->new->repos->contents;
my $contents = Pithub::Repos->new->contents;
my $contents = Pithub::Repos::Contents->new;

Pithub::Repos::Downloads — okay so this one is deprecated, so pay attention.

⚠️ Github says: The Downloads API (described below) was deprecated on December 11, 2012. It will be removed at a future date. We recommend using Pithub::Repos::Releases instead.

my $downloads = Pithub->new->repos->downloads;
my $downloads = Pithub::Repos->new->downloads;
my $downloads = Pithub::Repos::Downloads->new;

Pithub::Repos::Forks — fork it and make it your own, periodt.

my $forks = Pithub->new->repos->forks;
my $forks = Pithub::Repos->new->forks;
my $forks = Pithub::Repos::Forks->new;

Pithub::Repos::Keys — deploy keys, very secure, very demure.

my $keys = Pithub->new->repos->keys;
my $keys = Pithub::Repos->new->keys;
my $keys = Pithub::Repos::Keys->new;

Pithub::Repos::Releases — the release era, iconic.

my $releases = Pithub->new->repos->releases;
my $releases = Pithub::Repos->new->releases;
my $releases = Pithub::Repos::Releases->new;

Note that Pithub::Repos::Releases requires Boolean values for some calls. See Pithub::Repos::Releases for details.

Pithub::Repos::Releases::Assets — the assets that come with your releases, slay.

my $assets = Pithub->new->repos->releases->assets;
my $assets = Pithub::Repos->new->releases->assets;
my $assets = Pithub::Repos::Releases->new->assets;
my $assets = Pithub::Repos::Releases::Assets->new;

Pithub::Repos::Stats — stats, numbers, the data vibes.

my $watching = Pithub->new->repos->stats;
my $watching = Pithub::Repos->new->stats;
my $watching = Pithub::Repos::Stats->new;

Pithub::Repos::Statuses — status updates, keeping you in the loop.

my $watching = Pithub->new->repos->statuses;
my $watching = Pithub::Repos->new->statuses;
my $watching = Pithub::Repos::Statuses->new;

Pithub::Repos::Watching — watch the repo, be a secret admirer.

my $watching = Pithub->new->repos->watching;
my $watching = Pithub::Repos->new->watching;
my $watching = Pithub::Repos::Watching->new;

Pithub::Users — all about the users, the people, the icons.

my $users = Pithub->new->users;
my $users = Pithub::Users->new;

Pithub::Users::Emails — emails, but make it GitHub.

my $emails = Pithub->new->users->emails;
my $emails = Pithub::Users->new->emails;
my $emails = Pithub::Users::Emails->new;

Pithub::Users::Followers — followers, the fan club.

my $followers = Pithub->new->users->followers;
my $followers = Pithub::Users->new->followers;
my $followers = Pithub::Users::Followers->new;

Pithub::Users::Keys — user keys, keep it locked.

my $keys = Pithub->new->users->keys;
my $keys = Pithub::Users->new->keys;
my $keys = Pithub::Users::Keys->new;

🌟 CONTRIBUTORS 🌟

Shoutout to these absolute legends who made this happen:

Andreas Marienborg
Alessandro Ghedini
Michael G Schwern

👑 AUTHOR 👑

The one and only: Johannes Plunien <plu@cpan.org> — bow down.

📜 COPYRIGHT AND LICENSE 📜

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

And that's the tea, bestie! This page is from perl v5.40.1, dated 2025-06-08, and it's the Pithub(3pm) manual. Stay iconic! 💅✨

📦 where this page comes from

debian trixie: libpithub-perl 0.01043-1 · Artistic-1.0-Perl OR GPL-1.0-or-later
ubuntu resolute: libpithub-perl 0.01043-1 · Artistic-1.0-Perl OR GPL-1.0-or-later
ubuntu stonking: libpithub-perl 0.01043-1 · Artistic-1.0-Perl OR GPL-1.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms