Linux Shell and Bash

Bash Tutorial

A brief overview of Bash, on your way to becoming a Linux expert. When a computer boots up, a kernel (MacOS, Windows, Linux) is started. This kernel provides a shell, or terminal, that allows user to interact with a most basic set of commands. Typically, the casual user will not interact with the shell/terminal as a Desktop User Interface is started by the computer boot up process. To activate a shell directly, users will run a “terminal” through the Desktop. VS Code provides ability to activate "terminal" while in the IDE.

Variable Prerequisites

Setup bash shell dependency variables for this page. Variables are one of the first aspects of programming. Variables have "name" and a "value".

Hack Note: Change variables to match your student project.

Define variable

The following code cell defines 3 variables and assigns each a value. There are some extra command, called a HERE document, that write these variables to a file. This is so we can use these variables over and over below.

%%script bash

# Dependency Variables, set to match your project directories

cat <<EOF > /tmp/variables.sh
export project_dir=$HOME/vscode  # change vscode to different name to test git clone
export project=\$project_dir/teacher  # change teacher to name of project from git clone
export project_repo="https://github.com/nighthawkcoders/teacher.git"  # change to project of choice
EOF

Output the value of a variable

The following code cell outputs the value of the variables, using the echo command. For visual understanding in the output, each echo command provide a title before the $variable

%%script bash

# Extract saved variables
source /tmp/variables.sh

# Output shown title and value variables
echo "Project dir: $project_dir"
echo "Project: $project"
echo "Repo: $project_repo"

Project dir: /Users/tanvipampati/vscode
Project: /Users/tanvipampati/vscode/teacher
Repo: https://github.com/nighthawkcoders/teacher.git

Project Setup and Analysis with Bash Scripts

The bash scripts that follow automate what was done in the setup procedures. The purpose of this is to show that many of the commands we performed can be added to a script, then performed automatically.

Pull Code

Pull code from GitHub to your machine. This is a bash script, a sequence of commands, that will create a project directory and add the “project” from GitHub to the vscode directory. There is conditional logic to make sure that clone only happen if it does not (!) exist. Here are some key elements in this code…

cd command (change directory), remember this from terminal session
if statements (conditional statement, called selection statement by College Board), code inside only happens if condition is met

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Using conditional statement to create a project directory and project"

cd ~    # start in home directory

# Conditional block to make a project directory
if [ ! -d $project_dir ]
then 
    echo "Directory $project_dir does not exists... makinng directory $project_dir"
    mkdir -p $project_dir
fi
echo "Directory $project_dir exists." 

# Conditional block to git clone a project from project_repo
if [ ! -d $project ]
then
    echo "Directory $project does not exists... cloning $project_repo"
    cd $project_dir
    git clone $project_repo
    cd ~
fi
echo "Directory $project exists." 

Using conditional statement to create a project directory and project
Directory /Users/tanvipampati/vscode exists.
Directory /Users/tanvipampati/vscode/teacher exists.

Look at files Github project

All computers contain files and directories. The clone brought more files from cloud to your machine. Review the bash shell script, observe the commands that show and interact with files and directories. These were used during setup.

“ls” lists computer files in Unix and Unix-like operating systems
“cd” offers way to navigate and change working directory
“pwd” print working directory
“echo” used to display line of text/string that are passed as an argument

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"
cd $project
pwd

echo ""
echo "list top level or root of files with project pulled from github"
ls

Navigate to project, then navigate to area wwhere files were cloned
/Users/tanvipampati/vscode/teacher

list top level or root of files with project pulled from github
Gemfile
Gemfile.lock
LICENSE
Makefile
README.md
_config.yml
[34m_data[m[m
[34m_includes[m[m
[34m_layouts[m[m
[34m_notebooks[m[m
[34m_posts[m[m
[34m_site[m[m
[34massets[m[m
csa.md
csp.md
csse.md
[34mimages[m[m
index.md
indexBlogs.md
[34mscripts[m[m

Look at file list with hidden and long attributes

Most linux commands have options to enhance behavior. The enhanced listing below shows permission bits, owner of file, size and date.

ls reference

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"
cd $project
pwd

echo ""
echo "list all files in long format"
ls -al   # all files -a (hidden) in -l long listing

Navigate to project, then navigate to area wwhere files were cloned
/Users/tanvipampati/vscode/teacher

list all files in long format
total 120
drwxr-xr-x  25 tanvipampati  staff   800 Sep  5 13:06 [34m.[m[m
drwxr-xr-x   6 tanvipampati  staff   192 Aug 31 13:32 [34m..[m[m
drwxr-xr-x  14 tanvipampati  staff   448 Sep  5 13:06 [34m.git[m[m
drwxr-xr-x   3 tanvipampati  staff    96 Aug 20 11:48 [34m.github[m[m
-rw-r--r--   1 tanvipampati  staff   176 Aug 31 14:10 .gitignore
-rw-r--r--   1 tanvipampati  staff   122 Aug 20 11:48 Gemfile
-rw-r--r--   1 tanvipampati  staff  7346 Aug 20 12:17 Gemfile.lock
-rw-r--r--   1 tanvipampati  staff  1081 Aug 20 11:48 LICENSE
-rw-r--r--   1 tanvipampati  staff  3136 Sep  5 13:06 Makefile
-rw-r--r--   1 tanvipampati  staff  6853 Aug 31 14:10 README.md
-rw-r--r--   1 tanvipampati  staff   607 Aug 20 11:48 _config.yml
drwxr-xr-x   6 tanvipampati  staff   192 Aug 20 11:48 [34m_data[m[m
drwxr-xr-x  11 tanvipampati  staff   352 Aug 31 14:10 [34m_includes[m[m
drwxr-xr-x   6 tanvipampati  staff   192 Aug 20 11:48 [34m_layouts[m[m
drwxr-xr-x  51 tanvipampati  staff  1632 Sep  5 13:06 [34m_notebooks[m[m
drwxr-xr-x  49 tanvipampati  staff  1568 Sep  5 13:06 [34m_posts[m[m
drwxr-xr-x  31 tanvipampati  staff   992 Aug 22 13:21 [34m_site[m[m
drwxr-xr-x   4 tanvipampati  staff   128 Aug 20 11:48 [34massets[m[m
-rw-r--r--   1 tanvipampati  staff    92 Aug 20 11:48 csa.md
-rw-r--r--   1 tanvipampati  staff    98 Aug 20 11:48 csp.md
-rw-r--r--   1 tanvipampati  staff   108 Aug 20 11:48 csse.md
drwxr-xr-x  38 tanvipampati  staff  1216 Sep  5 13:06 [34mimages[m[m
-rw-r--r--   1 tanvipampati  staff  5149 Aug 21 13:57 index.md
-rw-r--r--   1 tanvipampati  staff    53 Aug 20 11:48 indexBlogs.md
drwxr-xr-x   9 tanvipampati  staff   288 Aug 20 22:07 [34mscripts[m[m

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for posts"
export posts=$project/_posts  # _posts inside project
cd $posts  # this should exist per fastpages
pwd  # present working directory
ls -l  # list posts

Look for posts
/Users/tanvipampati/vscode/teacher/_posts
total 1160
-rw-r--r--  1 tanvipampati  staff   9664 Aug 20 12:37 2023-08-01-cloud_database_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   5855 Aug 20 12:37 2023-08-01-mario_player_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  35434 Aug 20 12:37 2023-08-02-cloud-workspace-automation_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  15640 Aug 20 12:37 2023-08-03-mario_block_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   7759 Aug 20 12:37 2023-08-03-mario_platform_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  13735 Aug 20 12:37 2023-08-03-mario_tube_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  17295 Aug 20 12:37 2023-08-04-mario_background_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   2740 Aug 20 12:37 2023-08-07-mario_lesson_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   7708 Aug 20 12:37 2023-08-15-java-hello_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   7685 Aug 20 11:48 2023-08-16-Tools_Equipment.md
-rw-r--r--  1 tanvipampati  staff  19805 Aug 22 13:21 2023-08-16-github_pages_setup_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  10337 Aug 20 12:37 2023-08-16-linux_shell_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   4650 Aug 20 11:48 2023-08-16-pair_programming.md
-rw-r--r--  1 tanvipampati  staff   8691 Aug 20 12:37 2023-08-16-python_hello_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   7139 Aug 31 14:10 2023-08-17-markdown-html_fragments.md
-rw-r--r--  1 tanvipampati  staff   4687 Aug 31 14:10 2023-08-21-python_flask.md
-rw-r--r--  1 tanvipampati  staff   7438 Aug 20 12:37 2023-08-23-github_pages_anatomy_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  17955 Aug 20 12:37 2023-08-23-java-console_games_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   6670 Aug 31 14:10 2023-08-23-javascript-calculator.md
-rw-r--r--  1 tanvipampati  staff   5993 Aug 20 12:37 2023-08-23-python_tricks_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  10691 Sep  5 13:06 2023-08-30-agile_methodolgy.md
-rw-r--r--  1 tanvipampati  staff   4397 Sep  5 13:06 2023-08-30-javascript-music-api.md
-rw-r--r--  1 tanvipampati  staff   8420 Aug 20 12:37 2023-08-30-javascript_top_10_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   8735 Aug 20 12:37 2023-08-30-showcase-S1-pair_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   5230 Aug 20 12:37 2023-09-05-python-flask-anatomy_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  16463 Aug 20 12:37 2023-09-06-AWS-deployment_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  10874 Aug 20 12:37 2023-09-06-java-primitives_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   8163 Aug 20 12:37 2023-09-06-javascript-input_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   5312 Aug 31 14:10 2023-09-06-javascript-motion-mario-oop.md
-rw-r--r--  1 tanvipampati  staff  10489 Aug 20 12:37 2023-09-12-java_menu_class_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   3688 Sep  5 13:06 2023-09-12-python-flask-repo.md
-rw-r--r--  1 tanvipampati  staff   2848 Sep  5 13:06 2023-09-12-unit-1-summary.md
-rw-r--r--  1 tanvipampati  staff   4812 Aug 20 11:48 2023-09-13-java-free_response.md
-rw-r--r--  1 tanvipampati  staff   6708 Aug 20 12:37 2023-09-13-java_fibonaccii_class_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  24360 Aug 20 12:37 2023-09-13-javascript_output_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  21670 Aug 20 12:37 2023-09-13-python-pandas_intro_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   8410 Aug 20 12:37 2023-09-20-java-image_2D_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  19204 Aug 20 12:37 2023-09-20-javascript_motion_dog_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   9963 Aug 20 12:37 2023-10-02-java-spring-anatomy_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   9823 Aug 20 12:37 2023-10-09-java-chatgpt_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  11058 Aug 20 12:37 2023-10-09-javascript_api_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  21533 Aug 20 12:37 2023-10-09-python_machine_learing_fitness_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  13219 Aug 31 14:10 2023-10-16-java-api-pojo-jpa.md
-rw-r--r--  1 tanvipampati  staff   6819 Aug 20 11:48 2023-11-13-jwt-java-spring.md
-rw-r--r--  1 tanvipampati  staff  12219 Aug 20 12:37 2023-11-13-jwt-python-flask_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff  12279 Aug 20 12:38 2023-11-13-vulnerabilities_IPYNB_2_.md
-rw-r--r--  1 tanvipampati  staff   6686 Aug 20 12:38 2024-01-04-cockpit-setup_IPYNB_2_.md

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for notebooks"
export notebooks=$project/_notebooks  # _notebooks is inside project
cd $notebooks   # this should exist per fastpages
pwd  # present working directory
ls -l  # list notebooks

Look for notebooks
/Users/tanvipampati/vscode/teacher/_notebooks
total 3936
-rw-r--r--  1 tanvipampati  staff  992100 Aug 31 14:10 2023-07-15-machine_learning.ipynb
-rw-r--r--  1 tanvipampati  staff   43705 Aug 31 14:10 2023-07-29-cloud-workspace-automation.ipynb
-rw-r--r--  1 tanvipampati  staff   13245 Sep  5 13:06 2023-07-29-cloud_database.ipynb
-rw-r--r--  1 tanvipampati  staff    3584 Aug 31 14:10 2023-07-30-mario_overview.ipynb
-rw-r--r--  1 tanvipampati  staff   10600 Aug 31 14:10 2023-08-01-mario_player.ipynb
-rw-r--r--  1 tanvipampati  staff   14783 Aug 31 14:10 2023-08-02-mario_platform.ipynb
-rw-r--r--  1 tanvipampati  staff   22612 Aug 31 14:10 2023-08-03-mario_tube.ipynb
-rw-r--r--  1 tanvipampati  staff   25779 Aug 31 14:10 2023-08-04-mario_block.ipynb
-rw-r--r--  1 tanvipampati  staff   26462 Aug 31 14:10 2023-08-05-mario_goomba.ipynb
-rw-r--r--  1 tanvipampati  staff   30617 Aug 31 14:10 2023-08-06-mario_background.ipynb
-rw-r--r--  1 tanvipampati  staff   10283 Aug 31 14:10 2023-08-15-java-hello.ipynb
-rw-r--r--  1 tanvipampati  staff   26361 Aug 31 14:10 2023-08-16-github_pages_setup.ipynb
-rw-r--r--  1 tanvipampati  staff   16156 Aug 20 11:48 2023-08-16-linux_shell.ipynb
-rw-r--r--  1 tanvipampati  staff   11466 Aug 20 11:48 2023-08-16-python_hello.ipynb
-rw-r--r--  1 tanvipampati  staff   11158 Aug 31 14:10 2023-08-23-github_pages_anatomy.ipynb
-rw-r--r--  1 tanvipampati  staff   23636 Aug 31 14:10 2023-08-23-java-console_games.ipynb
-rw-r--r--  1 tanvipampati  staff    9663 Aug 31 14:10 2023-08-23-python_tricks.ipynb
-rw-r--r--  1 tanvipampati  staff   11546 Sep  5 13:06 2023-08-29-basics-of-js.ipynb
-rw-r--r--  1 tanvipampati  staff    3214 Aug 31 14:10 2023-08-30-javascript_grab.ipynb
-rw-r--r--  1 tanvipampati  staff    9858 Sep  5 13:06 2023-08-30-js-with-html.ipynb
-rw-r--r--  1 tanvipampati  staff    9689 Aug 20 11:48 2023-08-30-showcase-S1-pair.ipynb
-rw-r--r--  1 tanvipampati  staff   14380 Aug 20 11:48 2023-09-06-java-primitives.ipynb
-rw-r--r--  1 tanvipampati  staff   11501 Sep  5 13:06 2023-09-06-javascript-input.ipynb
-rw-r--r--  1 tanvipampati  staff   14910 Sep  5 13:06 2023-09-06-javascript-output-jquery.ipynb
-rw-r--r--  1 tanvipampati  staff    8892 Sep  5 13:06 2023-09-06-python-flask_in_jupyter.ipynb
-rw-r--r--  1 tanvipampati  staff   15944 Sep  5 13:06 2023-09-12-AP-python_lists.ipynb
-rw-r--r--  1 tanvipampati  staff   13706 Aug 31 14:10 2023-09-12-java_menu_class.ipynb
-rw-r--r--  1 tanvipampati  staff    7174 Sep  5 13:06 2023-09-12-python-flask-anatomy.ipynb
-rw-r--r--  1 tanvipampati  staff    9562 Aug 20 11:48 2023-09-13-java_fibonaccii_class.ipynb
-rw-r--r--  1 tanvipampati  staff   44217 Aug 31 14:10 2023-09-13-javascript_output_api.ipynb
-rw-r--r--  1 tanvipampati  staff    8474 Sep  5 13:06 2023-09-13-python-errors_fries.ipynb
-rw-r--r--  1 tanvipampati  staff   43423 Aug 20 11:48 2023-09-13-python-pandas_intro.ipynb
-rw-r--r--  1 tanvipampati  staff   22313 Sep  5 13:06 2023-09-17-python-images-U2-2.ipynb
-rw-r--r--  1 tanvipampati  staff   34764 Sep  5 13:06 2023-09-18-python-pandas-U2-3.ipynb
-rw-r--r--  1 tanvipampati  staff   49093 Sep  5 13:06 2023-09-19-python-sql-U2-4a.ipynb
-rw-r--r--  1 tanvipampati  staff   11553 Sep  5 13:06 2023-09-19-python-sql-U2-4b.ipynb
-rw-r--r--  1 tanvipampati  staff   11578 Aug 31 14:10 2023-09-20-java-image_2D.ipynb
-rw-r--r--  1 tanvipampati  staff   26732 Aug 31 14:10 2023-09-20-javascript_motion_dog.ipynb
-rw-r--r--  1 tanvipampati  staff   22157 Sep  5 13:06 2023-09-27-aws-deployment.ipynb
-rw-r--r--  1 tanvipampati  staff   13599 Aug 31 14:10 2023-10-02-java-spring-anatomy.ipynb
-rw-r--r--  1 tanvipampati  staff   12429 Aug 31 14:10 2023-10-09-java-chatgpt.ipynb
-rw-r--r--  1 tanvipampati  staff   15632 Aug 20 11:48 2023-10-09-javascript_api.ipynb
-rw-r--r--  1 tanvipampati  staff  113091 Aug 20 11:48 2023-10-09-python_machine_learing_fitness.ipynb
-rw-r--r--  1 tanvipampati  staff   20077 Aug 31 14:10 2023-10-16-java_jpa.ipynb
-rw-r--r--  1 tanvipampati  staff   16271 Aug 20 11:48 2023-11-13-jwt-python-flask.ipynb
-rw-r--r--  1 tanvipampati  staff   15951 Aug 20 11:48 2023-11-13-vulnerabilities.ipynb
-rw-r--r--  1 tanvipampati  staff   18328 Aug 20 11:48 2023-11-20-jwt-java-spring-challenge.md
-rw-r--r--  1 tanvipampati  staff   10745 Aug 20 11:48 2024-01-04-cockpit-setup.ipynb
drwxr-xr-x  3 tanvipampati  staff      96 Aug 20 11:48 [34mfiles[m[m

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Look for images in notebooks, print working directory, list files"
cd $notebooks/images  # this should exist per fastpages
pwd
ls -l

Look for images in notebooks, print working directory, list files
/Users/tanvipampati/vscode/tanvipampati3/_notebooks


bash: line 6: cd: /images: No such file or directory


total 152
-rw-r--r--  1 tanvipampati  staff  44570 Sep  6 19:49 2023-08-16-linux_shell.ipynb
-rw-r--r--  1 tanvipampati  staff   5506 Aug 31 13:32 2023-08-17-Markdown_Table_Code_Hack.ipynb
-rw-r--r--  1 tanvipampati  staff   8948 Aug 31 13:32 2023-08-21-HTML_Image_Hack.ipynb
-rw-r--r--  1 tanvipampati  staff   4266 Aug 31 20:14 2023-08-31-Algorithim-mean.ipynb
-rw-r--r--  1 tanvipampati  staff   1220 Aug 31 20:16 2023-08-31-Documentation.ipynb

Look inside a Markdown File

“cat” reads data from the file and gives its content as output

%%script bash

# Extract saved variables
source /tmp/variables.sh

echo "Navigate to project, then navigate to area wwhere files were cloned"

cd $project
echo "show the contents of README.md"
echo ""

cat README.md  # show contents of file, in this case markdown
echo ""
echo "end of README.md"

Navigate to project, then navigate to area wwhere files were cloned
show the contents of README.md

## Teacher Blog site
This site is intended for the development of Teacher content.  This blogging site is built using GitHub Pages [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
- The purpose is to build lessons and distribute across different Computer Science sections (CSSE, CSP, CSA), a pathway that covers 3 years of High School instruction.
- The primary languages and frameworks that are taught are `JavaScript/HTML/CSS`, `Python/Flask`, `Java/Spring`.  Read below for more details.
- In this course, Teacher content is not exclusively developed by Teachers.  In fact, many Students have been invited to develop and publish content into this repository.  Their names will appear as authors on the content which they aided in producing.
- This site has incorporated ideas and has radically modified scripts from the now deprecated [fastpages](https://github.com/fastai/fastpages) repository.
- This site includes assistance and guideance from ChatGPT, [chat.openai.com](https://chat.openai.com/) 

### Courses and Pathway
The focus of the Del Norte Computer Science three-year pathway is `Full Stack Web Development`.  This focus provides a variety of technologies and exposures.  The intention of the pathway is breadth and exposure.
- `JavaScript` documents are focused on frontend development and for entry class into the Del Norte Computer Science pathway.  JavaScript documents and materials are a prerequisites to Python and Java classes.
- `Python` documents are focused on backend development and requirements for the AP Computer Science Principles exam.
- `Java` documents are focused on backend development and requirements for the AP Computer Sciene A exam.
- `Data Structures` materials embedded into JavaScript, Python, or Java documents are focused on college course articulation.

### Resources and Instruction
The materials, such as this README, as well as `Tools`, `DevOps`, and `Collaboration` resources are integral part of this course and Computer Science in general.  Everything in our environment is part of our learning of Computer Science. 
- `Visual Studio Code` is key the code-build-debug cycle editor used in this course, [VSCode download](https://code.visualstudio.com/).  This is an example of a resource, but inside of it it has features for collaboration.
- `Tech Talks`, aka lectures, are intended to be interactive and utilize `Jupyter Notebooks` and Websites.  This is an example of blending instruction and tools together, which in turn provide additional resources for learning.  For instance, deep knowledge on  GitHub Pages and Notebooks are valuable in understanding principles behind Full Stack Development and Data Science. 

## GitHub Pages
All `GitHub Pages` websites are managed on GitHub infrastructure. GitHub uses `Jekyll` to tranform your content into static websites and blogs. Each time we change files in GitHub it initiates a GitHub Action that rebuilds and publishes the site with Jekyll.  
- GitHub Pages is powered by: [Jekyll](https://jekyllrb.com/).
- Publised teacher website: [nighthawkcoders.github.io/teacher](https://nighthawkcoders.github.io/teacher/)

## Preparing a Preview Site 
In all development, it is recommended to test your code before deployment.  The GitHub Pages development process is optimized by testing your development on your local machine, prior to files on GitHub

Development Cycle. For GitHub pages, the tooling described below will create a development cycle  `make-code-save-preview`.  In the development cycle, it is a requirement to preview work locally, prior to doing a VSCode `commit` to git.

Deployment Cycle.  In the deplopyment cycle, `sync-github-action-review`, it is a requirement to complete the development cycle prior to doing a VSCode `sync`.  The sync triggers github repository update.  The action starts the jekyll build to publish the website.  Any step can have errors and will require you to do a review.

### WSL and/or Ubuntu installation requirements
- The result of these step is Ubuntu tools to run preview server.  These procedures were created using [jekyllrb.com](https://jekyllrb.com/docs/installation/ubuntu/)
```bash
# 
# WSL/Ubuntu setup
#
mkdir mkdir vscode
git clone https://github.com/nighthawkcoders/teacher.git
# run script, path vscode/teacher are baked in script
~/vscode/teacher/scripts/activate_ubuntu.sh
#=== !!!Start a new Terminal!!! ===
#=== Continue to next section ===
```

### MacOs installation requirements 
- Ihe result of these step are MacOS tools to run preview server.  These procedures were created using [jekyllrb.com](https://jekyllrb.com/docs/installation/macos/). 

```bash
# 
# MacOS setup
#
mkdir mkdir vscode
git clone https://github.com/nighthawkcoders/teacher.git
# run script, path vscode/teacher are baked in script
~/vscode/teacher/scripts/activate_macos.sh
#=== !!!Start a new Terminal!!! ===
#=== Continue to next section ===
```


### Run Preview Server
- The result of these step is server running on: http://0.0.0.0:4100/teacher/.  Regeneration messages will run in terminal on any save and update site upon refresh.  Terminal is active, press the Enter or Return key in the terminal at any time to see prompt to enter commands.

- Complete installation
```bash
cd ~/vscode/teacher
bundle install
make
```
- Run Server.  This requires running terminal commands `make`, `make stop`, `make clean`, or `make convert` to manage the running server.  Logging of details will appear in terminal.   A `Makefile` has been created in project to support commands and start processes.

    - Start preview server in terminal
    ```bash
    cd ~/vscode/teacher  # my project location, adapt as necessary
    make
    ```

    - Terminal output of shows server address. Cmd or Ctl click http location to open preview server in browser. Example Server address message... 
    ```
    Server address: http://0.0.0.0:4100/teacher/
    ```

    - Save on ipynb or md activiates "regeneration". Refresh browser to see updates. Example terminal message...
    ```
    Regenerating: 1 file(s) changed at 2023-07-31 06:54:32
        _notebooks/2024-01-04-cockpit-setup.ipynb
    ```

    - Terminal message are generated from background processes.  Click return or enter to obtain prompt and use terminal as needed for other tasks.  Alway return to root of project `cd ~/vscode/teacher` for all "make" actions. 
        

    - Stop preview server, but leave constructed files in project for your review.
    ```bash
    make stop
    ```

    - Stop server and "clean" constructed files, best choice when renaming files to eliminate potential duplicates in constructed files.
    ```bash
    make clean
    ```

    - Test notebook conversions, best choice to see if IPYNB conversion is acting up.
    ```bash
    make convert
    ```
    
end of README.md

Env, Git and GitHub

Env(ironment) is used to capture things like path to Code or Home directory. Git and GitHub is NOT Only used to exchange code between individuals, it is often used to exchange code through servers, in our case deployment for Website. All tools we use have a behind the scenes relationships with the system they run on (MacOS, Windows, Linus) or a relationship with servers which they are connected to (ie GitHub). There is an “env” command in bash. There are environment files and setting files (.git/config) for Git. They both use a key/value concept.

“env” show setting for your shell
“git clone” sets up a director of files
“cd $project” allows user to move inside that directory of files
“.git” is a hidden directory that is used by git to establish relationship between machine and the git server on GitHub.

%%script bash

# This command has no dependencies

echo "Show the shell environment variables, key on left of equal value on right"
echo ""

env

Show the shell environment variables, key on left of equal value on right

MANPATH=/opt/homebrew/share/man:/opt/homebrew/share/man:::
VSCODE_CRASH_REPORTER_PROCESS_TYPE=extensionHost
GEM_HOME=/Users/tanvipampati/gems
TERM=xterm-color
SHELL=/bin/zsh
CLICOLOR=1
TMPDIR=/var/folders/kj/bjr9y53j6p39rgwjf5jz2jk80000gn/T/
HOMEBREW_REPOSITORY=/opt/homebrew
PYTHONUNBUFFERED=1
ORIGINAL_XDG_CURRENT_DESKTOP=undefined
MallocNanoZone=0
PYDEVD_USE_FRAME_EVAL=NO
PYTHONIOENCODING=utf-8
USER=tanvipampati
COMMAND_MODE=unix2003
SSH_AUTH_SOCK=/private/tmp/com.apple.launchd.TbrBCHjDlk/Listeners
__CF_USER_TEXT_ENCODING=0x1F5:0x0:0x0
PAGER=cat
ELECTRON_RUN_AS_NODE=1
VSCODE_AMD_ENTRYPOINT=vs/workbench/api/node/extensionHostProcess
PATH=/opt/homebrew/bin:/Users/tanvipampati/Library/Python/3.11/bin:/Users/tanvipampati/gems/bin:/Users/tanvipampati/.rbenv/shims:/opt/homebrew/bin:/opt/homebrew/sbin:/opt/homebrew/bin:/Users/tanvipampati/anaconda3/bin:/Users/tanvipampati/anaconda3/condabin:/Library/Frameworks/Python.framework/Versions/2.7/bin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Users/tanvipampati/gems/bin:/Users/tanvipampati/.rbenv/shims:/opt/homebrew/bin:/opt/homebrew/sbin:/opt/homebrew/bin:/Users/tanvipampati/anaconda3/bin:/Users/tanvipampati/anaconda3/condabin:/Library/Frameworks/Python.framework/Versions/2.7/bin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin
__CFBundleIdentifier=com.microsoft.VSCode
PWD=/Users/tanvipampati/vscode/tanvipampati3/_notebooks
VSCODE_HANDLES_UNCAUGHT_ERRORS=true
MPLBACKEND=module://matplotlib_inline.backend_inline
XPC_FLAGS=0x0
FORCE_COLOR=1
RBENV_SHELL=zsh
XPC_SERVICE_NAME=0
SHLVL=1
HOME=/Users/tanvipampati
APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL=1
VSCODE_NLS_CONFIG={"locale":"en-us","osLocale":"en-us","availableLanguages":{},"_languagePackSupport":true}
PYDEVD_IPYTHON_COMPATIBLE_DEBUGGING=1
HOMEBREW_PREFIX=/opt/homebrew
LOGNAME=tanvipampati
LC_CTYPE=UTF-8
VSCODE_IPC_HOOK=/Users/tanvipampati/Library/Application Support/Code/1.81-main.sock
VSCODE_CODE_CACHE_PATH=/Users/tanvipampati/Library/Application Support/Code/CachedData/6c3e3dba23e8fadc360aed75ce363ba185c49794
CLICOLOR_FORCE=1
VSCODE_PID=6007
INFOPATH=/opt/homebrew/share/info:/opt/homebrew/share/info:
HOMEBREW_CELLAR=/opt/homebrew/Cellar
GIT_PAGER=cat
VSCODE_L10N_BUNDLE_LOCATION=
VSCODE_CWD=/
_=/usr/bin/env

%%script bash

# Extract saved variables
source /tmp/variables.sh

cd $project

echo ""
echo "show the secrets of .git"
cd .git
ls -l

echo ""
echo "look at config file"
cat config

show the secrets of .git
total 80
-rw-r--r--   1 tanvipampati  staff    102 Sep  5 13:33 FETCH_HEAD
-rw-r--r--   1 tanvipampati  staff     21 Aug 20 11:48 HEAD
-rw-r--r--   1 tanvipampati  staff     41 Sep  5 13:06 ORIG_HEAD
-rw-r--r--   1 tanvipampati  staff    312 Aug 20 11:48 config
-rw-r--r--   1 tanvipampati  staff     73 Aug 20 11:48 description
drwxr-xr-x  16 tanvipampati  staff    512 Aug 20 11:48 [34mhooks[m[m
-rw-r--r--   1 tanvipampati  staff  15323 Sep  5 13:06 index
drwxr-xr-x   3 tanvipampati  staff     96 Aug 20 11:48 [34minfo[m[m
drwxr-xr-x   4 tanvipampati  staff    128 Aug 20 11:48 [34mlogs[m[m
drwxr-xr-x  42 tanvipampati  staff   1344 Sep  5 13:33 [34mobjects[m[m
-rw-r--r--   1 tanvipampati  staff    112 Aug 20 11:48 packed-refs
drwxr-xr-x   5 tanvipampati  staff    160 Aug 20 11:48 [34mrefs[m[m

look at config file
[core]
	repositoryformatversion = 0
	filemode = true
	bare = false
	logallrefupdates = true
	ignorecase = true
	precomposeunicode = true
[remote "origin"]
	url = https://github.com/nighthawkcoders/teacher.git
	fetch = +refs/heads/*:refs/remotes/origin/*
[branch "main"]
	remote = origin
	merge = refs/heads/main

Advanced Student Request - Make a file in Bash

This example was requested by a student (Jun Lim, CSA). The request was to make jupyer file using bash, I adapted the request to markdown. This type of thought will have great extrapolation to coding and possibilities of using List, Arrays, or APIs to build user interfaces. JavaScript is a language where building HTML is very common.

To get more interesting output from terminal, this will require using something like mdless (https://github.com/ttscoff/mdless). This enables see markdown in rendered format.

On Desktop Install PKG from MacPorts

In Terminal on MacOS

Install ncurses

gem install mdless

Output of the example is much nicer in “jupyter”

%%script bash

# This example has error in VSCode, it run best on Jupyter
cd /tmp

file="sample.md"
if [ -f "$file" ]; then
    rm $file
fi

tee -a $file >/dev/null <<EOF
# Show Generated Markdown
This introductory paragraph and this line and the title above are generated using tee with the standard input (<<) redirection operator.
- This bulleted element is still part of the tee body.
EOF

echo "- This bulleted element and lines below are generated using echo with standard output (>>) redirection operator." >> $file
echo "- The list definition, as is, is using space to seperate lines.  Thus the use of commas and hyphens in output." >> $file
actions=("ls,list-directory" "cd,change-directory" "pwd,present-working-directory" "if-then-fi,test-condition" "env,bash-environment-variables" "cat,view-file-contents" "tee,write-to-output" "echo,display-content-of-string" "echo_text_>\$file,write-content-to-file" "echo_text_>>\$file,append-content-to-file")
for action in ${actions[@]}; do  # for loop is very similar to other language, though [@], semi-colon, do are new
  action=${action//-/ }  # convert dash to space
  action=${action//,/: } # convert comma to colon
  action=${action//_text_/ \"sample text\" } # convert _text_ to sample text, note escape character \ to avoid "" having meaning
  echo "    - ${action//-/ }" >> $file  # echo is redirected to file with >>
done

echo ""
echo "File listing and status"
ls -l $file # list file
wc $file   # show words
mdless $file  # this requires installation, but renders markown from terminal

rm $file  # clean up termporary file

File listing and status
-rw-r--r--  1 tanvipampati  wheel  809 Sep  6 19:50 sample.md
      15     132     809 sample.md



[0m[0;1;47;90mShow Generated Markdown [0;2;30;47m========================================================[0m

This introductory paragraph and this line and the title above are generated
using tee with the standard input (<<) redirection operator.
[0;1;91m- [0;1;91m[0;97mThis [0;97mbulleted [0;97melement [0;97mis [0;97mstill [0;97mpart [0;97mof [0;97mthe [0;97mtee [0;97mbody.
[0;1;91m- [0;1;91m[0;97mThis [0;97mbulleted [0;97melement [0;97mand [0;97mlines [0;97mbelow [0;97mare [0;97mgenerated [0;97musing [0;97mecho [0;97mwith [0;97mstandard
[0;97moutput [0;97m(>>) [0;97mredirection [0;97moperator.
[0;1;91m- [0;1;91m[0;97mThe [0;97mlist [0;97mdefinition, [0;97mas [0;97mis, [0;97mis [0;97musing [0;97mspace [0;97mto [0;97mseperate [0;97mlines. [0;97mThus [0;97mthe [0;97muse [0;97mof
[0;97mcommas [0;97mand [0;97mhyphens [0;97min [0;97moutput.
      [0;1;91m- [0;1;91m[0;97mls: [0;97mlist [0;97mdirectory
      [0;1;91m- [0;1;91m[0;97mcd: [0;97mchange [0;97mdirectory
      [0;1;91m- [0;1;91m[0;97mpwd: [0;97mpresent [0;97mworking [0;97mdirectory
      [0;1;91m- [0;1;91m[0;97mif [0;97mthen [0;97mfi: [0;97mtest [0;97mcondition
      [0;1;91m- [0;1;91m[0;97menv: [0;97mbash [0;97menvironment [0;97mvariables
      [0;1;91m- [0;1;91m[0;97mcat: [0;97mview [0;97mfile [0;97mcontents
      [0;1;91m- [0;1;91m[0;97mtee: [0;97mwrite [0;97mto [0;97moutput
      [0;1;91m- [0;1;91m[0;97mecho: [0;97mdisplay [0;97mcontent [0;97mof [0;97mstring
      [0;1;91m- [0;1;91m[0;97mecho [0;97m"sample [0;97mtext" [0;97m>$file: [0;97mwrite [0;97mcontent [0;97mto [0;97mfile
      [0;1;91m- [0;1;91m[0;97mecho [0;97m"sample [0;97mtext" [0;97m>>$file: [0;97mappend [0;97mcontent [0;97mto [0;97mfile

[0m

Hack Preparation.

Review Tool Setup Procedures and think about some thing you could verify through a Shell notebook.

Come up with your own student view of this procedure to show your tools are installed. It is best that you keep the few things you understand, add things later as you start to understand them.

Name and create blog notes on some Linux commands you will use frequently.

Is there anything we use to verify tools we installed? Review versions?

How would you update a repository? Use the git command line?

Linux Shell and Bash • 67 min read

Description