• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
  • Configuration
• SUBROUTINES/METHODS
• DIAGNOSTICS
• CONFIGURATION AND ENVIRONMENT
• DEPENDENCIES
• INCOMPATIBILITIES
• BUGS AND LIMITATIONS
• AUTHOR
• LICENSE AND COPYRIGHT

NAME

Group::Git::Github - Adds reading all repositories you have access to on github.com

VERSION

This documentation refers to Group::Git::Github version 0.6.8.

SYNOPSIS

   use Group::Git::Github;

   # pull (or clone missing) all repositories that joeblogs has created/forked
   my $ggg = Group::Git::Github->new(
       conf => {
           username => 'joeblogs@gmail.com',
           password => 'myverysecurepassword',
       },
   );

   # or if you have two factor auth turned on
   my $ggg = Group::Git::Github->new(
       conf => {
           username => 'joeblogs@gmail.com',
           password => 'myverysecurepassword',
           ota      => 1,
       },
   );

   # Alternitavely using personal access tokens
   # You can setup at https://github.com/settings/applications
   my $ggg = Group::Git::Github->new(
       conf => {
           access_token => '...',
       },
   );

   # list all repositories
   my $repositories = $ggg->repo();

   # do something to each repository
   for my $repo (keys %{$repositories}) {
       # eg do a pull
       $ggg->pull($repo);
   }

DESCRIPTION

Reads all repositories for the configured user. Note: if no username, password or access_token is set you will be prompted to enter a username and password.

Configuration

There are three configuration parameters that are currently used

access_token

A github OAuth personal access token. If supplied then username and password are ignored.

username

Specify the user to login as, if not specified the user will be prompted to enter a username.

password

Specify the password to login with, if not specified the user will be prompted to enter a password.

SUBROUTINES/METHODS

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

LICENSE AND COPYRIGHT

Copyright (c) 2013 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

                    cpanm Group::Git::Github

                    perl -MCPAN -e shell
                    install Group::Git::Github