1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
Installation
============
This part of the documentation covers the installation of SQLAlchemy-Utils.
Supported platforms
-------------------
SQLAlchemy-Utils is currently tested against the following Python platforms.
- cPython 3.7
- cPython 3.8
- cPython 3.9
- cPython 3.10
- cPython 3.11
Installing an official release
------------------------------
You can install the most recent official SQLAlchemy-Utils version using
pip_::
pip install sqlalchemy-utils
.. _pip: https://pip.pypa.io/
Installing the development version
----------------------------------
To install the latest version of SQLAlchemy-Utils, you need first obtain a
copy of the source. You can do that by cloning the git_ repository::
git clone git://github.com/kvesteri/sqlalchemy-utils.git
Then you can install the source distribution using pip::
cd sqlalchemy-utils
pip install -e .
.. _git: https://git-scm.com/
Checking the installation
-------------------------
To check that SQLAlchemy-Utils has been properly installed, type ``python``
from your shell. Then at the Python prompt, try to import SQLAlchemy-Utils,
and check the installed version:
.. parsed-literal::
>>> import sqlalchemy_utils
>>> sqlalchemy_utils.__version__
|release|
|
