Skip to main content

A CLI tool that helps you quickly navigate to test functions in pytest files.

Project description

TestJump (TJ)

A CLI tool that helps you quickly navigate to test functions in pytest files.

When making fundamental changes to a project, multiple test cases often fail. Instead of manually opening files and searching for each failing test, TestJump allows you to jump directly to the test location 🤷.

Installation

Install this tool using pip:

pip install testjump

Or using pipx:

pipx install testjump

Or using uv:

uv tool install testjump

Usage

  1. Jump to a test function:
tj tests/test_calculator.py::test_addition
  1. Jump to a test class method:
tj tests/test_user.py::TestUser::test_user_creation

Interactive Usage with Multiple Files

You can use it interactively with a file containing multiple jump points:

for line in $(cat jumppoints.txt); do tj $line; echo "Press any key to continue..."; read; done

Output Options

TestJump supports different output formats:

  1. Print location only (useful for scripting):
tj tests/test_calculator.py::test_addition -print
# Output: tests/test_calculator.py:42
  1. JSON output with detailed information:
tj tests/test_calculator.py::test_addition -json
# Output:
# {
#   "status": "ok",
#   "path": "tests/test_calculator.py",
#   "class_name": null,
#   "function_name": "test_addition",
#   "lineno": 11
# }

Configuring Your Editor

TestJump uses VS Code by default, but you can configure your preferred editor by setting the TJ_EDITOR environment variable:

# For VS Code (default)
export TJ_EDITOR=vscode

# For Vim
export TJ_EDITOR=vim

# For IntelliJ IDEA
export TJ_EDITOR=idea

# For PyCharm
export TJ_EDITOR=pycharm

# For Neovim
export TJ_EDITOR=nvim

Add this to your .bashrc or .zshrc to make it permanent.

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

testjump-0.1.5.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

testjump-0.1.5-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file testjump-0.1.5.tar.gz.

File metadata

  • Download URL: testjump-0.1.5.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.8

File hashes

Hashes for testjump-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b2cde77e7ac1aa886cd35187ccb83d9012223263d757bcfea7d7636082944adb
MD5 825b5760cef8e0701201a485437094d8
BLAKE2b-256 8a493290e7591eaf36b96b4505b789b05d3ec70a1bea143a8b5e71829afc6eba

See more details on using hashes here.

File details

Details for the file testjump-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: testjump-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.8

File hashes

Hashes for testjump-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 769514851d67060eb14c7d37c17fa5d2524f822510e4977eb22a3ea6e02002bc
MD5 4e4c31e6b6c77dc26a5d7c0b990095d3
BLAKE2b-256 133af051e3bd1e8a6da497e0cbda9d093255d08d28b183493aabc573af34f0d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page