File: README

package info (click to toggle)
libnet-github-perl 0.95-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 360 kB
  • sloc: perl: 1,927; makefile: 2
file content (103 lines) | stat: -rw-r--r-- 2,852 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
NAME

    Net::GitHub - Perl Interface for github.com

SYNOPSIS

        use Net::GitHub;
    
        my $github = Net::GitHub->new(  # Net::GitHub::V3
            login => 'fayland', pass => 'secret'
        );
    
        # 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 =>   'fayland',
            pass =>    'secret',
            otp =>     '123456',
        );
    
        # Pass api_url for GitHub Enterprise installations. Do not include a
        # trailing slash
        my $github = Net::GitHub->new(  # Net::GitHub::V3
            login =>   'fayland',
            pass =>    'secret',
            api_url => 'https://gits.aresweet.com/api/v3'
        );
    
        # 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('nothingmuch');
        $github->user->update( bio => 'Just Another Perl Programmer' );
    
        # 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"
        } );

DESCRIPTION

    http://github.com is a popular git host.

    This distribution provides easy methods to access GitHub via their
    APIs.

    Check http://developer.github.com/ for more details of the GitHub APIs.

    Read Net::GitHub::V3 for API usage.

    Read Net::GitHub::V4 for GitHub GraphQL API.

    If you prefer object oriented way, Pithub is 'There is more than one
    way to do it'.

 FAQ

      * create access_token for Non-Web Application

          my $gh = Net::GitHub::V3->new( login => 'fayland', pass => 'secret' );
          my $oauth = $gh->oauth;
          my $o = $oauth->create_authorization( {
              scopes => ['user', 'public_repo', 'repo', 'gist'], # just ['public_repo']
              note   => 'test purpose',
          } );
          print $o->{token};

      after create the token, you can use it without your password publicly
      written

          my $github = Net::GitHub->new(
              access_token => $token, # from above
          );

Git

    http://github.com/fayland/perl-net-github/

SEE ALSO

    Pithub

AUTHOR

    Fayland Lam, <fayland at gmail.com>

    Everyone who is listed in Changes.

COPYRIGHT & LICENSE

    Copyright 2009-2012 Fayland Lam all rights reserved.

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