Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Illustrate usage as a pre-commit hook additional dependency

Aberta
  • Algo errado?
#484 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

@HaloJun já está trabalhando nisso.

Desde 10/10/2026.

  • #729 de @HaloJun — aberto

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
50/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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)
Linguagem predominante
Python
Estrelas
8.9k
Forks
600
Merge médio
4d 23h
PRs com merge (30d)
4

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de theskumar/python-dotenv

Todas as issues de theskumar/python-dotenv

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.