Changes

= Overview : du Improved =Programs such as screenfetch and top are used to generate <code>du</code> is a summary of tool for inspecting directories. It will return the computer's current state. These types contents of programs a directory along with how much drive space they are useful because they present a lot of information quicklyusing. However, and it can be parse its output quickly suggest a possible avenue of investigation for the systems administrator.For this assignment you will create , as it usually returns file sizes as a "System Information" type program. This program will briefly present important information about the state number of the computer system.bytes:

The preliminary code should look like this:<code><preb>Hostname: NeoMexKernel Release: 5.4.0user@host ~ $ du --48max-genericUptime: up depth 1 week, 1 day, 17 hours, 14 minutes/usr/local/lib</b></code>----------------------------------------<pre>164028 /usr/dev [ ] 0 %local/lib/heroku11072 / [============= ] 65 %usr/local/lib/python2.792608 /usr/local/bootlib/efi [==== ] 18 %node_modules8 /usr/home [=============== ] 77 %local/lib/python3.8----------------------------------------Mem [======== ] 40 %Swap [= ] 3 %267720 /usr/local/lib</pre>You will therefore be creating a tool called <b>duim (du improved></b>. Your script will call du and return the contents of a specified directory, and generate a bar graph for each subdirectory. The bar graph will represent the drive space as percent of the total drive space for the specified directory.An example of the finished code>your script might produce is this:

In addition<code><b>user@host ~ $ ./duim.py /usr/local/lib</b></code><pre> 61 % [============ ] 160.2 MiB /usr/local/lib/heroku 4 % [= ] 10.8 MiB /usr/local/lib/python2.7 34 % [======= ] 90.4 MiB /usr/local/lib/node_modules 0 % [ ] 8.0 kiB /usr/local/lib/python3.8Total: 261.4 MiB /usr/local/lib</pre> The details of the final output will be up to you, but you will be expected required to build fulfill some specific requirements before completing your script. Read on this capability with some relevant functions. ..

You will need to complete the functions inside the provided file called <code>assignment1duim.py</code>. The provided <code>checkA1.py</code> will be used to test these functions.

* <code>call_dfcall_du_sub()</code> should take no arguments the target directory as an argument and return a list of strings returned by the shell command<b>du -d 1<target directory></b>.** Use subprocess.Popen. ** '-d 1' specifies a <i>max depth</i> of 1. Your list shouldn't include files, just a list of subdirectories in the target directory.** Your list should <u>not</u> contain newline characters. * <code>call_freepercent_to_graph()</code> should take no two arguments, : percent and the total chars. It should return a list of strings from the shell'bar graph' as a string.* * Your function should check that the percent argument is a valid number between 0 and 100. It should fail if it isn't. You can <code>call_hostname()raise ValueError</code> and in this case.** <b>total chars</b> refers to the total number of characters that the bar graph will be composed of. You can use equal signs <code>call_uptime()=</code> should take no argumentsor any other character that makes sense, but the empty space <b>must be composed of spaces</b>, and should return strings from at least until you have passed the shellfirst milestone.* * The string returned by this function should only be composed of these two characters. For example, calling <code>percent_to_graph(percent50, 10)</code> will take an integer should return: 'percent===== ' and return * <code>create_dir_dict</code> should take a bar graph that represents this percentage. The bar graph should begin with '['list as the argument, and end with ']'. Then contents inside should be 20 characters longreturn a dictionary.* * The list can be the list returned by <code>print_percent_linecall_du_sub(name, percent)</code> is provided . ** The dictionary that you return should have the full directory name as a convenience for you. It will print a properly formatted line<i>key</i>, such and the number of bytes in the directory as the one in <i>value</i>. This value should be an integer. For example, using the example aboveof <b>/usr/local/lib</b>, the function would return: {'/usr/local/lib/heroku': 164028, '/usr/local/lib/python2.7': 11072, ...}

Your code will need to have some additional functions that will accomplish the following: * The output from <code>call_df()</code> should be filtered to omit any lines that contain <b>loop</b> or <b>tmpfs</b>. These are not proper file systems and should not be displayed.* The output from <code>call_free()</code> should be used to calculate a percent of <b>memory used</b> divided by <b>total memory</b>. * The output from uptime should be in "pretty" format, that is, in weeks, days, and so on. You may create this as a Python functionany other functions that you think appropriate, or especially when you may also want begin to explore another way to do thisbuild additional functionality. Part of your evaluation will be on how "re-usable" your functions are, and sensible use of arguments and return values.

You will be graded partly on the quality of your Github commits. You may make as many commits as you wish, it will have no impact on your grade. The only exception to this is <b>assignments with very few commits.</b> These will receive low marks for GitHub use and may be flagged for possible academic integrity violations. <b><font color='blue'>Assignments that do not adhere to these requirements may not be accepted.</font></b>

* the code <i>should hopefully</i> run without errors after each commit, and

These guidelines are not always possible, but you will be expected to follow these guidelines as much as possible. Break your problem into smaller pieces, and work iteratively to solve each small problem. Test your code after each small change you make, and address errors as soon as they arise. It will make your life easier!  == Additional Features == After completing the above, you are expected to add some additional (two or more) functions providing useful information. Some programs you might want to look at are: * [https://https://ostechnix.com/neofetch-display-linux-systems-information/ screenfetch/neofetch]* [https://htop.dev/ top/htop/Bashtop] It is expected that the additional features you provided should be useful, non-trivial, they should not require super-user privileges and should not require the installation of additional modules or packages.<b>In this part of the assignment, it is better to try for something useful and fail than it is to implement something trivial! I am looking for evidence that you have worked with Linux machines and know what kinds of information are useful to see at a glance.</b> You might consider:* Network information/IP addresses* The state of some important daemons/systemd services* process information* information about online users* number of packages installed* cpu load You may even choose to make the output more attractive/colourful etc. If so, you <i>are permitted to use more modules</i> than those specified above, but make sure that the required functions still succeed as they are. You may want to look into default arguments, ask me for clarification if you're interested.

= Submission Guidelines and Process =  == Clone Your Repo (ASAP) ==

== The First Milestone (due October 19February 14) ==For the first milestone you will have two functions to complete.* <code>call_du_sub</code> will take one argument and return a list. The argument is a target directory. The function will use <code>subprocess.Popen</code> to run the command <b>du -d l <target_directory></b>. * Before you begin programming<code>percent_to_graph</code> will take two arguments and return a string. In order to complete <code>percent_to_graph()</code>, it is important 's helpful to know the equation for converting a number from one scale to plan your algorithmanother. [[File:Scaling-formula. Therefore png]] In this equation, ``x`` refers to your first task input value percent and ``y`` will be refer to the number of symbols to complete print. The max of percent is 100 and submit the min of percent is 0.Be sure that you are rounding to an algorithm documentinteger, and then print that number of symbols to represent the percentage. This document should The number of spaces that you print will be named '''algorithmthe inverse.txt'''. This file should be plaintext and located in  Test your GitHub repositoryfunctions with the Python interpreter. The document will contain two sectionsUse <code>python3</code>, then: * A description of how you plan to implement the " import duim duim.percent_to_graph(50, 10)" function To test with the check script, run the following: <code>python3 checkA1. This explanation should be linepy -byf -linev TestPercent</code> == Second Milestone (due February 21) ==For the second milestone you will have one more function to complete. You * <code>create_dir_dict</code> will be graded based on take your list from <code>call_du_sub</code> and return a dictionary. ** Every item in your list should create a key in your attention to detaildictionary. * A description * Your dictionary values should be a number of how you plan to implement bytes. For example: <code>{'/usr/lib/local': 33400}</code> ** Again, test using your Python interpreter or the required output overallcheck script. Consider  To run the check script, enter the input following: <code>python checkA1.py -f -v TestDirDict</code> == Minimum Viable Product == Once you are working withhave achieved the Milestones, and consider you will have to do the output following to get a minimum viable product:* In your <code>if __name__ == '__main__'</code> block, you need will have to presentcheck command line arguments. Break ** If the user has entered no command line argument, use the current directory.** If the problem down into smaller problemsuser has entered more than one argument, or their argument isn't a valid directory, and consider any issues you might encounterprint an error message. You ** Otherwise, the argument will be graded on evidence your target directory.* Call <code>call_du_sub</code> with the target directory.* Pass the return value from that you have considered function to <code>create_dir_dict</code>* You may wish to create one or more functions to do the following:** Use the task, but not on "getting it right total size of the first timetarget directory to calculate percentage." * A brief description * For each subdirectory of the additional features target directory, you'd like will need to implementcalculate a percentage, using the total of the target directory. ** Once you have completed this file've calculated percentage, add it to your GitHub repository. Use call <code>git add algorithm.txtpercent_to_graph</code>with a max_size of your choice. ** For every subdirectory, then print <codei>git commit -m "added algorithm.txt"at least</codei> the percent, the bar graph, and the name of the subdirectory.** The target directory <codeb>git pushshould not</codeb>have a bar graph. == Additional Features == After completing the above, you are expected to add some additional features. Some improvements you could make are: * Format the output in a way that is easy to read.* Add colour to the output.* Add more error checking, print a usage message to the user.* Convert bytes to a human-readable format. NOTE: This doesn't have to be 100% accurate to get marks.* Accept more options from the user.* Sort the output by percentage, or by filename.

== The Assignment (due November 2It is expected that the additional features you provided should be useful, 11:59pm) ==* As stated beforenon-trivial, your code will be inside they should not require super-user privileges and should not require the file "assignment1.py". Begin by completing the required functions, committing your changes as you go. Complete and test each function before moving installation of additional packages to the nextwork. * When you (ie: I shouldn't have completed the task, to run pip to make sure that all your changes have been committed and pushed to GitHub. <b>In addition, you will submit <code>assignment1.py</code> to Blackboardassignment work).</b>

== The Debrief Assignment (due November 12March 7, 11:59pm) ==This part of * Be sure to make your final commit before the assignment will be completed under GitHub's "Issues" tabdeadline. * Your professor will examine the code and post questions under "Issues". Answer Then, copy the questions for full credit contents of your work<b>duim.* Create new issues py</b> file into a Word document, and submit it to Blackboard. <i>I will use GitHub to answer the following questions: * Is evaluate your code portabledeadline, ie. have you tested on other Linux machines? How can we make programs portable? * Why did you choose the additional features but submitting to Blackboard tells me that you did? * What challenges did you encounter during the assignment, and what resources did you use wish to solve your issues? (help from classmates, help from Stackoverflow, debuggers, etcbe evaluated.)</i>

| Check script passed required functions design || 30 5 ||

| today() function design required functions readability || 2 5 ||

| before() function main loop design || 5 10 ||

| dbda() function design main loop readability || 10 ||

| script level docstring output function design || 5 ||

| leap_year() output function design readability || 2 5 ||

| valid_date() function design additional features implemented || 5 20 ||

| usage() function design docstrings and comments || 1 5 ||

| First Milestone ||10||

| Reflection Essay Second Milestone || 10 ||

| github.com repository: Commit messages and use ||1510 ||

* [ ] your algorithm document, named as 'algorithm.txt', in your GitHub repo, by October 19.* [ ] your python script, named as 'assignment1duim.py', in your repository, and also '''submitted to Blackboard''', by November 2 March 7 at 11:59pm.* [ ] your debrief answers should be submitted as issues to GitHub by November 12.