https://github.com/brianhicks/trek

simple migrations for your projects
https://github.com/brianhicks/trek

Last synced: 24 days ago
JSON representation

simple migrations for your projects

• Host: GitHub
• URL: https://github.com/brianhicks/trek
• Owner: BrianHicks
• License: mit
• Created: 2014-10-02T22:46:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-06T18:49:03.000Z (over 10 years ago)
• Last Synced: 2024-12-09T19:53:43.407Z (about 1 month ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/trek
• Size: 168 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Trek

====

Trek is a *simple* tool to do migrations of whatever you'd like. It has

terrible documentation because it's pre-1.0.

Usage

-----

Install! ``pip install trek``

Now say you have a directory of migrations::

    migrations

    ├── 1.sql

    ├── 2.sql

    └── 3.sql

Where each of these looks a bit like this::

    -- MIGRATE UP

    CREATE TABLE test (

        id INTEGER PRIMARY KEY

    );

    -- MIGRATE DOWN

    DROP TABLE test;

(using any comment character, but lines with ``MIGRATE UP`` and ``MIGRATE

DOWN`` will be excluded and only one of each line is expected. Also note that

to simplify this example the numbers have been used, but you should probably

use timestamps like ``2014-01-01T00-00-00_human_name.sql``)

You can then run::

    trek --runner=postgres up postgres://trek_test@localhost/trek_test

And the migrations will be run for you. Magic!

Writing your own runner

-----------------------

A runner is just a Python object with ``version``, ``up``, and ``down``

methods. ``version`` will be called with no arguments to determine the current

version, while ``up`` and ``down`` will be called with a name (string) and

``Migration`` object (which has string ``up`` and ``down`` members). ``up`` and

``down`` should be generators, and you can yield as many messages as you need

to so that the user knows what's going on.

After you put your migrator in a file, specify it with

``python.path.to.module:MigratorName``. For example, the postgres migrator is

expanded by the CLI interface but it's full path is

``trek.runners.postgres:PostgresRunner``

TODO

----

- ✓ release on PyPI

- ✓ add Postgres migrator

- add other migrators as needed (open an issue on Github, for what you want,

  please!)

- add flask-script manager interface