people used to make stable and durable bronze ancient bells as instruments and alarms in the early days.
We build bronze in this repo as:
- A library that talks to Slack API, Google Docs/Sheets API in a high-level and friendly way.
- A deployable and automated alarm service that sends reminders to Slack based on interpretable data files and Google Docs.
Note: we started this project primaryly for HCA DCP deployment and notification automation purposes.
The bronze code base is complying with the PEP-8 and using Black to format our code, in order to avoid "nitpicky" comments during the code review process so we spend more time discussing about the logic, not code styles.
In order to enable the auto-formatting in the development process, you have to spend a few seconds setting up the pre-commit the first time you clone the repo. It's highly recommended that you install the packages within a virtualenv.
- Install
pre-commitby running:pip install pre-commit(or simply runpip install -r requirements.txt). - Run
pre-commit installto install the git hook.
Once you successfully install the pre-commit hook to this repo, the Black linter/formatter will be automatically triggered and run on this repo. Please make sure you followed the above steps, otherwise your commits might fail at the linting test!
If you really want to manually trigger the linters and formatters on your code, make sure Black and flake8 are installed in your Python environment and run flake8 DIR1 DIR2 and black DIR1 DIR2 --skip-string-normalization respectively.
Coming soon...