Githubtoolkit

A Python module for interacting with GitHub

Installation

Using pip

You can install githubtoolkit via pip using

in a commandline:

py -m pip install githubtoolkit

in a python script:

import os
os.system('py -m pip install githubtoolkit')

Usage

Uploading a file

You can upload a file using

githubtoolkit.upload_file_to_github(file, repo, token, branch, alias, comment)

Required

file specifies the path to the file you want to load up

repo specifies the repository you want to upload to

token is your login method

Not required

branch specifies the branch uploaded to (standard: "main")

alias specifies the path the file is uploaded in (standard: file)

comment adds a comment to your changes (standard: "Update "+filename_)

Uploading file content directly

You can also directly upload the content of a file instead of letting the program do that.
Therefore, you can use

githubtoolkit.upload_content_to_github(content, file_path, repo, token, branch, comment)

None of these args have default values as they are normally called by the above function.

The values that aren't explained above are:

content is the content of the file

file_path is now used as the path your file is saved under on GitHub

Other methods

Also, you can call the main() method to get a uploading agent.
The about() method returns information about your specific release.

You can call the main function from a commandline using

py -m githubtools

Contact

Use the following for contact / feedback information:

githubtools.about()["feedbackTo"]

Credits

This module is a fork of upload-content-to-github.
This means some of the credits go to bohachu.

More coming soon...