Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Document adding print-completion-script to venv

Open
#959 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python, shell
Domain
cli

Research direction

Start by reviewing the venv activate script integration point and the existing print-completion-script entry point, using the provided Invoke task as a reference. Clarify which shells and activation paths are supported, then verify that activating a virtual environment makes completion available and that the relevant behavior is covered by tests.

Written by the indexing model from the issue text.

Description

We can also add the print-completion-script to the venv activate script. here an example how to do it with invoke

import os
import pathlib
import sys
import invoke

ROOT_DIR = pathlib.Path(__file__).parent


@invoke.task
def complete(context):
    """Activate the invoke shell completion."""
    shell = pathlib.Path(os.environ.get("SHELL", "")).name
    completion_script = context.run(
        f"invoke --print-completion-script {shell}",
        hide=True,
    ).stdout
    with open(".invoke-completion.sh", "w", encoding="UTF-8") as f:
        f.write(completion_script)
    venv_activate = pathlib.Path(sys.executable).parent / 'activate'
    with open(venv_activate, "a", encoding="UTF-8") as f:
        f.write(f"\n. {ROOT_DIR / '.invoke-completion.sh'}\n")

Dominant language
Python
Stars
4.8k
Forks
412
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyinvoke/invoke

All issues in pyinvoke/invoke

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.