GitHubHealth 0.0.0.1641126251

GitHubHealth is a Python library for monitoring code health in GitHub.

GitHubHealth

GitHubHealth is a Python library for monitoring code health in GitHub.

Installation

Use the package manager pip to install GitHubHealth.

# shell
pip install GitHubHealth

Usage

Set access token environment variable.

# shell
export GITHUB_TOKEN=<your github pat>

Get repo health as pandas DataFrame.

# python
import os
from GitHubHealth.main import ACCESS_TOKEN_VAR_NAME
from GitHubHealth import GitHubHealth
my_repo_health = GitHubHealth(gat=os.environ[ACCESS_TOKEN_VAR_NAME], timeout=4)
my_repo_health.user.get_repo_df()
my_repo_health.user.repo_df

Launch Flask app to view repo health tables and plots.

# python
from GitHubHealth import app
app.run()

# python
raise Exception

Contributing

Collaborators can be added on a case by case basis so please reach out if you would like to
contribute. As this is a personal hobby I will review any PRs and manage access and deployment
myself. I welcome any issues and feature requests to be submitted and will try to reply in a
timely manner. Please make sure to update tests as appropriate. I advise using use pre-commit to
help with automated testing and adhering to pylint and black formatting standards.

License

MIT