Cross-platform tool for adding locations to the user PATH, no elevated privileges required!
Project description
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
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)
TrueLicense
userpath is distributed under the terms of both
at your option.
History
Important changes are emphasized.
1.6.0
Use locale’s encoding when handling output from subprocesses
1.5.0
Modify bash start-up files based on their existence
Remove distro dependency
1.4.2
Fix fallback mechanism for detecting the name of the parent process
1.4.1
Fix PATH registry key type on Windows
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file userpath-1.6.0.tar.gz.
File metadata
- Download URL: userpath-1.6.0.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b2b9a5ca1478ecfa63514b48709d650f48bf7be89f62bd236db556b85b6deff6 |
|
| MD5 | e6b34f11b31fc24d79c7f0296075a607 |
|
| BLAKE2b-256 | 54ff48ddc6562a06c38db208ba347512af3d366232333d30a91538f14335a8b9 |
File details
Details for the file userpath-1.6.0-py2.py3-none-any.whl.
File metadata
- Download URL: userpath-1.6.0-py2.py3-none-any.whl
- Upload date:
- Size: 14.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43569129eeecec6c567bcbd47120c161a43344712417de013b754191961426db |
|
| MD5 | 5358ae7224e4991f6c1080e919e514cc |
|
| BLAKE2b-256 | 36ba311896660f318a46e586a170a6eb487ce15ffeb2c2af666af6d2aa4be255 |
