Skip to main content

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

Project description

CI - Travis CI - AppVeyor Codecov

PyPI - Supported Python versions PyPI - Version PyPI - Downloads

License: MIT/Apache-2.0 Say Thanks

Ever wanted to release a cool new app but found it difficult to add its location to PATH for users? Me too! This tool does that for you on all major operating systems and does not require elevated privileges!

Fear not, this only modifies the user PATH; the system PATH is never touched nor even looked at!

Installation

userpath is distributed on PyPI as a universal wheel and is available on Linux/macOS and Windows and supports Python 2.7/3.6+ and PyPy.

$ pip install userpath

Commands

Only 3!

$ 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
Example run

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 both

at your option.

History

Important changes are emphasized.

1.4.0

  • Fix duplicating system paths on Windows

  • Prevent adding paths multiple times on macOS/Linux

  • Send CLI errors to stderr instead of stdout

1.3.0

  • Only require the dependency distro on Linux

  • Ship tests with source distributions

1.2.0

  • Added support for shell auto-detection and selection

1.1.0

  • First public stable release

View all history

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

userpath-1.4.0.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

userpath-1.4.0-py2.py3-none-any.whl (14.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file userpath-1.4.0.tar.gz.

File metadata

  • Download URL: userpath-1.4.0.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for userpath-1.4.0.tar.gz
Algorithm Hash digest
SHA256 8f555126f137c08c576f73e6a9d7089ee394e9ba00a53a75c37f05439ca3cf51
MD5 38da92718c10d8298546e9f5f7df9180
BLAKE2b-256 093ae8b02ae27ce44a3773a5d7a7fd52c78531ade5c902123694e86a1fa0e909

See more details on using hashes here.

File details

Details for the file userpath-1.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: userpath-1.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for userpath-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 57289412f6333fedf7362766d92aa93ae1a77f2779ab282afa49f8e366d0beab
MD5 d5337553dc0ac5e2587ccc5c67e74db6
BLAKE2b-256 d81ebad15e27cf1190f24d837205aaddfe855ef920bb6ab162e3df3506c51e94

See more details on using hashes here.

Supported by

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