Skip to main content

Support for migrations in Peewee ORM

Project description

Peewee Migrate – A simple migration engine for Peewee ORM

Tests Status Build Status PYPI Version Python Versions


  • peewee >= 3.8

Dependency Note

  • For Peewee<3.0 please use Peewee-Migrate==0.14.0

  • For Python 3.0-3.6 please use Peewee-Migrate==1.1.6

  • For Python 3.7 please use Peewee-Migrate==1.6.6


Peewee Migrate should be installed using pip:

pip install peewee-migrate


Do you want Flask integration? Look at Flask-PW.

From shell

Getting help:

$ pw_migrate --help

Usage: pw_migrate [OPTIONS] COMMAND [ARGS]...

    --help  Show this message and exit.

    create   Create migration.
    migrate  Run migrations.
    rollback Rollback migration.

Create migration:

$ pw_migrate create --help

Usage: pw_migrate create [OPTIONS] NAME

    Create migration.

    --auto                  FLAG  Scan sources and create db migrations automatically. Supports autodiscovery.
    --auto-source           TEXT  Set to python module path for changes autoscan (e.g. 'package.models'). Current directory will be recursively scanned by default.
    --database              TEXT  Database connection
    --directory             TEXT  Directory where migrations are stored
    -v, --verbose
    --help                        Show this message and exit.

Run migrations:

$ pw_migrate migrate --help

Usage: pw_migrate migrate [OPTIONS]

    Run migrations.

    --name TEXT       Select migration
    --database TEXT   Database connection
    --directory TEXT  Directory where migrations are stored
    -v, --verbose
    --help            Show this message and exit.

Rollback migrations:

$ pw_migrate rollback --help

Usage: pw_migrate rollback [OPTIONS]

    Rollback a migration with given steps --count of last migrations as integer number

    --count INTEGER   Number of last migrations to be rolled back.Ignored in
                        case of non-empty name

    --database TEXT   Database connection
    --directory TEXT  Directory where migrations are stored
    -v, --verbose
    --help            Show this message and exit.

From python

from peewee_migrate import Router
from peewee import SqliteDatabase

router = Router(SqliteDatabase('test.db'))

# Create migration

# Run migration/migrations'migration_name')

# Run all unapplied migrations

Migration files

By default, migration files are looked up in os.getcwd()/migrations directory, but custom directory can be given.

Migration files are sorted and applied in ascending order per their filename.

Each migration file must specify migrate() function and may specify rollback() function

def migrate(migrator, database, fake=False, **kwargs):

def rollback(migrator, database, fake=False, **kwargs):

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at


Development of starter happens at github:

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

peewee_migrate-1.12.2.tar.gz (16.4 kB view hashes)

Uploaded source

Built Distribution

peewee_migrate-1.12.2-py3-none-any.whl (18.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page