| Name | userpath JSON |
| Version |
1.9.2
JSON |
| download |
| home_page | |
| Summary | Cross-platform tool for adding locations to the user PATH |
| upload_time | 2024-02-29 21:39:08 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
path
user path
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# userpath
| | |
| --- | --- |
| CI/CD | [](https://github.com/ofek/userpath/actions/workflows/test.yml) [](https://github.com/ofek/userpath/actions/workflows/build.yml) |
| Package | [](https://pypi.org/project/userpath/) [](https://pypi.org/project/userpath/) |
| Meta | [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |
-----
This is a tool for modifying a user's `PATH`.
**Table of Contents**
- [Installation](#installation)
- [CLI](#cli)
- [API](#api)
- [License](#license)
## Installation
```console
pip install userpath
```
## CLI
```console
$ 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
```pycon
>>> 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](https://spdx.org/licenses/MIT.html) license.
Raw data
{
"_id": null,
"home_page": "",
"name": "userpath",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "path,user path",
"author": "",
"author_email": "Ofek Lev <oss@ofek.dev>",
"download_url": "https://files.pythonhosted.org/packages/d5/b7/30753098208505d7ff9be5b3a32112fb8a4cb3ddfccbbb7ba9973f2e29ff/userpath-1.9.2.tar.gz",
"platform": null,
"description": "# userpath\n\n| | |\n| --- | --- |\n| CI/CD | [](https://github.com/ofek/userpath/actions/workflows/test.yml) [](https://github.com/ofek/userpath/actions/workflows/build.yml) |\n| Package | [](https://pypi.org/project/userpath/) [](https://pypi.org/project/userpath/) |\n| Meta | [](https://spdx.org/licenses/) [](https://github.com/sponsors/ofek) |\n\n-----\n\nThis is a tool for modifying a user's `PATH`.\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [CLI](#cli)\n- [API](#api)\n- [License](#license)\n\n## Installation\n\n```console\npip install userpath\n```\n\n## CLI\n\n```console\n$ userpath -h\nUsage: userpath [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n append Appends to the user PATH\n prepend Prepends to the user PATH\n verify Checks if locations are in the user PATH\n```\n\n## API\n\n```pycon\n>>> import userpath\n>>> location = r'C:\\Users\\Ofek\\Desktop\\test'\n>>>\n>>> userpath.in_current_path(location)\nFalse\n>>> userpath.in_new_path(location)\nFalse\n>>> userpath.append(location)\nTrue\n>>> userpath.in_new_path(location)\nTrue\n>>> userpath.need_shell_restart(location)\nTrue\n```\n\n## License\n\n`userpath` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": "",
"summary": "Cross-platform tool for adding locations to the user PATH",
"version": "1.9.2",
"project_urls": {
"Funding": "https://github.com/sponsors/ofek",
"History": "https://github.com/ofek/userpath/blob/master/HISTORY.rst",
"Issues": "https://github.com/ofek/userpath/issues",
"Source": "https://github.com/ofek/userpath"
},
"split_keywords": [
"path",
"user path"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43993ec6335ded5b88c2f7ed25c56ffd952546f7ed007ffb1e1539dc3b57015a",
"md5": "788d5d6f5c5d0edeaa79ba12311ea98f",
"sha256": "2cbf01a23d655a1ff8fc166dfb78da1b641d1ceabf0fe5f970767d380b14e89d"
},
"downloads": -1,
"filename": "userpath-1.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "788d5d6f5c5d0edeaa79ba12311ea98f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9065,
"upload_time": "2024-02-29T21:39:07",
"upload_time_iso_8601": "2024-02-29T21:39:07.551460Z",
"url": "https://files.pythonhosted.org/packages/43/99/3ec6335ded5b88c2f7ed25c56ffd952546f7ed007ffb1e1539dc3b57015a/userpath-1.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5b730753098208505d7ff9be5b3a32112fb8a4cb3ddfccbbb7ba9973f2e29ff",
"md5": "0bcebc971ce7fb38aa3fde3b137d39e2",
"sha256": "6c52288dab069257cc831846d15d48133522455d4677ee69a9781f11dbefd815"
},
"downloads": -1,
"filename": "userpath-1.9.2.tar.gz",
"has_sig": false,
"md5_digest": "0bcebc971ce7fb38aa3fde3b137d39e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11140,
"upload_time": "2024-02-29T21:39:08",
"upload_time_iso_8601": "2024-02-29T21:39:08.742371Z",
"url": "https://files.pythonhosted.org/packages/d5/b7/30753098208505d7ff9be5b3a32112fb8a4cb3ddfccbbb7ba9973f2e29ff/userpath-1.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 21:39:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "ofek",
"github_not_found": true,
"lcname": "userpath"
}
