GitHub-File

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

First, you will need to provide your GitHub credentials through the environment. Since github-file uses python-dotenv you can do so by creating a .env file with the following contents:

GITHUB_USER=your_username
GITHUB_PASS=your_password

Next, you will need to create a valid Githubfile. Here's an example of one:

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

[features]
has_issues = true
has_projects = false
has_wiki = false

[merges]
allow_squash_merge = false
allow_merge_commit = false
allow_rebase_merge = true

The meaning of these options is explained in GitHub's API documentation, although not all the options are currently supported (in particular you currently can't archive the repository or configure the default branch.)

Finally, running

$ github-file update -f Githubfile

will update the configuration of your GitHub repository so that it matches what is described in the file. Note that if you don't provide a filename it will look by default in .github/Githubfile.

Author

Jacopo Notarstefano (@Jaconotar)

License

MIT