pelican-migration 1.0.0a0

A modern migration tool for SQLAlchemy.

Pelican

A modern, minimal migration framework for SQLAlchemy

Pelican is a lightweight tool for managing database schema changes. It focuses on readability, simplicity and clean developer experience.

Example

"""20251002014707 - Create spaceships"""
from pelican import migration, create_table, drop_table


@migration.up
def upgrade():
    with create_table('spaceships') as t:
        t.string('name', nullable=False)
        t.index(['id', 'name'])


@migration.down
def downgrade():
    drop_table('spaceships')

Installation

$ pip install pelican @ git+https://github.com/PenguinBoi12/pelican.git@main

(Not available on PyPi yet)

Usage

Create a new migration

$ pelican generate create_spaceships

This creates a new file under db/migrations/ using the default template.

Apply

$ pelican up

Applies all pending migration. You can also supply a revision number to apply migrations up to a specific revision:

$ pelican up 20251002014707

Rollback migration

$ pelican down

Rolls back the latest migrations. You can also supply a revision number to roll back down to a specific revision:

pelican down 20251002014707

Contributing

• Fork the repository.
• Install the development dependencies.

  $ pip install -e .[dev]
  

• Open a PR with your improvements.