Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.41 KB

README.md

File metadata and controls

51 lines (32 loc) · 2.41 KB

tortoise-data-migration

tests codecov black poetry-managed PyPI - Python Version PyPI - Wheel PyPI

tortoise-data-migration is a very simple project meant to perform migrations of data, similar to regular structural migrations.

The main use case is when your system has some "default data" that needs to exist for the system to work. Some examples:

  • The default username/password of a system
  • The default configuration values (if you store the config in the DB)

These values could be set in the system as part of the installation process, but then when writing tests that use those, you would have to somehow get those values to the DB. So you create a test fixture, and very probably you will be introducing duplication (the bringup/installation process has these values, and the fixture too).

tortoise-data-migrations are meant to be executed by the software (either during test execution of production) after the database structure is up-to-date (in production software after running aerich migrations for example or during tests after the DB setup is done), but before the actual software starts executing. That's why tortoise-data-migration is a library and not a command line tool.

Installation

Pip

pip install tortoise-data-migration

Pipenv

pipenv install tortoise-data-migration

Poetry

poetry add tortoise-data-migration

PDM

pdm add tortoise-data-migration

Notes for maintainers

Release

To create a new release, create a github release and a github action will take care of building and publishing. After that, there will be a PR automatically created to bump the version in main.