mongrations 0.0.8

Mongrations; a database migration tool for Python 3.6 and above.

Mongrations

A migrations tool for Python 3.6+. Mongrations started as a MongoDB migrations tool but has introduced MySQL & Postgres as compatible databases for the Mongrations tool.

Getting Started

1 . Generate a migration file

mongrations create insert-into-members

2 . Contents of the generated migration file (import and class definition are autogenerated for migration file - contents of up() and down() are user defined.)

from mongrations import Mongrations, Database
from pydotenvs import load_env

load_env()
# This is a MongoDB example. Go to /examples directory
# for more examples

class Mongration(Database):
    def __init__(self):
        super(Database, self).__init__()

    def up(self):
        collection = self.db['members']
        data = {
            'accountId': 1,
            'username': 'admin',
            'email': '[e-mail]',
            'firstName': 'Site',
            'lastName': 'Owner'
        }
        collection.insert_one(data)

    def down(self):
        collection = self.db['members']
        collection.delete_one({'username': 'admin'})


Mongrations(Mongration, 'sync')

3 . Run migrations

mongrations migrate

Install

pip install --upgrade mongrations

or install locally

sudo python setup.py install

Use

Mongrations comes with a CLI Tool as well as a class for a pythonic migration approach. PyMongo, PyMySQL & Psycopg2 are used under the hood, so follow PyMongo's, PyMySQL's, or Psycopg2's documentation for instructions on how to create your migrations. For the environment variable tool used in this application, follow this repo (its also installed with this package).

Refer to Mongrations documentation for more information.

CLI

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

  Mongrations; a database migration tool for Python 3.6 and above.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  create
  down
  migrate
  undo

CLI Examples

mongrations create [name]  # create new migration (w/ name)
mongrations migrate  # run migrations
mongrations down  # tear down migrations
mongrations undo  # undo last migration

Mongrations Class

from mongrations import MongrationsCli

migrations = MongrationsCli()

migrations.create(directory='migrations', name='file_name')
migrations.migrate()
migrations.down()
migrations.undo()

Run example migration in examples/ folder

Issues

Please report all issues to repo.

Notes

You can install psycopg2 from source via setup.py; python setup.py develop. Follow prompts. You will need root access to development machine to install this tool.