project-runpy 0.1.1

Helper utilities for Python projects

Generic helpers I wish existed or am constantly copying into my Python projects.

create_project_dir

When you need to build an absolute path but only feel like providing a relative path.

Example Usage:

from project_runpy import create_project_dir

_ = create_project_dir()
DATABASE = _('project.db')

_ = create_project_dir('..')
STATIC_ROOT = _('static_root')

_ = create_project_dir('..', '..')
LOCATION = _('FOO', 'BAR', '..', 'BAZ')

Pass the path to get to your project root into create_project_dir, then use the function it returns to turn relative paths into absolute paths.

env

Get information about your environment variables.

You can use env.get as a drop-in replacement for os.environ.get:

from project_runpy import env

env.get('DATABASE_URL')  # get an environment variable
env.get('DATABASE_URL', 'sqlite:///:memory:')  # provide a default
env.get('DEBUG', True)  # default can be bool
env.get('WORKERS', 10)  # default can be other types too, like int
env.get('DEBUG', True, type_func=bool)  # explicitly get bool

If additional kwargs are specified, they will become the default if ENVIRONMENT matches the key:

from project_runpy import env

env.get('WORKERS', 10, DEV=1)  # if ENVIRONMENT == DEV: default = 1
env.get('DEBUG', FALSE, type_func=bool, TEST=False)  # combine it

ColorizingStreamHandler

Logging handler that produces colorized console output

Usage:

import logging

from project_runpy import ColorizingStreamHandler

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
logger.addHandler(ColorizingStreamHandler())

Django:

LOGGING = {

    ...

    'handlers': {

        ...

        'console': {
            'level': 'DEBUG',
            'class': 'project_runpy.ColorizingStreamHandler',
        },
    },

    ...

}

About

Inspired by dj-settings-helpers, ansistrm.py, and tornado’s define.