/peewee-moves

A simple and flexible migration manager for Peewee ORM.

Primary LanguagePythonMIT LicenseMIT

peewee-moves

A simple and flexible migration manager for Peewee ORM.

Build Status Code Coverage Version Downloads Documentation

Requirements

  • python >= 3.3, <= 3.6
  • peewee >= 2.8.2, < 3.0

Warning

This package does not yet work with peewee 3. I'm working on it. Feel free to help out with pull requests if you want.

Installation

This package can be installed using pip:

pip install peewee-moves

Usage

Here's a quick teaser of what you can do with peewee-moves:

$ export FLASK_APP=myflaskapp

$ flask db create app.models.Category
INFO: created migration 0001_create_table_category

$ flask db revision "do something"
INFO: created migration 0002_do_something

$ flask db upgrade
INFO: 0001_create_table_category: upgrade
INFO: 0002_do_something: upgrade

$ flask db downgrade
INFO: 0002_do_something: downgrade

$ flask db status
INFO: 0001_create_table_category: applied
INFO: 0002_do_something: pending

And if you're curious, here's what 0001_create_table_category.py looks like. A migration was automatically created based on the definition of the Category model.

def upgrade(migrator):
    with migrator.create_table('category') as table:
        table.primary_key('id')
        table.integer('code', unique=True)
        table.string('name', max_length=250)

def downgrade(migrator):
    migrator.drop_table('category')

Documentation

Check out the Full Documentation for more details.