theskumar / theskumar/python-dotenv
Illustrate usage as a pre-commit hook additional dependency
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.9k
- Forks
- 581
- PR merge metrics
- No merged PRs in 30d
Description
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 theentryproperty)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open README.md and find the Other Use Cases section. Review the pre-commit additional_dependencies and Python hook behavior described in the issue, then add the provided usage example if it fits the project documentation. Done means the README clearly explains this pre-commit configuration without any source-code changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100