Skip to main content

2Style4You upgrade framework

Project description

This package implements a very minimal upgrade framework for use in Python applications. Its design consists of three parts:

  1. context providers, which are responsible for setting up the context required for an upgrade step. For example establishing a connection to a SQL server or configuring SQLALchemy.
  2. upgrade steps, which are functions that perform the actual upgrade steps.
  3. a commandline tool to run the upgrade steps and required context providers.

In order to keep the framework minimal there are a few things which are deliberately not supported:

  • No versioning of the environment is done; the tool will always run all all upgrade steps. Each step must support being run multiple times without unexpected results.
  • Downgrades are not supported.
  • Depdendencies between upgrade steps are not supported.

Here is a basic context provider which configures SQLAlchemy:

def setup_sqlalchemy(options):
    engine = create_engine('postgresql:///projectA')
    return {'sql-engine': engine}

Here is an example upgrade step to add missing tables and indices in a project using SQLALchemy:

def add_missing_tables(environment):

And this is how you run the upgrade:

$ bin/upgrade --scan my.package

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for s4u.upgrade, version 1.3
Filename, size File type Python version Upload date Hashes
Filename, size s4u.upgrade-1.3.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page