/userpath

Cross-platform tool for adding locations to the user PATH, no elevated privileges required!

Primary LanguagePythonMIT LicenseMIT

userpath
CI/CD CI - Test CD - Build
Package PyPI - Version PyPI - Python Version
Meta License - MIT GitHub Sponsors

This is a tool for modifying a user's PATH.

Table of Contents

Installation

pip install userpath

CLI

$ userpath -h
Usage: userpath [OPTIONS] COMMAND [ARGS]...

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  append   Appends to the user PATH
  prepend  Prepends to the user PATH
  verify   Checks if locations are in the user PATH

API

>>> import userpath
>>> location = r'C:\Users\Ofek\Desktop\test'
>>>
>>> userpath.in_current_path(location)
False
>>> userpath.in_new_path(location)
False
>>> userpath.append(location)
True
>>> userpath.in_new_path(location)
True
>>> userpath.need_shell_restart(location)
True

License

userpath is distributed under the terms of the MIT license.