peewee-migrate 0.2.0

UNKNOWN

Peewee Migrate – A simple migration engine for Peewee

Contents

• Requirements

• Installation

• Usage

  • From shell

  • From python

• Bug tracker

• Contributing

• Contributors

• License

Requirements

• python 2.7,3.3,3.4

Installation

Peewee Migrate should be installed using pip:

pip install peewee_migrate

Usage

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.

Create migration:

$ pw_migrate create --help

Usage: pw_migrate create [OPTIONS] NAME

    Create migration.

Options:
    --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.core import Router

router = Router('migrations', DATABASE='sqlite:///test.db')

# Create migration
router.create('migration_name')

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

# Run all unapplied migrations
router.run()

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.