Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

grab only certain information from remote git repo and store them local

Project description


grab only certain information from remote git repo and store them local

general information

pygitgrab is not intended to be a replacement for git and it's capabilities. pygitgrab will not do housekeeping, meaning maintaing the local directory content like syncing or such a like. in case remote files or folders are dropped it is required to clean local folders manually.


the module is on pypi and can be installed with pip

run from cmd line

python3 -m pygitgrab -h

python3 -m pygitgrab -u user_name # user_name is optional, will prompt for password

github offers downloading for unauthenticed users only within certain rate limits in case downloading a bunch of serveral project files it is required to authenticate. (see also deprecation note of GitHub at the end of this document)

pygg.cfg structure

pygitgrab loads a pygg.cfg config file from the current directory to perform the required steps. the structure is as following:

# url to repo
# optional version to check out, defaults to 'master'
# optional destination folder given, defaults to 'repo_alias' (name of this section in the config file)
# pull_alias is just a name for the pull task
pull_alias="*.py", "new_folder"
# sample for pulling a license and store them at a different place
license="", "LICENSE/a_license.MD"

pygitgrab will create the directory structure as found in the remote git repo when pattern matching is used.

pygitgrab uses python configparser. general information regarding the syntax can be found there.

other pygg files

when calling with parameter -f cfgfile the configuration is read from there instead of pygg.cfg config file. if a file extension is missing an extension .pygg is added as default.

cmd line parameter

usage: python3 -m pygitgrab [options]

grab files from remote git repo.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show version info and exit
  -L, --license         show license info and exit
  -s, --simulate        dry run, do not download files
  -f FILE, --file FILE  name of pygg file to read, adds as '.pygg' extension
                        if missing
  -u [USER], --user [USER]
                        authenticate with user, no user for prompt. create a
                        personal access token in your github settings instead
                        of using a password. unauthenticated users have a
                        lower rate for downloading from github.
  -c [CREDITS], --credits [CREDITS]
                        read user and personal token from a file instead of
                        prompting. make sure to put the file not in git
                        controlled directory, (default: '~/pygg.credits.txt')

for more information refer to

3rd party licenses

when you move 3rd party license information into the special folder 'LICENSE' the cmd python3 -m pygitgrab -L will produce a summary of all found licences together with a 'LICENSE' file found in the current directory. use as python3 -m pygitgrab -L > LICENSES to produce a summary plain text file.


works only with github as backend.

deprecation of user and password authentication

github recently announced to discontinue user/password authentication soon.

use a personal access token instead of a password.

create your personal access token under GitHub developer settings as described in the help for creating a personal access token

the minimum required scope(s) of the token is public_repo

using a credits file instead of manual authentication

with the option -c or --credits pygitgrab reads the github user credits from a file.

this defaults to ~/pygg.credits.txt in the home directory if not specified. dont put it under a git controlled directory to prevent exposing your sensitive data.

the file itself should have 2 lines the following structure:


it can have blank lines at any place.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pygitgrab, version 0.0.16
Filename, size File type Python version Upload date Hashes
Filename, size pygitgrab-0.0.16-py3-none-any.whl (8.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pygitgrab-0.0.16.tar.gz (7.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page