Skip to main content

Simple migration engine for Peewee

Project description

Peewee Migrate – A simple migration engine for Peewee

Build Status Coverals Version Downloads

Requirements

  • python 2.7,3.3,3.4

Installation

Peewee Migrate should be installed using pip:

pip install peewee_migrate

Usage

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

From shell

Getting help:

$ pw_migrate --help

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

Options:
    --help  Show this message and exit.

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

Create migration:

$ pw_migrate create --help

Usage: pw_migrate create [OPTIONS] NAME

    Create migration.

Options:
    --auto TEXT       Create migrations automatically. Set path to your models module.
    --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.

Options:
    --name TEXT       Select migration
    --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
router.create('migration_name')

# Run migration/migrations
router.run('migration_name')

# Run all unapplied migrations
router.run()

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):
    pass

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

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/peewee_migrate/issues

Contributing

Development of starter happens at github: https://github.com/klen/peewee_migrate

Contributors

  • klen (Kirill Klenov)

License

Licensed under a BSD license.

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-0.5.8.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

peewee_migrate-0.5.8-py2.py3-none-any.whl (16.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file peewee_migrate-0.5.8.tar.gz.

File metadata

File hashes

Hashes for peewee_migrate-0.5.8.tar.gz
Algorithm Hash digest
SHA256 72a863ecedad2ae97ec8605b96028656760927f8f40d5a36c6916b0306c7c57d
MD5 fa5f94088b1eb6116fae011378651965
BLAKE2b-256 a663d05581e8353b568014e1a57d9e0b0c2ed97a3a90600e92fe256dd9d8d42b

See more details on using hashes here.

File details

Details for the file peewee_migrate-0.5.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for peewee_migrate-0.5.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3822d81f66d97d9f48fd711ed81c83eca305b797021415cc59b738b473c85ef5
MD5 d231b590057151f3ed029db8791ac97e
BLAKE2b-256 58a678b46dee49949e3ff559a15e09b237a1db2387a4f1355ddcaa5cc2ad396c

See more details on using hashes here.

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