]> git.ipfire.org Git - thirdparty/sqlalchemy/alembic.git/commitdiff
Add some extra rationale for project-local setup
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 16 Nov 2019 15:25:38 +0000 (10:25 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 16 Nov 2019 15:25:38 +0000 (10:25 -0500)
Change-Id: I1c191e0a7189f911128ab8a1363ea821dcc15257

docs/build/front.rst

index ebafa1fa1b9536f7b64d2159503fe51ae572a373..f5a6f059d65b43ff439ad3719fc9f48c9cba6ccd 100644 (file)
@@ -25,6 +25,18 @@ assumed that an approach like `virtual environments
 that the target project also `has a setup.py script
 <https://packaging.python.org/tutorials/packaging-projects/>`_.
 
+.. note::
+
+    While the ``alembic`` command line tool runs perfectly fine no matter where
+    its installed, the rationale for project-local setup is that the Alembic
+    command line tool runs most of its key operations through a Python file
+    ``env.py`` that is established as part of a project's setup when the
+    ``alembic init`` command is run for that project;  the purpose of
+    ``env.py`` is to establish database connectivity and optionally model
+    definitions for the migration process, the latter of which in particular
+    usually rely upon being able to import the modules of the project itself.
+
+
 The documentation below is **only one kind of approach to installing Alembic for a
 project**; there are many such approaches.   The documentation below is
 provided only for those users who otherwise have no specific project setup