Add ``__main__.py`` file to alembic package

Also reformat the changelog a bit

Fixes: #728
Change-Id: I9198bd9f9fc5d8723a8ddca9faad8835b514fcc0

diff --git a/alembic/__main__.py b/alembic/__main__.py
new file mode 100644 (file)
index 0000000..af1b8e8
--- /dev/null
+++ b/alembic/__main__.py
@@ -0,0 +1,4 @@
+from .config import main
+
+if __name__ == "__main__":
+    main(prog="alembic")

diff --git a/docs/build/unreleased/728.rst b/docs/build/unreleased/728.rst
new file mode 100644 (file)
index 0000000..b791743
--- /dev/null
+++ b/docs/build/unreleased/728.rst
@@ -0,0 +1,5 @@
+.. change::
+    :tags: usecase, commands
+
+    Add ``__main__.py`` file to alembic package to support invocation
+    with ``python -m alembic``.

diff --git a/docs/build/unreleased/clean_up.rst b/docs/build/unreleased/clean_up.rst
index b91fb8dea23be9e5489d8eade45daa169d6c6dc7..ae35f95cf598b11176766abec104d3f58a7eb558 100644 (file)
--- a/docs/build/unreleased/clean_up.rst
+++ b/docs/build/unreleased/clean_up.rst
@@ -1,7 +1,53 @@
 .. change::
-    :tags: changed, commands
+    :tags: removed, commands
+
+    Removed deprecated ``--head_only`` option to the ``alembic current``
+    command
+
+.. change::
+    :tags: removed, operations
+
+    Removed legacy parameter names from operations, these have been emitting
+    warnings since version 0.8.  In the case that legacy version files have not
+    yet been updated, these can be modified directly in order to maintain
+    compatibility:
+
+    * :meth:`.Operations.drop_constraint` - "type" (use "type_") and "name"
+      (use "constraint_name")
+
+    * :meth:`.Operations.create_primary_key` - "cols" (use "columns") and
+      "name" (use "constraint_name")
+
+    * :meth:`.Operations.create_unique_constraint` - "name" (use
+      "constraint_name"), "source" (use "table_name") and "local_cols" (use
+      "columns")
+
+    * :meth:`.Operations.batch_create_unique_constraint` - "name" (use
+      "constraint_name")
+
+    * :meth:`.Operations.create_foreign_key` - "name" (use "constraint_name"),
+      "source" (use "source_table"), "referent" (use "referent_table")
+
+    * :meth:`.Operations.batch_create_foreign_key` - "name" (use
+      "constraint_name"), "referent" (use "referent_table")
+
+    * :meth:`.Operations.create_check_constraint` - "name" (use
+      "constraint_name"), "source" (use "table_name")
+
+    * :meth:`.Operations.batch_create_check_constraint` - "name" (use
+      "constraint_name")
+
+    * :meth:`.Operations.create_index` - "name" (use "index_name")
+
+    * :meth:`.Operations.drop_index` - "name" (use "index_name"), "tablename"
+      (use "table_name")
+
+    * :meth:`.Operations.batch_drop_index` - "name" (use "index_name"),
+
+    * :meth:`.Operations.create_table` - "name" (use "table_name")
+
+    * :meth:`.Operations.drop_table` - "name" (use "table_name")
+
+    * :meth:`.Operations.alter_column` - "name" (use "new_column_name")
 
-    Removed of old deprecated code:
 
-      * ``--head_only`` option to the ``alembic current`` command
-      * legacy argument names in operations, deprecated since version 0.8