Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hussein-m-kandil/pathvar

My final project for CS50p, a command line utility for interacting and manipulating the system's PATH environment variable (Linux BASH only)
https://github.com/hussein-m-kandil/pathvar

bash bash-script command-line command-line-tool environment-variables environment-variables-validation linux linux-app linux-shell path pyth python3 shell shell-script shell-scripting unix unix-shell

Last synced: 16 days ago
JSON representation

My final project for CS50p, a command line utility for interacting and manipulating the system's PATH environment variable (Linux BASH only)

Awesome Lists containing this project

README 

        
# pathvar



### Video Demo: https://youtu.be/THzJUZlqiI0x



### Description:



My final project for **CS50P**: "_CS50 Introduction to Programming with Python_".



![Screenshot of the help output.](./assets/images/pathvar_screen.png)



This tool meant to facilitate the interaction with the system PATH environment variable (Linux BASH shell only).



- To get the work done correctly do the following:

  - Read the 'help' instruction well

  - Be careful about the paths you input (with some options)

  - Separate between multiple paths with a single colon ':'



NOTE: This program saves the new modified PATH value in '~/.bash_profile' file,

and if this file not exists creates a new one,

and eventually source the '~/.bashrc' and '~/.profile' if any of them exists.



---



### Usage:



    project.py [-h] [-s] [-e] [-a] [-p] [-d] [-q] [--remove-all-paths] [-v]



### Options:



- **_-h, --help_**

  - show this help message and exit

- **_-s, --show_**

  - shows the current value of the 'PATH' (default)

- **_-e, --eliminate-duplicates_**

  - eliminates any duplicates in the value of the 'PATH' (Included with any modifications)

- **_-a , --append_**

  - appends any number of paths to the current value of the 'PATH' (which are must be given as a

    single string separated with ':' between every two paths and without any spaces)

- **_-p , --push_**

  - pushes any number of paths at the beginning of the current value of 'PATH' (which are must be

    given as a single string separated with ':' between every two paths and without any spaces)

- **_-d , --delete_**

  - deletes from 'PATH' any number of paths (which are must be given as a single string separated

    with ':' between every two paths and without any spaces)

- **_-q , --query_**

  - checks whether the given path is in the current 'PATH'

- **_--remove-all-paths_**

  - removes all paths in the current 'PATH' (NOT RECOMMENDED)

- **_-v, --version_**

  - show program version number and exit



---



### Code design:



_The entire program is designed using the Functional Programming Paradigm and all application logic included in one file: 'project.py'._



### Code documentation:



#### Contents:



- [pathvar.project module](#pathvarproject-module)



  - [`add_args()`](#pathvarprojectadd_argsparser_obj-argumentparser)



  - [`get_path()`](#pathvarprojectget_path)



  - [`is_there_path()`](#pathvarprojectis_there_pathcurrent_path-str-given_path-str)



  - [`main()`](#pathvarprojectmain)



  - [`parse_args_and_modify_path_str()`](#pathvarprojectparse_args_and_modify_path_strparser_obj-argumentparser-current_path-str)



  - [`path_duplicates_eliminator()`](#pathvarprojectpath_duplicates_eliminators-str)



  - [`path_remover()`](#pathvarprojectpath_removercurrent_path-str-given_paths-str)



  - [`print_msg()`](#pathvarprojectprint_msgtitle-str-msg-str)



  - [`run_command_verbosely()`](#pathvarprojectrun_command_verboselycmd-str)



  - [`update_path()`](#pathvarprojectupdate_pathnew_path_value-str)



### pathvar.project module



#### pathvar.project.add_args(parser_obj: ArgumentParser)



_Adding CL arguments to and ArgumentParser object_



_Manipulate the inputted ArgumentParser object

by adding the needed command line arguments to it

with all the specifications for each of the arguments

(i.e. argument name, action, help, …)._



- **Parameters**



  **parser_obj** (_argparse.ArgumentParser_) – parser object for parsing the command line arguments



- **Returns**



  None



- **Return type**



  None



#### pathvar.project.get_path()



_A simple function to get the current PATH_



_Get the current PATH environment variable

using the command meant for that

depending on the kind of the operating system that pathvar running on._



- **Returns**



  The value of the PATH variable



- **Return type**



  str



#### pathvar.project.is_there_path(current_path: str, given_path: str)



_Check whether the ‘given_path’ is in ‘current_path’_



_Return True if the ‘given_path’ is in ‘current_path’

Otherwise, return false._



- **Parameters**



  - **current_path** (_str_) – The value inside the PATH environment variable



  - **given_paths** (_str_) – The paths that the user want it to be deleted



- **Returns**



  True/False, based on whether the ‘given_path’ is in ‘current_path’



- **Return type**



  bool



#### pathvar.project.main()



_pathvar main function_



_The Logic of the entire ‘pathvar’ program._



- **Returns**



  Nothing, just execute the logic of the entire program.



- **Return type**



  None



#### pathvar.project.parse_args_and_modify_path_str(parser_obj: ArgumentParser, current_path: str)



_Parsing the command line arguments_



_Using ‘argparse’ library this function will consume an ‘ArgumentParser’ object

in order to parse the arguments and handle the chosen option/s._



- **Parameters**



  **parser_obj** (_argparse.ArgumentParser_) – parser object for parsing the command line arguments



- **Returns**



  None



- **Return type**



  None



#### pathvar.project.path_duplicates_eliminator(s: str)



_Remove any duplicates in a PATH variable_



_This function removes any duplicated paths from a PATH variable.

It looks for duplicated paths._



- **Parameters**



  **s** (_str_) – The value of the PATH environment variable



- **Returns**



  The same input of the PATH value without any duplicates



- **Return type**



  str



#### pathvar.project.path_remover(current_path: str, given_paths: str)



_Delete the given path/s from the current PATH_



_return copy of the ‘current_path’

without and value included in the ‘given_paths’_



- **Parameters**



  - **current_path** (_str_) – The value inside the PATH environment variable



  - **given_paths** (_str_) – The paths that the user want it to be deleted



- **Returns**



  A copy from the current path without any given path



- **Return type**



  str



#### pathvar.project.print_msg(title: str, msg: str)



_Print message to the user_



_This function will print a message to the user

in form of message title and message body_



- **Parameters**



  - **title** (_str_) – The title of the message



  - **msg** (_str_) – The body of the message



- **Returns**



  Nothing, just the print side effect



- **Return type**



  None



#### pathvar.project.run_command_verbosely(cmd: str)



_Run a given command in subprocess_



_Run the given command in subprocess

and print and ‘stdout’ or ‘stderr’_



- **Parameters**



  **cmd** (_str_) – Command to run



#### pathvar.project.update_path(new_path_value: str)



_Run a command to update the PATH variable_



_Run the needed commands for updating the PATH environment variable

based on the current operating system and print any ‘stdout’ or ‘stderr’_



- **Parameters**



  **new_path_value** (_str_) – The new value in order to set the PATH variable to it



---



### License:



Copyright (c) 2023 Hussein Mahmoud Kandil - MIT