.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::GitHub 3pm"
.TH Net::GitHub 3pm "2022-10-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::GitHub \- Perl Interface for github.com
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::GitHub;
\&
\&    my $github = Net::GitHub\->new(  # Net::GitHub::V3
\&        login => \*(Aqfayland\*(Aq, pass => \*(Aqsecret\*(Aq
\&    );
\&
\&    # If you use two factor authentication you can pass in the OTP. Do
\&    # note that OTPs expire quickly and you will need to generate an oauth
\&    # token to do anything non\-trivial.
\&    my $github = Net::GitHub\->new(
\&        login =>   \*(Aqfayland\*(Aq,
\&        pass =>    \*(Aqsecret\*(Aq,
\&        otp =>     \*(Aq123456\*(Aq,
\&    );
\&
\&    # Pass api_url for GitHub Enterprise installations. Do not include a
\&    # trailing slash
\&    my $github = Net::GitHub\->new(  # Net::GitHub::V3
\&        login =>   \*(Aqfayland\*(Aq,
\&        pass =>    \*(Aqsecret\*(Aq,
\&        api_url => \*(Aqhttps://gits.aresweet.com/api/v3\*(Aq
\&    );
\&
\&    # suggested
\&    # use OAuth to create token with user/pass
\&    my $github = Net::GitHub\->new(  # Net::GitHub::V3
\&        access_token => $token
\&    );
\&
\&    # L<Net::GitHub::V3::Users>
\&    my $user = $github\->user\->show(\*(Aqnothingmuch\*(Aq);
\&    $github\->user\->update( bio => \*(AqJust Another Perl Programmer\*(Aq );
\&
\&    # L<Net::GitHub::V3::Repos>
\&    my @repos = $github\->repos\->list;
\&    my $rp = $github\->repos\->create( {
\&        "name" => "Hello\-World",
\&        "description" => "This is your first repo",
\&        "homepage" => "https://github.com"
\&    } );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
<http://github.com> is a popular git host.
.PP
This distribution provides easy methods to access GitHub via their APIs.
.PP
Check <http://developer.github.com/> for more details of the GitHub APIs.
.PP
Read Net::GitHub::V3 for \s-1API\s0 usage.
.PP
Read Net::GitHub::V4 for GitHub GraphQL \s-1API.\s0
.PP
If you prefer object oriented way, Pithub is 'There is more than one way to do it'.
.SS "\s-1FAQ\s0"
.IX Subsection "FAQ"
.IP "\(bu" 4
create access_token for Non-Web Application
.Sp
.Vb 7
\&    my $gh = Net::GitHub::V3\->new( login => \*(Aqfayland\*(Aq, pass => \*(Aqsecret\*(Aq );
\&    my $oauth = $gh\->oauth;
\&    my $o = $oauth\->create_authorization( {
\&        scopes => [\*(Aquser\*(Aq, \*(Aqpublic_repo\*(Aq, \*(Aqrepo\*(Aq, \*(Aqgist\*(Aq], # just [\*(Aqpublic_repo\*(Aq]
\&        note   => \*(Aqtest purpose\*(Aq,
\&    } );
\&    print $o\->{token};
.Ve
.Sp
after create the token, you can use it without your password publicly written
.Sp
.Vb 3
\&    my $github = Net::GitHub\->new(
\&        access_token => $token, # from above
\&    );
.Ve
.SH "Git"
.IX Header "Git"
<http://github.com/fayland/perl\-net\-github/>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pithub
.SH "AUTHOR"
.IX Header "AUTHOR"
Fayland Lam, \f(CW\*(C`<fayland at gmail.com>\*(C'\fR
.PP
Everyone who is listed in \fBChanges\fR.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009\-2012 Fayland Lam all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.