sqlalchemy-migrate/README.rst
Stephen Finucane 749b3758f5 Retire repo
Remove CI jobs and update docs to point to alembic.

Fix docs build.

Change-Id: Ibcfb7d10f2b5098f2c7612c3f2dca54609841e85
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2024-09-26 08:30:47 +02:00

56 lines
1.8 KiB
ReStructuredText

SQLAlchemy Migrate
==================
.. warning::
sqlalchemy-migrate is no longer maintained and is not compatible with
SQLAlchemy 2.x. `alembic`__ is a modern replacement that is developed and
supported by the SQLAlchemy authors.
.. __: https://alembic.sqlalchemy.org/en/latest/
Fork from http://code.google.com/p/sqlalchemy-migrate/ to get it working with
SQLAlchemy 0.8.
Inspired by Ruby on Rails' migrations, Migrate provides a way to deal with
database schema changes in `SQLAlchemy <http://sqlalchemy.org>`_ projects.
Migrate extends SQLAlchemy to have database changeset handling. It provides a
database change repository mechanism which can be used from the command line as
well as from inside python code.
Help
----
Sphinx documentation is available at the project page `readthedocs.org
<https://sqlalchemy-migrate.readthedocs.org/>`_.
Users and developers can be found at #openstack-dev on Freenode IRC
network and at the public users mailing list `migrate-users
<http://groups.google.com/group/migrate-users>`_.
New releases and major changes are announced at the public announce mailing
list `openstack-dev
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_
and at the Python package index `sqlalchemy-migrate
<http://pypi.python.org/pypi/sqlalchemy-migrate>`_.
Homepage is located at `stackforge
<http://github.com/stackforge/sqlalchemy-migrate/>`_
You can also clone a current `development version
<http://github.com/stackforge/sqlalchemy-migrate>`_
Tests and Bugs
--------------
To run automated tests:
* install tox: ``pip install -U tox``
* run tox: ``tox``
* to test only a specific Python version: ``tox -e py27`` (Python 2.7)
Please report any issues with sqlalchemy-migrate to the issue tracker at
`Launchpad issues
<https://bugs.launchpad.net/sqlalchemy-migrate>`_