Skip to main content

A lightweight Python library to persistently add or remove directories from PATH.

Project description

pathreg

Persistently add or remove directories from PATH on Windows, Linux, and macOS.

Installation

pip install pathreg

CLI Usage

pathreg add /some/directory
pathreg remove /some/directory

Python API

from pathreg import add_path, remove_path

add_path("/some/directory")     # idempotent — skips if already present
remove_path("/some/directory")  # no-op if not found

Both functions modify the shell profile and the current process's PATH immediately.

Behavior

  • Paths are normalized: trailing separators stripped, slashes converted per platform.
  • add_path is idempotent — does nothing if the entry already exists.
  • remove_path is a no-op if the entry is absent or the profile file does not exist.

Platform support

Platform Persistence target
Windows HKCU\Environment via winreg; broadcasts WM_SETTINGCHANGE to notify the shell
bash ~/.bash_profile (falls back to ~/.profile if it exists)
zsh ~/.zshenv
sh ~/.profile

The active shell is detected from the SHELL environment variable.

No third-party dependencies required.

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

pathreg-1.0.0.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

pathreg-1.0.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file pathreg-1.0.0.tar.gz.

File metadata

  • Download URL: pathreg-1.0.0.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pathreg-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f949513c4531230b6950585487e86f0c420aee664fec466042038abd40b242d1
MD5 6fcb161bae79a71401f0836cc75e8b4e
BLAKE2b-256 a595e949616b635531e1883cdb91952a5a0c75e748838d7f3dedeba3e481eb28

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathreg-1.0.0.tar.gz:

Publisher: publish.yml on tn3w/pathreg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pathreg-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pathreg-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pathreg-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 619c0350c5a1430fdc41eaac86fcfe49e3b409fcc0f75e607a7ee0b3aca0983d
MD5 912d6e499d270e94dcc331a56bef306b
BLAKE2b-256 fa98fdb205bba76e609d01dd20a0ace35ce785f449add54edf637fad610bdf9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathreg-1.0.0-py3-none-any.whl:

Publisher: publish.yml on tn3w/pathreg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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