.TH datalad-create-sibling-github 1 2016\-11\-10 "datalad-create-sibling-github 0.4.1"
.SH SYNOPSIS
 \fBdatalad\-create\-sibling\-github\fR [--version] [-h] [-l LEVEL] [-p {condor}]
                              [--dataset DATASET] [-r]
                              [--recursion-limit LEVELS] [--sibling-name NAME]
                              [--existing MODE] [--github-user NAME]
                              [--github-passwd PASSWORD]
                              [--github-organization NAME]
                              [--access-protocol ACCESS_PROTOCOL]
                              [--publish-depends SIBLINGNAME] [--dryrun]
                              REPONAME


.SH DESCRIPTION
Create dataset sibling on Github.
.br

.br
A repository can be created under a user's Github account, or any
.br
organization a user is a member of (given appropriate permissions).
.br

.br
Recursive sibling creation for subdatasets is supported. A dataset
.br
hierarchy is represented as a flat list of Github repositories.
.br

.br
Github cannot host dataset content. However, in combination with
.br
other data sources (and siblings), publishing a dataset to Github can
.br
facilitate distribution and exchange, while still allowing any dataset
.br
consumer to obtain actual data content from alternative sources.
.br

.br
For Github authentication user credentials can be given as arguments.
.br
Alternatively, they are obtained interactively or queried from the systems
.br
credential store. Lastly, an *oauth* token stored in the Git
.br
configuration under variable *hub.oauthtoken* will be used automatically.
.br
Such a token can be obtained, for example, using the commandline Github
.br
interface (https://github.com/sociomantic/git\-hub) by running:
.br
git hub setup.
.SH OPTIONS
  REPONAME              Github repository name. When operating recursively, a
                        suffix will be appended to this name for each
                        subdataset. Constraints: value must be a string

  \fB--version\fR       show the program's version and license information
  \fB-h\fR, \fB--help\fR, \fB--help-np\fR
                        show this help message. --help-np forcefully disables
                        the use of a pager for displaying the help message
  \fB-l\fR LEVEL, \fB--log-level\fR LEVEL
                        set logging verbosity level. Choose among critical,
                        error, warning, info, debug. Also you can specify an
                        integer <10 to provide even more debugging information
  \fB-p\fR {condor}, \fB--pbs-runner\fR {condor}
                        execute command by scheduling it via available PBS.
                        For settings, config file will be consulted
  \fB--dataset\fR \fI\s-1DATASET\s0\fR, \fB-d\fR \fI\s-1DATASET\s0\fR
                        specify the dataset to create the publication target
                        for. If no dataset is given, an attempt is made to
                        identify the dataset based on the current working
                        directory. Constraints: Value must be a Dataset or a
                        valid identifier of a Dataset (e.g. a path) [Default:
                        None]
  \fB-r\fR, \fB--recursive\fR
                        if set, recurse into potential subdataset. [Default:
                        False]
  \fB--recursion-limit\fR LEVELS
                        limit recursion into subdataset to the given number of
                        levels. Constraints: value must be convertible to type
                        'int' [Default: None]
  \fB--sibling-name\fR NAME
                        name to represent the Github repository in the local
                        dataset installation. Constraints: value must be a
                        string [Default: 'github']
  \fB--existing\fR MODE
                        desired behavior when already existing or configured
                        siblings are discovered. 'skip': ignore; 'error': fail
                        immediately; 'reconfigure': use the existing
                        repository and reconfigure the local dataset to use it
                        as a sibling. Constraints: value must be one of
                        ('skip', 'error', 'reconfigure') [Default: 'error']
  \fB--github-user\fR NAME
                        Github user name. Constraints: value must be a string
                        [Default: None]
  \fB--github-passwd\fR PASSWORD
                        Github user password. Constraints: value must be a
                        string [Default: None]
  \fB--github-organization\fR NAME
                        If provided, the repository will be created under this
                        Github organization. The respective Github user needs
                        appropriate permissions. Constraints: value must be a
                        string [Default: None]
  \fB--access-protocol\fR \fI\s-1ACCESS_PROTOCOL\s0\fR
                        Which access protocol/URL to configure for the
                        sibling. Constraints: value must be one of ('git',
                        'ssh') [Default: 'git']
  \fB--publish-depends\fR SIBLINGNAME
                        add a dependency such that the given exsiting sibling
                        is always published prior to the new sibling. This
                        equals setting a configuration item
                        'remote.SIBLINGNAME.datalad-publish-depends'. This
                        option can be given more than once to configure
                        multiple dependencies. [Default: None]
  \fB--dryrun\fR        If this flag is set, no communication with Github is
                        performed, and no repositories will be created.
                        Instead would-be repository names are reported for all
                        relevant datasets . [Default: False]
.SH AUTHORS
 datalad is developed by The DataLad Team and Contributors <team@datalad.org>.