python_examples

NAMESPACE: me.hegland-lance

PURPOSE: Practice using VSCode, Markdown, Python, Git, and GitHub tools while testing development environment installation and configuration.

.

Table of Contents

• Features
• Background
• Known Issues
• Requirements
• Installation
• Configuration
• Usage
• Authors
• Roadmap
• License

.

Features

Hands-on practice and testing of Python, VSCode, Git, and GitHub tools (i.e. experiential learning) that is relatively quick and easy plus offers reusable code modules, including the following:

• creating local and remote GitHub repositories
• using the following Git features

  Command	Tutorial	Git Ref
  clone	Link	Link
  init	Link	Link
  status	Link	Link
  diff	Link	Link
  add	Link	Link
  commit	Link	Link
  remote	Link	Link
  push	Link	Link

• using VSCode to update project files, including the following:
  • module_sample.py
  • config_log.py
  • README.md
  • LICENSE.txt
• using Python style coding conventions to improve code readability, usability, and sustainability, including function annotations, type hints, variable annotations, and variable annotation syntax
• using Python docstring conventions for modules and functions to improve readability, usability, and testability
• using common and unexpected exception trapping (i.e. error handling) to improve usability, testability, plus debugability with easy-to-understand and actionable messages
• importing from The Python Standard Library to efficiently integrate credible functionality (i.e. broadly reviewed, tested, and trusted by community members), including the following:
  • providing a command line interface for module config_log.py's help and usage information, which improves module usability and testability, by using argparse library (See py config_log.py -h)
  • logging to either stderr or file depending on user input, plus short "FYI" messages (e.g. info, debug) versus more detailed "alert" messages (e.g. warning, error, critical), which improves testability and debugability, using logging library plus logging "how-to" references to learn about flow, levels, handlers, records, filters, plus formatters (both date formatting and record formatting)
• importing from inter-application modules to reuse developed functionality

.

Background

Lance Hegland wanted to test his local development environment, including the following tools:

• VSCode
• Python
• Git
• GitHub

.

Known Issues

None

.

Requirements

1. Familiarity and access to recent versions of the following development tools:

   Tool	Download	Reference	with VSCode
   VSCode	Link	Link
   + Markdown Preview Github Styling	Link
   + GitHub Pull Requests and Issues	Link
   + Python Tools	Link
   Python	Link	Link	Link
   Git	Link	Link	Link
   GitHub		Link	Link

.

Installation

1. Review README.md
2. Perform the necessary actions to satisfy minimum requirements.
3. From your local projects directory, copy the entire remote GitHub repository LHHegland/python_examples into a local working area (git clone git@github.com:LHHegland/python_examples.git)

.

Configuration

None

.

Usage

Use VSCode, Markdown, Python, Git, and GitHub tools plus provided code examples as you do the following:

1. Use VSCode to create a Python module hello_world
2. Use VSCode to create a Python module (e.g. user_greeting) that asks for the users full name (e.g. Pat Smith) and returns the message "Hi, {first_name}!" (E.g. "Hi, Pat!"). See input and output functions. Feel free to explore the online tutorials from DataCamp to help you.
3. Create a Python module (e.g. logging_display) that uses the logging library to display logging messages (e.g. info, debug, warning, error, critical) to the user's screen (e.g. stderr).
4. Create a Python module (e.g. logging_file) that uses the logging library to record logging messages (e.g. info, debug, warning, error, critical) in a specific file (e.g. my.log).
5. Create a single Python module (e.g. logging_both) that uses the logging library to either display or store logging messages depending on the command line options or function parameters provided by the user; combining the functionality of logging_display and logging_file.
6. Update your Python module logging_both to include exception trapping (i.e. error handling) to improve usability, testability, plus debugability with easy-to-understand and actionable messages.
7. Update your Python module logging_both to include a command line interface to display help and usage information, which improves module usability and testability, by using argparse library (See py config_log.py -h)
8. Update your user greeting module to include logging.
9. Review and update your modules to reflect the following:
   1. Python style coding conventions to improve code readability, usability, and sustainability, including function annotations, type hints, variable annotations, and variable annotation syntax
   2. Python docstring conventions for modules and functions to improve readability, usability, and testability
10. Make a README document using Markdown language.
11. Choose an open source license and copy the text into a LICENSE.txt file
12. Create and push your Python example package to a newly created remote repository in your GitHub account.
    1. From your local working area with your newly created files, initialize your local repository (git init)
    2. Update working area to staging area (git add --verbose --all)
    3. Review differences: working vs. staging vs. commits
       1. Review file differences between last commit vs staging areas vs working area (git status)
       2. Review file line differences between staging area vs working area (git diff)
       3. Review differences to be committed (file line differences between last commit vs staging area) (git diff --cached)
    4. Update staging area to commits area (git commit --message="Initial Commit with Base Files")
    5. Review differences: working vs. staging vs. commits
       1. Review differences between last commit vs staging areas vs working area (git status)
       2. Review file line differences between staging area vs working area (git diff)
       3. Review file line differences to be committed (last commit vs staging area) (git diff --cached)
       4. Review file line differences between last commit vs working area (git diff HEAD)
       5. Review commit history (git log --oneline)
       6. Review commit change summary by file (git log --stat)
       7. Review brief commit messages by author (git shortlog)
       8. Review commit diagram (git log --graph --oneline --decorate)
       9. Review commit changes by file (git log -p)
    6. Create remote GitHub repository my_python_examples
    7. Connect to that remote repository (git remote add origin git@github.com:your_username/my_python_examples.git)
    8. Verify remote repository (git remote -v)
    9. Review existing branches (git branch --list)
    10. Update remote repository (git push -u origin master) .

Authors

• Lance Hegland (lance.hegland@gmail.com)

.

Roadmap

None

.

License

GNU General Public License v3.0 (GNU GPLv3)

• See LICENSE.txt
• See GNU General Public License v3.0 (GNU GPLv3)