@@ -55,7 +55,7 @@ Documentation Overview
55
55
56
56
The documentation is separated into four sections:
57
57
58
- * :ref: `unified_tutorial ` - this all-new tutorial for the 1.4/2.0 series of
58
+ * :ref: `unified_tutorial ` - this all-new tutorial for the 1.4/2.0/2.1 series of
59
59
SQLAlchemy introduces the entire library holistically, starting from a
60
60
description of Core and working more and more towards ORM-specific concepts.
61
61
New users, as well as users coming from the 1.x series of
@@ -94,23 +94,14 @@ Installation Guide
94
94
Supported Platforms
95
95
-------------------
96
96
97
- SQLAlchemy supports the following platforms:
97
+ SQLAlchemy 2.1 supports the following platforms:
98
98
99
- * cPython 3.7 and higher
99
+ * cPython 3.8 and higher
100
100
* Python-3 compatible versions of `PyPy <http://pypy.org/ >`_
101
101
102
- .. versionchanged :: 2.0
103
- SQLAlchemy now targets Python 3.7 and above.
102
+ .. versionchanged :: 2.1
103
+ SQLAlchemy now targets Python 3.8 and above.
104
104
105
- AsyncIO Support
106
- ----------------
107
-
108
- SQLAlchemy's ``asyncio `` support depends upon the
109
- `greenlet <https://pypi.org/project/greenlet/ >`_ project. This dependency
110
- will be installed by default on common machine platforms, however is not
111
- supported on every architecture and also may not install by default on
112
- less common architectures. See the section :ref: `asyncio_install ` for
113
- additional details on ensuring asyncio support is present.
114
105
115
106
Supported Installation Methods
116
107
-------------------------------
@@ -129,7 +120,7 @@ downloaded from PyPI and installed in one step:
129
120
130
121
.. sourcecode :: text
131
122
132
- pip install SQLAlchemy
123
+ pip install sqlalchemy
133
124
134
125
This command will download the latest **released ** version of SQLAlchemy from
135
126
the `Python Cheese Shop <https://pypi.org/project/SQLAlchemy >`_ and install it
@@ -141,11 +132,30 @@ pip requires that the ``--pre`` flag be used:
141
132
142
133
.. sourcecode :: text
143
134
144
- pip install --pre SQLAlchemy
135
+ pip install --pre sqlalchemy
145
136
146
137
Where above, if the most recent version is a prerelease, it will be installed
147
138
instead of the latest released version.
148
139
140
+ Installing with AsyncIO Support
141
+ -------------------------------
142
+
143
+ SQLAlchemy's ``asyncio `` support depends upon the
144
+ `greenlet <https://pypi.org/project/greenlet/ >`_ project. This dependency
145
+ is not inclued by default. To install with asyncio support, run this command:
146
+
147
+ .. sourcecode :: text
148
+
149
+ pip install sqlalchemy[asyncio]
150
+
151
+ This installation will include the greenlet dependency in the installation.
152
+ See the section :ref: `asyncio_install ` for
153
+ additional details on ensuring asyncio support is present.
154
+
155
+ .. versionchanged :: 2.1 SQLAlchemy no longer installs the "greenlet"
156
+ dependency by default; use the ``sqlalchemy[asyncio] `` pip target to
157
+ install.
158
+
149
159
150
160
Installing manually from the source distribution
151
161
-------------------------------------------------
@@ -238,13 +248,13 @@ the available DBAPIs for each database, including external links.
238
248
Checking the Installed SQLAlchemy Version
239
249
------------------------------------------
240
250
241
- This documentation covers SQLAlchemy version 2.0 . If you're working on a
251
+ This documentation covers SQLAlchemy version 2.1 . If you're working on a
242
252
system that already has SQLAlchemy installed, check the version from your
243
253
Python prompt like this::
244
254
245
255
>>> import sqlalchemy
246
256
>>> sqlalchemy.__version__ # doctest: +SKIP
247
- 2.0 .0
257
+ 2.1 .0
248
258
249
259
Next Steps
250
260
----------
@@ -254,7 +264,21 @@ With SQLAlchemy installed, new and old users alike can
254
264
255
265
.. _migration :
256
266
257
- 1.x to 2.0 Migration
267
+ 2.0 to 2.1 Migration
258
268
=====================
259
269
260
- Notes on the new API released in SQLAlchemy 2.0 is available here at :doc: `changelog/migration_20 `.
270
+ Users coming SQLAlchemy version 2.0 will want to read:
271
+
272
+ * :doc: `What's New in SQLAlchemy 2.1? <changelog/migration_21 >` - New features and behaviors in version 2.1
273
+
274
+ Users transitioning from 1.x versions of SQLAlchemy, such as version 1.4, will want to
275
+ transition to version 2.0 overall before making any additional changes needed for
276
+ the much smaller transition from 2.0 to 2.1. Key documentation for the 1.x to 2.x
277
+ transition:
278
+
279
+ * :doc: `Migrating to SQLAlchemy 2.0 <changelog/migration_20 >` - Complete background on migrating from 1.3 or 1.4 to 2.0
280
+ * :doc: `What's New in SQLAlchemy 2.0? <changelog/whatsnew_20 >` - New 2.0 features and behaviors beyond the 1.x migration
281
+
282
+ An index of all changelogs and migration documentation is at:
283
+
284
+ * :doc: `Changelog catalog <changelog/index >` - Detailed changelogs for all SQLAlchemy Versions
0 commit comments