Skip to main content

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.

For the rest of our developer docs, please see .

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

cr_pre_commit_hooks-0.1.1.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

cr_pre_commit_hooks-0.1.1-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

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