Skip to main content

Donald is here

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

Donald-0.0.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

Donald-0.0.0-py2.py3-none-any.whl (8.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Donald-0.0.0.tar.gz.

File metadata

  • Download URL: Donald-0.0.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Donald-0.0.0.tar.gz
Algorithm Hash digest
SHA256 0725f65664ddf04f4dfbbc028fd6c01956bb8cdc0f0b4c038344261930680015
MD5 4edfd61fc36a545365c763e10c23fcd8
BLAKE2b-256 18551ac8e7e233e7eef0018dd97ff27e184e32cf376b23a960db0123c5eb7aaa

See more details on using hashes here.

File details

Details for the file Donald-0.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Donald-0.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8e6bfb173e46374567c28da3aaa6d7d2ea5f0b2f8012db930a55e9328f62c0fb
MD5 fdf88200a039777243aef4dff84edf11
BLAKE2b-256 e36e8a4d6593bad36f953f738f0dded94caaa280aba71fba95e85fa1ba8d9665

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