Python Application Template

Overview

PyPi module N/A
git repository https://bitbucket.org/arrizza-public/devpy-app-template
git command git clone git@bitbucket.org:arrizza-public/devpy-app-template.git
Verification Report https://arrizza.com/web-ver/devpy-app-template-report.html
Version Info
OS Language #Runs Last Run Cov%
macOS 14.2.1 Python 3.10 - - -
macOS 14.5 Python 3.10 - - -
Ubuntu 20.04 focal Python 3.10 - - -
Ubuntu 22.04 jammy Python 3.10 - - -
Ubuntu 24.04 noble Python 3.10 17 2025-01-12 97%
win32 Windows 10 Python 3.10 - - -

Summary

This is a template for a Python application. It contains a set of scripts and configuration files that make creating, developing and maintaining a Python app easier.

How to use

  • create a git for your app
  • use a diff tool like meld, and copy contents from this repo into your app.
  • Use the contents of lib as a starting point or replace completely with your app's content

Scripts

# clean it
./do_clean # start from scratch

# install it
./do_subm_update full # first time for submodules
./do_subm_update      # ... thereafter
./do_install full     # first time for OS and pip modules
./do_install          # ...thereafter

# doc it
./do_doc # generate doxygen html and PDF

# check it
./do_check # check configs and files are okay
./do_lint  # pylint or clint-tidy
./do_update  # update local python modules in venv

# run it
./doit   # run the app/sample code
./do_ver # run verification (if implemented)
./do_ut  # run unit tests (if implemented)

# misc
source do_env # (optional) activate python virtual environment 

- John Arrizza