Skip to main content

Configure your GitHub repository from a file, without having to click around in the UI.

Project description

https://travis-ci.org/jacquerie/github-file.svg?branch=master https://coveralls.io/repos/github/jacquerie/github-file/badge.svg?branch=master

About

Configure your GitHub repository from a file, without having to click around in the UI.

Install

github-file is on PyPI, so all you have to do is:

$ pip install github-file

Usage

Currently github-file implements one subcommand:

$ github-file update

This will update the configuration of your repository on GitHub so that it matches what is described in a file called (by default) Githubfile in the .github folder. Here’s an example of such a file:

[core]
owner = jacquerie
repo = github-file
description = Configure your GitHub repository from a file,
    without having to click around in the UI.

[features]
has_issues = true
has_wiki = false

The meaning of these options is explained in GitHub’s API documentation at https://developer.github.com/v3/repos/#edit, although not all options are currently available. Here’s what’s currently configurable:

  • description

  • homepage

  • private

  • has_issues

  • has_wiki

Author

Jacopo Notarstefano (@Jaconotar)

License

MIT

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page