Skip to main content

Find and remove the mold from your source control repositories

Project description

bleach

Remove mold from your repositories :)

Bleach is a project dedicated to helping software development teams keep track of their repositories and make sure no pull request is left unattended. Bleach may query GitHub and BitBucket repositories, and write alerts on pull requests open for too long to Slack. Bleach may also try to make an educated guess as for whether or not two branches are out of sync. For example, a master branch may be expected to contain all commits from a staging branch, and Bleach will alert if that is not the case.

Installing

For unpriviliged users: pip install --user bleachrepo

Or for priviliged users / with sudo: pip install bleachrepo

Running & Commands

python -m bleach <org> <repo> <command> <additional_params_for_command>

Viable commands are: pr - check the status of open pull requests of given <repo> in <org>. branch - compare two branches, checking if commits are present in one branch, but not another.

Pull requests

pr is used to check the status of pull requests in a given repo, and helps find pull requests that are open for too long. for example, python -m bleach shesekino bleach pr will write to stdout a summary of pull requests open for over 2 days.

Branch sync

branch is used to check for commits appearing in one branch, but not another. This feature can be useful for repositories with a master branch that is expected to eventually contain all recent commits from a staging branch. python -m bleach shesekino bleach branch test-branch-discrepancy-1 test-branch-discrepancy-2 will check if there are commits in branch test-branch-discrepancy-2 that do not appear in test-branch-discrepancy-1.

This feature somewhat relies on guesswork and assumptions.

Private & public repositories

Public repositories require no special treatment. For private repositories, obtain a GitHub access token with repo permissions, then set it as an environment variable:

export BLEACH_GITHUB_ACCESS_TOKEN=<access token>

and run normally.

Writing to Slack

Set a webhook URL to slack:

export BLEACH_SLACK_WEBHOOK=<webhook url>

then run:

python -m bleach --outputMethod slack <org> <repo> <command>

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

bleachrepo-0.0.24.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

bleachrepo-0.0.24-py2-none-any.whl (11.4 kB view details)

Uploaded Python 2

File details

Details for the file bleachrepo-0.0.24.tar.gz.

File metadata

  • Download URL: bleachrepo-0.0.24.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.2

File hashes

Hashes for bleachrepo-0.0.24.tar.gz
Algorithm Hash digest
SHA256 601f11e272391a3fbc2ea241e51d62788cfa6f973aa205c7a2ecffbc558bd9b2
MD5 7a1835273efdea44ec5ccc3993d92db8
BLAKE2b-256 dbba7927d16b30231b3fd8812f079afea3690341ddb0291b52f6874d5f949479

See more details on using hashes here.

File details

Details for the file bleachrepo-0.0.24-py2-none-any.whl.

File metadata

  • Download URL: bleachrepo-0.0.24-py2-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.7.2

File hashes

Hashes for bleachrepo-0.0.24-py2-none-any.whl
Algorithm Hash digest
SHA256 86476fd554199cf825869dcca3146ca9e332fe7c068da3ed6273a5fd268c9800
MD5 9d188c071c1fd1aedde08e91c59adb9c
BLAKE2b-256 d6f89b80a60c8ef1f07e66f5c7f992fc649a04f6f48eb5e79f9dc3f55994dd73

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page