Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Illustrate usage as a pre-commit hook additional dependency #484

Open
Bilbottom opened this issue Sep 24, 2023 · 0 comments
Open

Illustrate usage as a pre-commit hook additional dependency #484

Bilbottom opened this issue Sep 24, 2023 · 0 comments

Comments

@Bilbottom
Copy link

Summary (documentation)

This is an extremely helpful tool that can be used in loads of contexts!

One context that I've been using it in is as an additional dependency for pre-commit hooks where the hook(s) require environment variables to be defined.

Since pre-commit is a popular tool and setting environment variables for it isn't super obvious (hence lots of the feature requests, such as pre-commit#758), python-dotenv can help with a lot of the headache for Python-based hooks.

I don't expect this to be implemented since it still leaves a fair bit for the user to figure out (and it might be an inappropriate coupling), but on the off chance that this might be useful for other people, I'll add additional details below.

Details

Assuming that this is an appropriate way to use pre-commit and python-dotenv together, it would be awesome to see this documented in the Other Use Cases section of the README.md.

Note that this would not require any source code changes: python-dotenv would just be a dependency for other, already established hooks.

A minimal template for using python-dotenv in this way is:

# .pre-commit-config.yaml
---
repos:
  - repo: ...
    rev: ...
    hooks:
      - id: ...
        entry: dotenv run -- ...
        additional_dependencies: ["python-dotenv[cli]"]

This expects that:

  • The hook action that the user wants to expose environment variables to is configured with language: python
  • The user configuring their pre-commit file has replaced the ellipses ... with actual values (which assumes they know how to override the entry property)
@Bilbottom Bilbottom changed the title Illustrate usage as a pre-commit hook Illustrate usage as a pre-commit hook additional dependency Sep 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant