Merge "Update URLs in documentation"
This commit is contained in:
commit
fe3e08ae0b
22
README.rst
22
README.rst
@ -14,15 +14,16 @@ well as from inside python code.
|
|||||||
Help
|
Help
|
||||||
----
|
----
|
||||||
|
|
||||||
Sphinx documentation is available at the project page `packages.python.org
|
Sphinx documentation is available at the project page `readthedocs.org
|
||||||
<http://packages.python.org/sqlalchemy-migrate/>`_.
|
<https://sqlalchemy-migrate.readthedocs.org/>`_.
|
||||||
|
|
||||||
Users and developers can be found at #sqlalchemy-migrate on Freenode IRC
|
Users and developers can be found at #openstack-dev on Freenode IRC
|
||||||
network and at the public users mailing list `migrate-users
|
network and at the public users mailing list `migrate-users
|
||||||
<http://groups.google.com/group/migrate-users>`_.
|
<http://groups.google.com/group/migrate-users>`_.
|
||||||
|
|
||||||
New releases and major changes are announced at the public announce mailing
|
New releases and major changes are announced at the public announce mailing
|
||||||
list `migrate-announce <http://groups.google.com/group/migrate-announce>`_
|
list `openstack-dev
|
||||||
|
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev>`_
|
||||||
and at the Python package index `sqlalchemy-migrate
|
and at the Python package index `sqlalchemy-migrate
|
||||||
<http://pypi.python.org/pypi/sqlalchemy-migrate>`_.
|
<http://pypi.python.org/pypi/sqlalchemy-migrate>`_.
|
||||||
|
|
||||||
@ -37,13 +38,10 @@ Tests and Bugs
|
|||||||
|
|
||||||
To run automated tests:
|
To run automated tests:
|
||||||
|
|
||||||
* Copy test_db.cfg.tmpl to test_db.cfg
|
* install tox: ``pip install -U tox``
|
||||||
* Edit test_db.cfg with database connection strings suitable for running tests.
|
* run tox: ``tox``
|
||||||
(Use empty databases.)
|
* to test only a specific Python version: ``tox -e py27`` (Python 2.7)
|
||||||
* $ pip install -r requirements.txt -r test-requirements.txt
|
|
||||||
* $ python setup.py develop
|
|
||||||
* $ testr run --parallel
|
|
||||||
|
|
||||||
Please report any issues with sqlalchemy-migrate to the issue tracker at
|
Please report any issues with sqlalchemy-migrate to the issue tracker at
|
||||||
`code.google.com issues
|
`Launchpad issues
|
||||||
<http://code.google.com/p/sqlalchemy-migrate/issues/list>`_
|
<https://bugs.launchpad.net/sqlalchemy-migrate>`_
|
||||||
|
@ -21,51 +21,32 @@ command use::
|
|||||||
$ migrate help COMMAND
|
$ migrate help COMMAND
|
||||||
|
|
||||||
If you'd like to be notified when new versions of SQLAlchemy Migrate
|
If you'd like to be notified when new versions of SQLAlchemy Migrate
|
||||||
are released, subscribe to `migrate-announce`_.
|
are released, subscribe to `openstack-dev`_.
|
||||||
|
|
||||||
.. _pip: http://pip.openplans.org/
|
.. _pip: http://pip.openplans.org/
|
||||||
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install
|
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install
|
||||||
.. _sqlalchemy: http://www.sqlalchemy.org/download.html
|
.. _sqlalchemy: http://www.sqlalchemy.org/download.html
|
||||||
.. _`project's download page`: http://code.google.com/p/sqlalchemy-migrate/downloads/list
|
|
||||||
.. _`cheese shop`: http://pypi.python.org/pypi/sqlalchemy-migrate
|
.. _`cheese shop`: http://pypi.python.org/pypi/sqlalchemy-migrate
|
||||||
.. _`migrate-announce`: http://groups.google.com/group/migrate-announce
|
.. _`openstack-dev`: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
||||||
|
|
||||||
.. _development:
|
.. _development:
|
||||||
|
|
||||||
Development
|
Development
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Migrate's Mercurial_ repository is located at `Google Code`_.
|
If you would like to contribute to the development of OpenStack,
|
||||||
|
you must follow the steps in this page:
|
||||||
|
|
||||||
To get the latest trunk::
|
http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
|
||||||
$ hg clone http://sqlalchemy-migrate.googlecode.com/hg/
|
Once those steps have been completed, changes to OpenStack
|
||||||
|
should be submitted for review via the Gerrit tool, following
|
||||||
|
the workflow documented at:
|
||||||
|
|
||||||
Patches should be submitted to the `issue tracker`_. You are free to create
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
your own clone to provide your patches. We are open to pull requests in our
|
|
||||||
`issue tracker`_.
|
|
||||||
|
|
||||||
If you want to work on sqlalchemy-migrate you might want to use a `virtualenv`.
|
Pull requests submitted through GitHub will be ignored.
|
||||||
|
|
||||||
To run the included test suite you have to copy :file:`test_db.cfg.tmpl` to
|
Bugs should be filed on Launchpad, not GitHub:
|
||||||
:file:`test_db.cfg` and put SQLAlchemy database URLs valid for your environment
|
|
||||||
into that file. We use `nose`_ for our tests and include a test requirements
|
|
||||||
file for pip. You might use the following commands to install the test
|
|
||||||
requirements and run the tests::
|
|
||||||
|
|
||||||
$ pip install -r test-req.pip
|
https://bugs.launchpad.net/sqlalchemy-migrate
|
||||||
$ python setup.py develop
|
|
||||||
$ python setup.py nosetests
|
|
||||||
|
|
||||||
If you are curious about status changes of sqlalchemy-migrate's issues you
|
|
||||||
might want to subscribe to `sqlalchemy-migrate-issues`_.
|
|
||||||
|
|
||||||
We use a `Jenkins CI`_ continuous integration tool installation to
|
|
||||||
help us run tests on most of the databases that migrate supports.
|
|
||||||
|
|
||||||
.. _Mercurial: http://www.mercurial-scm.org/
|
|
||||||
.. _Google Code: http://sqlalchemy-migrate.googlecode.com/hg/
|
|
||||||
.. _issue tracker: http://code.google.com/p/sqlalchemy-migrate/issues/list
|
|
||||||
.. _sqlalchemy-migrate-issues: http://groups.google.com/group/sqlalchemy-migrate-issues
|
|
||||||
.. _Jenkins CI: http://jenkins.gnuviech-server.de/job/sqlalchemy-migrate-all/
|
|
||||||
.. _nose: http://readthedocs.org/docs/nose/
|
|
||||||
|
@ -7,9 +7,9 @@
|
|||||||
:Author: Evan Rosson
|
:Author: Evan Rosson
|
||||||
:Maintainer: Domen Kožar <domenNO@SPAMdev.si>
|
:Maintainer: Domen Kožar <domenNO@SPAMdev.si>
|
||||||
:Maintainer: Jan Dittberner <jan.dittbernerNO@SPAMgooglemail.com>
|
:Maintainer: Jan Dittberner <jan.dittbernerNO@SPAMgooglemail.com>
|
||||||
:Issues: http://code.google.com/p/sqlalchemy-migrate/issues/list
|
:Source Code: https://github.com/stackforge/sqlalchemy-migrate
|
||||||
:Source Code: http://code.google.com/p/sqlalchemy-migrate/
|
:Documentation: https://sqlalchemy-migrate.readthedocs.org/
|
||||||
:CI Tool: http://jenkins.gnuviech-server.de/job/sqlalchemy-migrate-all/
|
:Issues: https://bugs.launchpad.net/sqlalchemy-migrate
|
||||||
:Generated: |today|
|
:Generated: |today|
|
||||||
:License: MIT
|
:License: MIT
|
||||||
:Version: |release|
|
:Version: |release|
|
||||||
@ -24,7 +24,7 @@
|
|||||||
mentored by Jonathan LaCour.
|
mentored by Jonathan LaCour.
|
||||||
|
|
||||||
The project was taken over by a small group of volunteers when Evan had no
|
The project was taken over by a small group of volunteers when Evan had no
|
||||||
free time for the project. It is now hosted as a `Google Code project`_.
|
free time for the project. It is now hosted as a `Github project`_.
|
||||||
During the hosting change the project was renamed to SQLAlchemy Migrate.
|
During the hosting change the project was renamed to SQLAlchemy Migrate.
|
||||||
|
|
||||||
Currently, sqlalchemy-migrate supports Python versions from 2.6 to 2.7.
|
Currently, sqlalchemy-migrate supports Python versions from 2.6 to 2.7.
|
||||||
@ -64,6 +64,7 @@ Dialect support
|
|||||||
- :ref:`oracle <oracle-d>`
|
- :ref:`oracle <oracle-d>`
|
||||||
- :ref:`firebird <firebird-d>`
|
- :ref:`firebird <firebird-d>`
|
||||||
- mssql
|
- mssql
|
||||||
|
- DB2
|
||||||
* - :ref:`ALTER TABLE RENAME TABLE <table-rename>`
|
* - :ref:`ALTER TABLE RENAME TABLE <table-rename>`
|
||||||
- yes
|
- yes
|
||||||
- yes
|
- yes
|
||||||
@ -160,7 +161,7 @@ SQLAlchemy Migrate is split into two parts, database schema versioning
|
|||||||
glossary
|
glossary
|
||||||
|
|
||||||
.. _`google's summer of code`: http://code.google.com/soc
|
.. _`google's summer of code`: http://code.google.com/soc
|
||||||
.. _`Google Code project`: http://code.google.com/p/sqlalchemy-migrate
|
.. _`Github project`: https://github.com/stackforge/sqlalchemy-migrate
|
||||||
.. _sqlalchemy: http://www.sqlalchemy.org
|
.. _sqlalchemy: http://www.sqlalchemy.org
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user