Cross-platform Utilities Module (python)

Overview

TODO under construction

see Quick Start for quick info.

do_clean

clean up the repo e.g. delete venv, delete pycache, etc.

  • TODO how to invoke
  • TODO typical output

The following utilities are available:

do_subm_update

  • needed?

do_install

  • needed?

do_doc

  • TODO how to invoke
  • TODO typical output

do_check

  • TODO how to invoke
  • TODO typical output

do_lint

  • TODO provide a sample pylint.rc
  • TODO how to invoke
  • TODO typical output

do_publish

Publish a Python module to PyPi.

  • TODO provide a sample setup.cfg
  • TODO how to invoke
  • TODO typical output

do_update

needed?

do_build

needed?

doit

needed?

do_ver

needed?

do_ut

needed?

do_coverage

  • TODO how to invoke
  • TODO typical output

gen_build_info

  • TODO how to invoke
  • TODO typical output

other xplat_util functions

class Utils:
    def create_outdir(self):
    def gen_bash_cfg(self, verbose):
    def convert_relative_to_home(self, path):
    def cov_opts(self):
    def gen_files(self, verbose):
    def do_clean(self, verbose):
    def do_check(self, verbose):
    def do_doc(self, verbose, make_pdf=True):
    def do_lint(self, verbose, tech=None):
    def do_build(self, verbose, build_type='debug', tech=None):
    def do_ut(self, verbose, build_type='debug', tech=None):
    def do_publish(self, verbose):
    def do_post_ver(self, verbose):
    def do_ver_info(self, verbose):
    def do_coverage(self, verbose, action=None):
    def pip_outofdate(self, verbose):

- John Arrizza