python_project_template

NAMESPACE: me.hegland-lance

PURPOSE: Offer a template collection of common Python project files to help create new projects more quickly, easily, and reliably. See more specific features for additional details.

.

Table of Contents

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

.

Features

• README.md template, including many of suggestions from GitHub README Tips and How to Write a Good README File for Your GitHub Project written by Hillary Nyakundi and published by freeCodeCamp on December 8, 2021
• LICENSE.txt with basic MIT License
• Python module and function template, including the following:
  • docstring templates based on Python docstring conventions
  • sample code using Python style coding conventions, including the following:
    • function annotations
    • type hints
    • variable annotations and variable annotation syntax
  • command line interface help and usage instructions using The Python Standard Library's argparse package
  • logging using an intra-project module config_log.py and The Python Standard Library's logging package
    • output (stderr) to either screen or file based on user instructions (see py config_log.py -h)
    • short "FYI" messages for info and debug logging levels
    • more detailed "alert" messages for warning, error, and critical logging levels
    • sample logging message testing for various levels (e.g. info, debug, warning, error, critical)
  • common and unexpected exception trapping (i.e. error handling)
    • specified exception and unknown exception testing available based on user instructions (see py config_log.py -h)

.

Background

Lance Hegland wanted application development templates for his personal use that might improve the readability, usability, testability, debuggability, and sustainability of his projects. So, he began developing and testing these templates while practicing lean methodologies, specifically the following activities:

• 5S (Sort, Set in Order, Shine, Standardize, and Sustain)
• Poka-Yok (mistake-proofing)
• Just-in-Time (JIT)

For more information about the lean methodology, visit the following:

• Lean Enterprise Institute (LEI)
• Lean Global Network (LGN)
• ASQ (American Society for Quality)

.

Known Issues

None

.

Requirements

1. Familiarity and access to Python development tools, such as recent versions of the following:

   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_project_template.git)

.

Configuration

None

.

Usage

Review and adapt the code samples as you begin developing a new Python project to meet your specific needs.

.

Authors

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

.

Roadmap

None

.

License

MIT License

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