Pithub::Repos(3pm)

📦
version 0.01043 · 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Pithub::Repos — bestie, it's the Github v3 Repos API 💅 (that's the manual page Pithub::Repos(3pm), Perl-flavored, and she's iconic).

✨ VERSION ✨

version 0.01043 — yes, she's got a version number and she's proud of it 🎀

🦋 METHODS 🦋

okay so here's the whole menu, no skips, no skimming, we're doing all of them 🌸

actions

Gives you the keys to Pithub::Repos::Actions. That's it, that's the whole vibe ✨

branch

Get the tea on one single branch. Just the one. She's the main character 👑

GET /repos/:owner/:repo/branches/:branch

Example, copy it exactly bestie:

my $result = Pithub->new->branch(
    user => 'plu',
    repo => 'Pithub',
    branch => "master"
);
also peep branches if you want the whole list of branches, not just this one 🫶

branches

  • List Branches 🌈
GET /repos/:user/:repo/branches

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->branches( user => 'plu', repo => 'Pithub' );
want just one of them? that's branch, go look at her 💅

rename_branch

  • Rename a branch — glow-up for a branch name, literally ✨
POST /repos/:user/:repo/branches/:branch/rename

Examples:

my $b = Pithub::Repos->new;
my $result = $b->rename_branch(
    user => 'plu',
    repo => 'Pithub',
    branch  => 'travis',
    data => { new_name => 'travis-ci' }
);

merge_branch

  • Merge a branch — two branches becoming one, it's giving soulmates 😭💖
POST /repos/:user/:repo/merges

Examples:

my $b = Pithub::Repos->new;
my $result = $b->rename_branch(
    user => 'plu',
    repo => 'Pithub',
    data => { base => 'master', head => 'travis', message => 'My commit message' }
);

collaborators

Access to Pithub::Repos::Collaborators — the besties you build with 🫶

commits

Access to Pithub::Repos::Commits — the receipts 📜

contents

Access to Pithub::Repos::Contents — what's actually inside 📂

contributors

  • List contributors 🌟
GET /repos/:user/:repo/contributors

Examples:

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

create

  • Create a new repository for the authenticated user. ✨ new repo smell ✨
POST /user/repos

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->create( data => { name => 'some-repo' } );
  • Create a new repository in this organization. The authenticated user must be a member of this organization. 👑 (fr fr, you gotta be in the group chat first)
POST /orgs/:org/repos

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->create(
    org  => 'CPAN-API',
    data => { name => 'some-repo' }
);

delete

Delete a repository. 💀 gone, deleted, no takebacks.

DELETE /repos/:owner/:repo

downloads

Access to Pithub::Repos::Downloads 📥

forks

Access to Pithub::Repos::Forks 🍴

get

  • Get a repo 💅
GET /repos/:user/:repo

Examples:

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

hooks

Access to Pithub::Repos::Hooks 🪝

issues

Access to Pithub::Issues for this repo 🐛

keys

Access to Pithub::Repos::Keys 🔑

languages

  • List languages 🗣️
GET /repos/:user/:repo/languages

Examples:

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

list

  • List repositories for the authenticated user. 🫶
GET /user/repos

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->list;
  • List public repositories for the specified user. 🌈
GET /users/:user/repos

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->list( user => 'plu' );
  • List repositories for the specified org. 👑
GET /orgs/:org/repos

Examples:

my $repos  = Pithub::Repos->new;
my $result = $repos->list( org => 'CPAN-API' );

markdown

Access to Pithub::Markdown, and the way it works is it sets the current repository as the default context. It also sets the mode to default to 'gfm'. Periodt 💅

pull_requests

Access to Pithub::PullRequests 🫶

releases

Access to Pithub::Repos::Releases 🎉

starring

Access to Pithub::Repos::Starring ⭐

stats

Provide access to Pithub::Repos::Stats 📊

statuses

Provide access to Pithub::Repos::Statuses 🚦

tags

  • List Tags 🏷️
GET /repos/:user/:repo/tags

Examples:

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

teams

  • List Teams 👯
GET /repos/:user/:repo/teams

Examples:

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

update

  • Edit ✏️
PATCH /repos/:user/:repo

Examples:

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

watching

Access to Pithub::Repos::Watching 👀

🌸 AUTHOR 🌸

Johannes Plunien <plu@cpan.org> — the icon who wrote all this 💜

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.

and that's the whole page bestie, ily, go ship some repos 🦋✨ — this was perl v5.40.1, dated 2025-06-08, for Pithub::Repos(3pm). slay 💅

📦 where this page comes from