PyMyUtils

A Python library containing utilities and features to deal with various tasks we deal with daily for which the feature does not warrant a standalone project of its own.

Quick Install

Currently, the library has only been tested with Python 3.6.6.

To install everything using pip, issue the following commands from the project root directory:

1. pip install -r requirements.txt
2. pip install -e .
3. pip install -e config/

Leave out the -e switch if you want to install the packages into your Python site folder.

You can also use the equivalent Python setup commands:

1. pip install -r requirements.txt
2. python setup.py develop (or install)
3. python config/setup.py develop (or install)

Features

Image Utils

From myutils.client.image.App

from myutils.client.image import App
a = App.Load()

Dependencies:

1. Pillow (PIL)

Resize PNG Images - Preserving Transparent Background

img = a.resizeImagePNG(
    src_path, 
    dst_path, 
    width,
    height=height,
    ratio=ratio,
    resample=resample
)

Configuration

All configuration is done using a framework that sets items to a Python dict when the app is loaded. When App.Load() is invoked, it will call its config manager type to populate the app's config member variable.

>>> from myutils.client.files import App
>>> a = App.Load()
>>> a.config
{'.NS': 'myutils',
 'myutils.prefix': 'files',
 'myutils.now_dt': datetime.datetime(2018, 8, 13, 14, 33, 30, 175158),
 'myutils.working_dir': '/home/hendrix/dev/pymyutils',
 'myutils.level_code': 10,
 'myutils.logging_dir': '/home/hendrix/dev/pymyutils/logs',
...
}

Namespaces

For convenience, you can access and update configuration items using a namespace type variable.

>>> NS = a.config['.NS']
>>> NS
'myutils'
>>> RootNS = a.RootNS
>>> assert NS == RootNS
>>> assert NS == 'myutils'
>>> a.config[NS.logging_dir]
'/home/hendrix/dev/pymyutils/logs'
>>> NS.logging_dir
'myutils.logging_dir'
>>> a.config['myutils.logging_dir']
'/home/hendrix/dev/pymyutils/logs'

To access the settings for the regex and whoosh analyzers associated with this app, you can do something like the following:

>>> aNS = NS.analyzers
>>> aNS
'myutils.analyzers'
>>> a.config[aNS.regex]
{}
>>> whoosh_settings = a.config[aNS.whoosh]
>>> whoosh_settings
{'index_dir': 'wtf_index', 'word_ngrams_max': 3, 'slop_factor': 2}
>>> whoosh_settings['index_dir'] = 'new_wtf_index'

Config Modules

From the project directory, you can find the default configuration modules in the subfolder: config/myutils_c

So the configuration module for the interactor app type: myutils.client.image.App

Is the corresponding matching config type: myutils_c.client.image.App

To update the default values, see file: config/myutils_c/client/image/__init__.py

Ensure Config Modules Can Be Imported

If you do not install the myutils_c package, the root config path must be included in your PYTHONPATH environment variable so that the configuration modules can be imported when App.Load() is called.

If running App.Load() throws ModuleNotFoundError type exceptions, verify that under your environment you can import both these modules without any errors.

>>> import myutils
>>> import myutils_c
>>> 

Logging

When executing the library with an app interactor type, log messages will be outputted to files. The configuration settings for logging can be accessed as follows:

>>> a.config[NS.logging_dir]
'/home/hendrix/dev/pymyutils/logs'
>>> a.logger
<Logger myutils.client.files (INFO)>
>>> a.config[NS.logging]
{'version': 1,
 'disable_existing_loggers': False,
 'formatters': {'simple': {'format': '%(asctime)s|%(name)s|%(levelname)s: %(message)s'}},
 'handlers': {'console': {'class': 'logging.StreamHandler',
   'level': 'CRITICAL',
   'formatter': 'simple',
   'stream': 'ext://sys.stdout'},
  'info_file_handler': {'class': 'logging.handlers.RotatingFileHandler',
   'level': 'INFO',
   'formatter': 'simple',
   'filename': '/home/hendrix/dev/pymyutils/logs/files-2018_08_13_14_33_30-info.log',
   'maxBytes': 10485760,
   'backupCount': 20,
   'encoding': 'utf8'},
...
}

By default, in the log folder there will be two files for critical and non-critical messages respectively.

TDD & CI

This library is being developed using the agile principles of test-driven development (TDD) and continous integration (CI).

Testing is done with Pytest.

This repository is connected to Travis-CI.

Development Roadmap

Features will be added as repetitive daily tasks are encountered.