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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
.. _installation:
Installation
============
Python Version
--------------
We recommend using the latest version of Python 3. Werkzeug supports
Python 3.5 and newer and Python 2.7.
Dependencies
------------
Werkzeug does not have any direct dependencies.
Optional dependencies
~~~~~~~~~~~~~~~~~~~~~
These distributions will not be installed automatically. Werkzeug will
detect and use them if you install them.
* `SimpleJSON`_ is a fast JSON implementation that is compatible with
Python's ``json`` module. It is preferred for JSON operations if it is
installed.
* `Click`_ provides request log highlighting when using the
development server.
* `Watchdog`_ provides a faster, more efficient reloader for the
development server.
.. _SimpleJSON: https://simplejson.readthedocs.io/en/latest/
.. _Click: https://pypi.org/project/click/
.. _Watchdog: https://pypi.org/project/watchdog/
Virtual environments
--------------------
Use a virtual environment to manage the dependencies for your project,
both in development and in production.
What problem does a virtual environment solve? The more Python
projects you have, the more likely it is that you need to work with
different versions of Python libraries, or even Python itself. Newer
versions of libraries for one project can break compatibility in
another project.
Virtual environments are independent groups of Python libraries, one for
each project. Packages installed for one project will not affect other
projects or the operating system's packages.
Python 3 comes bundled with the :mod:`venv` module to create virtual
environments. If you're using a modern version of Python, you can
continue on to the next section.
If you're using Python 2, see :ref:`install-install-virtualenv` first.
.. _install-create-env:
Create an environment
~~~~~~~~~~~~~~~~~~~~~
Create a project folder and a :file:`venv` folder within:
.. code-block:: sh
mkdir myproject
cd myproject
python3 -m venv venv
On Windows:
.. code-block:: bat
py -3 -m venv venv
If you needed to install virtualenv because you are on an older version
of Python, use the following command instead:
.. code-block:: sh
virtualenv venv
On Windows:
.. code-block:: bat
\Python27\Scripts\virtualenv.exe venv
Activate the environment
~~~~~~~~~~~~~~~~~~~~~~~~
Before you work on your project, activate the corresponding environment:
.. code-block:: sh
. venv/bin/activate
On Windows:
.. code-block:: bat
venv\Scripts\activate
Your shell prompt will change to show the name of the activated
environment.
Install Werkzeug
----------------
Within the activated environment, use the following command to install
Werkzeug:
.. code-block:: sh
pip install Werkzeug
Living on the edge
~~~~~~~~~~~~~~~~~~
If you want to work with the latest Werkzeug code before it's released,
install or update the code from the master branch:
.. code-block:: sh
pip install -U https://github.com/pallets/werkzeug/archive/master.tar.gz
.. _install-install-virtualenv:
Install virtualenv
------------------
If you are using Python 2, the venv module is not available. Instead,
install `virtualenv`_.
On Linux, virtualenv is provided by your package manager:
.. code-block:: sh
# Debian, Ubuntu
sudo apt-get install python-virtualenv
# CentOS, Fedora
sudo yum install python-virtualenv
# Arch
sudo pacman -S python-virtualenv
If you are on Mac OS X or Windows, download `get-pip.py`_, then:
.. code-block:: sh
sudo python2 Downloads/get-pip.py
sudo python2 -m pip install virtualenv
On Windows, as an administrator:
.. code-block:: bat
\Python27\python.exe Downloads\get-pip.py
\Python27\python.exe -m pip install virtualenv
Now you can continue to :ref:`install-create-env`.
.. _virtualenv: https://virtualenv.pypa.io/en/latest/
.. _get-pip.py: https://bootstrap.pypa.io/get-pip.py
|
