pre-commit hooks for ensuring consistency across our code base. Included are hooks which are not available elsewhere and also not super useful outside of a CR context.
Project description
Climate Resource pre-commit hooks
pre-commit hooks for ensuring consistency across our code base. Included are hooks which are not available elsewhere and also not super useful outside of a CR context.
Usage
To use the hooks in a project, add to your .pre-commit-config.yaml
:
- repo: https://gitlab.com/climate-resource/cr-pre-commit-hooks
rev: v0.1.0
hooks:
- id: check-docstrings
For developers
For development, we rely on poetry for all our dependency management. To get started, you will need to make sure that poetry is installed (instructions here, we found that pipx and pip worked better to install on a Mac).
For all of work, we use our Makefile
.
You can read the instructions out and run the commands by hand if you wish,
but we generally discourage this because it can be error prone.
In order to create your environment, run make virtual-environment
.
If there are any issues, the messages from the Makefile
should guide you
through. If not, please raise an issue in the issue tracker.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cr_pre_commit_hooks-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bef57ed7146d7b085e6b4f2fde88eab744e143a6d048ff29067821926bf821be |
|
MD5 | ea6cb487923196b3640788b8a27e1ad2 |
|
BLAKE2b-256 | 24e3f047074af300d220a16a2449b325adf32aa431a52c5a2c16e6841ea2811d |
Hashes for cr_pre_commit_hooks-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b39434dacf0d11551ef804b8587f32b4fe3398e53a482aa498dfcd09c2ce1e3d |
|
MD5 | a344c763c760460c0590cf239e415155 |
|
BLAKE2b-256 | 8ffe9337802aa9a99fed699df97461c4263c6c1012ed05dfe64aa868fec6eb38 |