Skip to main content

A simple function to test whether your git repo is clean

Project description

Is Git Repo Clean

Table of Contents


What is it?

A simple function that tests whether your git repo is clean.

by clean I mean it has:

  • no untracked files
  • no staged changes
  • no unstaged changes

Installing this also exposes a cli command is-git-repo-clean

Why create it?

I wanted to write a build script that would exit early if the git repo wasn't clean


$ pip install is_git_repo_clean



import is_git_repo_clean

async def isCleanAsync(pathToGitRepo = None):
  # async by default
   return await is_git_repo_clean.check(pathToGitRepo)

def isCleanSync(pathToGitRepo = None):
  # sync available
  return is_git_repo_clean.checkSync(pathToGitRepo)


$ is-git-repo-clean --help

  is-git-repo-clean [--dir <path>] [--silent]
  is-git-repo-clean --help
  is-git-repo-clean --version

  dir:      path to the git repo to test.  Defaults to `os.getcwd()`
  silent:   disables output
  help:     print this
  version:  prints the version of this tool

  <exit code>: <output>

  0: yes
  1: no
  2: <invalid arg message>
  3: dir is not a git repository
  4: unexpected error occurred <error>


is_git_repo_clean exports the following

check async (dir=os.getcwd()) => bool

  • an asynchronous function that returns whether the git repo is clean

checkSync (dir=os.getcwd()) => bool

  • a synchronous function that returns whether the git repo is clean



hub clone olsonpm/py_is-git-repo-clean
cd py_is-git-repo-clean

Project details

Download files

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

Source Distribution

is_git_repo_clean-0.3.6.tar.gz (5.7 kB view hashes)

Uploaded source

Built Distribution

is_git_repo_clean-0.3.6-py3-none-any.whl (7.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page