summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2019-04-11 12:43:47 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2019-12-01 11:15:44 -0500
commit6626d6dd8350ea19ca90fbde2882981656e90cf5 (patch)
tree77006c6cd2aa9c52833d1317d44ec94baa4e4ebc
parent4d6fefa434dbb44613922a523a4f6e15b92d9b91 (diff)
downloadsqlalchemy-rel_2_0_exp1.tar.gz
initial 2.0 setuprel_2_0_exp1
For the moment, I think removing ./lib/ is just not going to be possible because we still need lots of cross-merges between 1.4 and 2.0. Unfortunately I think we are stuck with it. As for other 2.0 related things, we are still watching 1.4 move along and I don't think we are ready for the "official" 2.0 branch yet, as it will keep getting too far behind. So for now, maintain one or more "experimental" 2.0 branches where we can at least maintain commits we are going to need, like adding the 2.0 migration and all that stuff. But don't name anything "rel_2_0" yet and these branches can disappear at any time. Change-Id: Ib5af75df94b23104eebe0e918adcf979d798ea3b
-rw-r--r--.gitreview2
-rw-r--r--doc/build/changelog/changelog_20.rst13
-rw-r--r--doc/build/changelog/index.rst4
-rw-r--r--doc/build/changelog/migration_20.rst10
-rw-r--r--doc/build/changelog/unreleased_20/README.txt12
-rw-r--r--doc/build/conf.py4
-rw-r--r--doc/build/core/tutorial.rst4
-rw-r--r--doc/build/index.rst2
-rw-r--r--doc/build/intro.rst31
-rw-r--r--doc/build/orm/tutorial.rst4
-rw-r--r--lib/sqlalchemy/__init__.py2
11 files changed, 56 insertions, 32 deletions
diff --git a/.gitreview b/.gitreview
index 43989467e..3e5e2b50d 100644
--- a/.gitreview
+++ b/.gitreview
@@ -1,4 +1,4 @@
[gerrit]
host=gerrit.sqlalchemy.org
project=sqlalchemy/sqlalchemy
-defaultbranch=master
+defaultbranch=rel_2_0
diff --git a/doc/build/changelog/changelog_20.rst b/doc/build/changelog/changelog_20.rst
new file mode 100644
index 000000000..24ebe7357
--- /dev/null
+++ b/doc/build/changelog/changelog_20.rst
@@ -0,0 +1,13 @@
+=============
+2.0 Changelog
+=============
+
+.. changelog_imports::
+
+ .. include:: changelog_13.rst
+ :start-line: 5
+
+
+.. changelog::
+ :version: 2.0.0b1
+ :include_notes_from: unreleased_13
diff --git a/doc/build/changelog/index.rst b/doc/build/changelog/index.rst
index 6e9189a74..e79a898a7 100644
--- a/doc/build/changelog/index.rst
+++ b/doc/build/changelog/index.rst
@@ -12,7 +12,7 @@ Current Migration Guide
.. toctree::
:titlesonly:
- migration_14
+ migration_20
Change logs
-----------
@@ -20,7 +20,7 @@ Change logs
.. toctree::
:titlesonly:
- changelog_14
+ changelog_20
changelog_13
changelog_12
changelog_11
diff --git a/doc/build/changelog/migration_20.rst b/doc/build/changelog/migration_20.rst
new file mode 100644
index 000000000..030332deb
--- /dev/null
+++ b/doc/build/changelog/migration_20.rst
@@ -0,0 +1,10 @@
+=============================
+What's New in SQLAlchemy 2.0
+=============================
+
+.. admonition:: About this Document
+
+ This document describes SQLAlchemy 2.0, which represents a major reworking
+ of API and usage paradigms from the 1.x series. Moving from a 1.x
+ SQLAlchemy application to 2.0 requires migration to new 2.0-style paradigms,
+ most of which are available in the 1.x series for future compatibility.
diff --git a/doc/build/changelog/unreleased_20/README.txt b/doc/build/changelog/unreleased_20/README.txt
new file mode 100644
index 000000000..1d2b3446e
--- /dev/null
+++ b/doc/build/changelog/unreleased_20/README.txt
@@ -0,0 +1,12 @@
+Individual per-changelog files go here
+in .rst format, which are pulled in by
+changelog (version 0.4.0 or higher) to
+be rendered into the changelog_xx.rst file.
+At release time, the files here are removed and written
+directly into the changelog.
+
+Rationale is so that multiple changes being merged
+into gerrit don't produce conflicts. Note that
+gerrit does not support custom merge handlers unlike
+git itself.
+
diff --git a/doc/build/conf.py b/doc/build/conf.py
index bbaf78f31..ffad39c0d 100644
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -121,9 +121,9 @@ copyright = u"2007-2019, the SQLAlchemy authors and contributors" # noqa
# built documents.
#
# The short X.Y version.
-version = "1.4"
+version = "2.0"
# The full version, including alpha/beta/rc tags.
-release = "1.4.0b1"
+release = "2.0.0b1"
release_date = None
diff --git a/doc/build/core/tutorial.rst b/doc/build/core/tutorial.rst
index 2537f92b5..50f0739f8 100644
--- a/doc/build/core/tutorial.rst
+++ b/doc/build/core/tutorial.rst
@@ -50,13 +50,13 @@ Version Check
=============
-A quick check to verify that we are on at least **version 1.4** of SQLAlchemy:
+A quick check to verify that we are on at least **version 2.0** of SQLAlchemy:
.. sourcecode:: pycon+sql
>>> import sqlalchemy
>>> sqlalchemy.__version__ # doctest: +SKIP
- 1.4.0
+ 2.0.0
Connecting
==========
diff --git a/doc/build/index.rst b/doc/build/index.rst
index 9513c8994..b7af0835b 100644
--- a/doc/build/index.rst
+++ b/doc/build/index.rst
@@ -14,7 +14,7 @@ A high level view and getting set up.
:doc:`Overview <intro>` |
:ref:`Installation Guide <installation>` |
:doc:`Frequently Asked Questions <faq/index>` |
-:doc:`Migration from 1.3 <changelog/migration_14>` |
+:doc:`Migration from 1.x <changelog/migration_20>` |
:doc:`Glossary <glossary>` |
:doc:`Error Messages <errors>` |
:doc:`Changelog catalog <changelog/index>`
diff --git a/doc/build/intro.rst b/doc/build/intro.rst
index 300831fe6..f09974170 100644
--- a/doc/build/intro.rst
+++ b/doc/build/intro.rst
@@ -68,21 +68,13 @@ Installation Guide
Supported Platforms
-------------------
-SQLAlchemy has been tested against the following platforms:
+SQLAlchemy supports the following platforms:
-* cPython 2.7
-* cPython 3.4 and higher
-* `PyPy <http://pypy.org/>`_ 2.1 or greater
+* cPython 3.5 and higher
+* Python-3 compatible versions of `PyPy <http://pypy.org/>`_
-.. versionchanged:: 1.2
- Python 2.7 is now the minimum Python version supported.
-
-.. versionchanged:: 1.3
- Within the Python 3 series, 3.4 is now the minimum Python 3 version supported.
-
-Platforms that don't currently have support include Jython and IronPython.
-Jython has been supported in the past and may be supported in future
-releases as well, depending on the state of Jython itself.
+.. versionchanged:: 2.0
+ SQLAlchemy now targets Python 3.5 and above.
Supported Installation Methods
-------------------------------
@@ -93,9 +85,6 @@ by referring to ``setup.py`` directly or by using
`pip <http://pypi.python.org/pypi/pip/>`_ or other setuptools-compatible
approaches.
-.. versionchanged:: 1.1 setuptools is now required by the setup.py file;
- plain distutils installs are no longer supported.
-
Install via pip
---------------
@@ -107,7 +96,7 @@ downloaded from PyPI and installed in one step::
This command will download the latest **released** version of SQLAlchemy from the `Python
Cheese Shop <http://pypi.python.org/pypi/SQLAlchemy>`_ and install it to your system.
-In order to install the latest **prerelease** version, such as ``1.4.0b1``,
+In order to install the latest **prerelease** version, such as ``2.0.0b1``,
pip requires that the ``--pre`` flag be used::
pip install --pre SQLAlchemy
@@ -162,7 +151,7 @@ the available DBAPIs for each database, including external links.
Checking the Installed SQLAlchemy Version
------------------------------------------
-This documentation covers SQLAlchemy version 1.4. If you're working on a
+This documentation covers SQLAlchemy version 2.0. If you're working on a
system that already has SQLAlchemy installed, check the version from your
Python prompt like this:
@@ -170,11 +159,11 @@ Python prompt like this:
>>> import sqlalchemy
>>> sqlalchemy.__version__ # doctest: +SKIP
- 1.4.0
+ 2.0.0
.. _migration:
-1.3 to 1.4 Migration
+1.x to 2.0 Migration
=====================
-Notes on what's changed from 1.3 to 1.4 is available here at :doc:`changelog/migration_14`.
+Notes on the new API released in SQLAlchemy 2.0 is available here at :doc:`changelog/migration_20`.
diff --git a/doc/build/orm/tutorial.rst b/doc/build/orm/tutorial.rst
index 9842ece51..cee2db00b 100644
--- a/doc/build/orm/tutorial.rst
+++ b/doc/build/orm/tutorial.rst
@@ -40,11 +40,11 @@ following text represents the expected return value.
Version Check
=============
-A quick check to verify that we are on at least **version 1.4** of SQLAlchemy::
+A quick check to verify that we are on at least **version 2.0** of SQLAlchemy::
>>> import sqlalchemy
>>> sqlalchemy.__version__ # doctest:+SKIP
- 1.4.0
+ 2.0.0
Connecting
==========
diff --git a/lib/sqlalchemy/__init__.py b/lib/sqlalchemy/__init__.py
index 92128ed22..93cc3942f 100644
--- a/lib/sqlalchemy/__init__.py
+++ b/lib/sqlalchemy/__init__.py
@@ -127,7 +127,7 @@ from .engine import create_mock_engine # noqa nosort
# sqlalchemy.engine that cause import cycles
-__version__ = "1.4.0b1"
+__version__ = '2.0.0b1'
def __go(lcls):