| Name | ndpath JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A command-line tool for managing and editing the PATH environment variables |
| upload_time | 2024-04-02 20:37:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
paths
pathos
enviroment
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/MohamedElashri/ndpath/actions/workflows/tests.yml)
# ndpath
ndpath is a command-line tool for managing and editing the PATH environment variables. It provides an interactive interface to view, add, remove, and reorder directories in your PATH.
## Introduction
ndpath is a Python port of the [pathos](https://github.com/chip/pathos) tool, which is written in Go. As the maintainer of ndpath, my motivation for creating this port is that I don't have sufficient knowledge of Go to contribute to the upstream development of pathos. Therefore, ndpath is intended to be a hard fork rather than a soft fork, allowing for independent development and maintenance.
## Installation
To install ndpath, you need to have Python installed on your system. You can install ndpath using pip:
```bash
pip install ndpath
```
## Usage
To use ndpath, simply run the following command in your terminal:
```
ndpath
```
This will launch the interactive interface of ndpath that will allow you to view, add, remove, and reorder paths in your PATH. You should also source the `.pathos.env` file in your shell configuration file (e.g., `.bashrc`, `.zshrc`, etc.) to load the modified PATH into your shell environment.
```bash
source ~/.pathos.env
```
## Features
ndpath provides the following features:
- View the current list of directories in your `PATH`
- Add new directories to your `PATH`
- Remove directories from your PATH
- Reorder directories in your PATH
- Save changes to your PATH permanently
## Keyboard Shortcuts
ndpath supports the following keyboard shortcuts:
- `q` - Quit the program (you will be prompted to save changes)
- `k` or `↑` - Move the selection cursor up
- `j` or `↓` - Move the selection cursor down
- `o` - Insert a new directory below the selected directory
- `O` - Insert a new directory above the selected directory
- `x` - Delete the selected directory
- `X` - Delete all non-existent directories from your PATH
- `D` - Deduplicate the list of directories in your PATH
- `S` - Manually save changes to your PATH
## Configuration
ndpath stores the modified PATH in a file named `.ndpath.env` in your home directory.
This file is loaded by ndpath on startup and is updated whenever you save changes to your PATH.
## Contributing
Contributions to ndpath are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
## License
ndpath is released under the MIT License. See the [LICENSE](LICENSE) file for more information.
## Acknowledgements
ndpath is inspired by and based on the [pathos](https://github.com/chip/pathos) tool. Special thanks to the creators and contributors of pathos for their work.
Raw data
{
"_id": null,
"home_page": null,
"name": "ndpath",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "paths, pathos, enviroment",
"author": null,
"author_email": "Mohamed Elashri <ndpath@elashri.com>",
"download_url": "https://files.pythonhosted.org/packages/57/33/a7b78bb2ced82facad17f41e08d56caa18d38fdaf44db828defa9a5132ac/ndpath-0.0.1.tar.gz",
"platform": null,
"description": "[](https://github.com/MohamedElashri/ndpath/actions/workflows/tests.yml)\n\n# ndpath\n\nndpath is a command-line tool for managing and editing the PATH environment variables. It provides an interactive interface to view, add, remove, and reorder directories in your PATH.\n\n## Introduction\n\nndpath is a Python port of the [pathos](https://github.com/chip/pathos) tool, which is written in Go. As the maintainer of ndpath, my motivation for creating this port is that I don't have sufficient knowledge of Go to contribute to the upstream development of pathos. Therefore, ndpath is intended to be a hard fork rather than a soft fork, allowing for independent development and maintenance.\n\n## Installation\n\nTo install ndpath, you need to have Python installed on your system. You can install ndpath using pip:\n\n```bash\npip install ndpath\n```\n\n## Usage\n\nTo use ndpath, simply run the following command in your terminal:\n\n\n```\nndpath\n```\n\nThis will launch the interactive interface of ndpath that will allow you to view, add, remove, and reorder paths in your PATH. You should also source the `.pathos.env` file in your shell configuration file (e.g., `.bashrc`, `.zshrc`, etc.) to load the modified PATH into your shell environment.\n\n```bash\nsource ~/.pathos.env\n```\n\n## Features\n\nndpath provides the following features:\n\n- View the current list of directories in your `PATH`\n- Add new directories to your `PATH`\n- Remove directories from your PATH\n- Reorder directories in your PATH\n- Save changes to your PATH permanently\n\n## Keyboard Shortcuts\n\nndpath supports the following keyboard shortcuts:\n\n- `q` - Quit the program (you will be prompted to save changes)\n- `k` or `\u2191` - Move the selection cursor up\n- `j` or `\u2193` - Move the selection cursor down\n- `o` - Insert a new directory below the selected directory\n- `O` - Insert a new directory above the selected directory\n- `x` - Delete the selected directory\n- `X` - Delete all non-existent directories from your PATH\n- `D` - Deduplicate the list of directories in your PATH\n- `S` - Manually save changes to your PATH\n\n## Configuration\n\nndpath stores the modified PATH in a file named `.ndpath.env` in your home directory.\n This file is loaded by ndpath on startup and is updated whenever you save changes to your PATH.\n\n## Contributing\n\nContributions to ndpath are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.\n\n## License\n\nndpath is released under the MIT License. See the [LICENSE](LICENSE) file for more information.\n\n## Acknowledgements\n\nndpath is inspired by and based on the [pathos](https://github.com/chip/pathos) tool. Special thanks to the creators and contributors of pathos for their work.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool for managing and editing the PATH environment variables",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/MohamedElashri/ndpath/issues",
"Homepage": "https://github.com/MohamedElashri/ndpath"
},
"split_keywords": [
"paths",
" pathos",
" enviroment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a8fe3195330c765a14ed92eaf389caa71a9911b8f559eae5df9de285cabf893",
"md5": "8205cf7b5e54745c3cc0b67f0e1136a3",
"sha256": "2a5c4b03159b3cbbe724e98edc410f89ea2a1d26f6ee2af90d2b3e3d2c5259be"
},
"downloads": -1,
"filename": "ndpath-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8205cf7b5e54745c3cc0b67f0e1136a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5323,
"upload_time": "2024-04-02T20:37:37",
"upload_time_iso_8601": "2024-04-02T20:37:37.459927Z",
"url": "https://files.pythonhosted.org/packages/4a/8f/e3195330c765a14ed92eaf389caa71a9911b8f559eae5df9de285cabf893/ndpath-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5733a7b78bb2ced82facad17f41e08d56caa18d38fdaf44db828defa9a5132ac",
"md5": "9e6bedfbd5cd4e958e4b8d246455051f",
"sha256": "cb82cbce9c11acd296ce72230b91694edc7599facdecef742e813017835c6943"
},
"downloads": -1,
"filename": "ndpath-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9e6bedfbd5cd4e958e4b8d246455051f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6138,
"upload_time": "2024-04-02T20:37:39",
"upload_time_iso_8601": "2024-04-02T20:37:39.417362Z",
"url": "https://files.pythonhosted.org/packages/57/33/a7b78bb2ced82facad17f41e08d56caa18d38fdaf44db828defa9a5132ac/ndpath-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 20:37:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MohamedElashri",
"github_project": "ndpath",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ndpath"
}
