Pithub...tarring(3pm)

πŸ“¦
version 0.01043 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

okay bestie, gather round, because this is Pithub::Repos::Starring β€” the Github v3 Repo Starring API πŸŽ€βœ¨ (yes the page header calls it Pithub...tarring(3pm), it's just the module name getting a lil squished, no cap πŸ’…)


✨ VERSION ✨

this is version 0.01043 🌸 β€” write it down, love her.


πŸ¦‹ METHODS πŸ¦‹

🌟 has_starred

  • Check if you are starring a repository. πŸ‘€ like… are you in the stargazers or not, bestie?
⚠️ this one requires the user to be authenticated. no login, no answer. periodt.

the endpoint it hits is:

GET /user/starred/:user/:repo

example time, here's how you'd actually call it:

my $s = Pithub::Repos::Starring->new;
my $result = $s->has_starred(
    repo => 'Pithub',
    user => 'plu',
);

🌈 list

  • List all stargazers of a repository πŸ’« everybody who ever hit that star button on this repo, gathered in one place.

the endpoint:

GET /repos/:user/:repo/stargazers

example:

my $s = Pithub::Repos::Starring->new;
my $result = $s->list(
    repo => 'Pithub',
    user => 'plu',
);

🧚 list_repos

this one's got two whole modes, iconic behavior honestly:

  • List repositories being starred by a user. 🌸 just a lil peek at somebody's starred list.

endpoint:

GET /users/:user/starred

example:

my $s = Pithub::Repos::Starring->new;
my $result = $s->list_repos(
    user => 'plu',
);
  • List repos being starred by the authenticated user πŸ‘‘ that's you, main character. it's the logged-in person's own starred list.

endpoint:

GET /user/starred

example (no user arg this time, because it's literally just you 🫢):

my $s = Pithub::Repos::Starring->new;
my $result = $s->list_repos;

⭐ star

  • Star a repository. 🌟 the whole point of this module, let's be real.
⚠️ requires the user to be authenticated. you can't star anything anonymously, bestie.

endpoint:

PUT /user/starred/:user/:repo

example:

my $s = Pithub::Repos::Starring->new;
my $result = $s->star(
    repo => 'Pithub',
    user => 'plu',
);

πŸ’€ unstar

  • Unstar a repository. 😭 the breakup arc. taking the star back. it's giving "we're not doing this anymore".
⚠️ yep, this one also requires the user to be authenticated.

endpoint:

DELETE /user/starred/:user/:repo

example:

my $s = Pithub::Repos::Starring->new;
my $result = $s->unstar(
    repo => 'Pithub',
    user => 'plu',
);

🫢 AUTHOR 🫢

Johannes Plunien β€” <plu@cpan.org> πŸ’œ the icon who made all this happen, we stan.


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. ✨ so yes, go off, remix her, share her, just keep it on those same terms fr fr.


okay that's the whole page bestie, tysm for reading πŸŽ€ this was Pithub...tarring(3pm), built against perl v5.40.1, dated 2025-06-08 β€” mwah, go star some repos πŸ’…βœ¨

πŸ“¦ where this page comes from