{
"info": {
"author": "Philip Olson",
"author_email": "philip.olson@pm.me",
"bugtrack_url": null,
"classifiers": [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7"
],
"description": "## Is Git Repo Clean\n\n\n\n**Table of Contents**\n\n- [Intro](#intro)\n - [What is it?](#what-is-it)\n - [Why create it?](#why-create-it)\n- [Install](#install)\n- [Usage](#usage)\n - [programmatic](#programmatic)\n - [cli](#cli)\n- [Api](#api)\n - [`check` async (dir=os.getcwd()) => bool](#check-async-dirosgetcwd--bool)\n - [`checkSync` (dir=os.getcwd()) => bool](#checksync-dirosgetcwd--bool)\n - [`version`](#version)\n- [Test](#test)\n\n\n\n
\n\n### Intro\n\n#### What is it?\n\nA simple function that tests whether your git repo is clean.\n\nby *clean* I mean it has:\n- no untracked files\n- no staged changes\n- no unstaged changes\n\nInstalling this also exposes a cli command `is-git-repo-clean`\n\n\n#### Why create it?\n\nI wanted to write a build script that would exit early if the git repo\nwasn't clean\n\n
\n\n### Install\n\n```sh\n$ pip install is_git_repo_clean\n```\n\n
\n\n### Usage\n\n#### programmatic\n\n```python\nimport is_git_repo_clean\n\n\nasync def isCleanAsync(pathToGitRepo = None):\n # async by default\n return await is_git_repo_clean.check(pathToGitRepo)\n\n\ndef isCleanSync(pathToGitRepo = None):\n # sync available\n return is_git_repo_clean.checkSync(pathToGitRepo)\n```\n\n#### cli\n\n```sh\n$ is-git-repo-clean --help\n\nUsage\n is-git-repo-clean [--dir ] [--silent]\n is-git-repo-clean --help\n is-git-repo-clean --version\n\nOptions\n dir: path to the git repo to test. Defaults to `os.getcwd()`\n silent: disables output\n help: print this\n version: prints the version of this tool\n\nReturns\n :