Quick start¶

• install liquimigrate
• add ‘liquimigrate’ to INSTALLED_APPS
• configure LIQUIMIGRATE_CHANGELOG_FILES = { ‘default’: os.path.join(os.path.dirname(__file__), “migrations”, “migrations.xml”) in settings }
• ensure that you have java on your path, liquibase and java drivers are embedded into package

CLI¶

Just run ./management.py liquibase update or ./management.py liquibase -h

To learn how to use liquibase look at liquibase documentation:

• http://www.liquibase.org/quickstart

Configuration settings¶

• LIQUIMIGRATE_CHANGELOG_FILES - dictionary with paths to change log files f.e. ‘os.path.join(os.path.dirname(__file__), “migrations”, “migrations.xml”)’ for every database connection you need to maintain using liquimigrate
• old method is still supported: LIQUIMIGRATE_CHANGELOG_FILE - path to change log file f.e. ‘os.path.join(os.path.dirname(__file__), “migrations”, “migrations.xml”)’
• LIQUIMIGRATE_DATABASE - selected database - default ‘default’

How it works¶

Database settings are got from DATEBASES, from key ‘default’ or key configured in settings.py as LIQUIMIGRATE_DATABASE.

Changelog path are got from LIQUIMIGRATE_CHANGELOG_FILES or from command line (check -h).

Supported drivers:

• postgresql
• mysql
• more in future

Development¶

Whole command code is put in:

• liquimigrate/management/commands/liquibase.py
• java connectors are stored in liquimigrate/vendor/connectors
• available drivers mapping is stored in liquimigrate/__init__.py
• mapping to create db url for drivers is stored in liquimigrate/management/commands/liquibase.py in DB_DEFAULTS

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up liquimigrate for local development.

1. Fork the liquimigrate repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/liquimigrate.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv liquimigrate
   $ cd liquimigrate/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 liquimigrate tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/onjin/liquimigrate/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_liquimigrate

Development Lead¶

• Marek Wywiał <onjinx@gmail.com>

Contributors¶

• Marcin Nowak <marcin.j.nowak@gmail.com>
• Bartek Radwan <bartek@sq9mev.info>