summaryrefslogtreecommitdiff
path: root/docs/html/cli/pip_list.rst
blob: 5119a804c0da68d2f3f0b88dd616ec9fd1902800 (plain)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
.. _`pip list`:

========
pip list
========



Usage
=====

.. tab:: Unix/macOS

   .. pip-command-usage:: list "python -m pip"

.. tab:: Windows

   .. pip-command-usage:: list "py -m pip"


Description
===========

.. pip-command-description:: list


Options
=======

.. pip-command-options:: list

.. pip-index-options:: list


Examples
========

#. List installed packages.

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list
         docutils (0.10)
         Jinja2 (2.7.2)
         MarkupSafe (0.18)
         Pygments (1.6)
         Sphinx (1.2.1)

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list
         docutils (0.10)
         Jinja2 (2.7.2)
         MarkupSafe (0.18)
         Pygments (1.6)
         Sphinx (1.2.1)

#. List outdated packages (excluding editables), and the latest version available.

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --outdated
         docutils (Current: 0.10 Latest: 0.11)
         Sphinx (Current: 1.2.1 Latest: 1.2.2)

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --outdated
         docutils (Current: 0.10 Latest: 0.11)
         Sphinx (Current: 1.2.1 Latest: 1.2.2)

#. List installed packages with column formatting.

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --format columns
         Package Version
         ------- -------
         docopt  0.6.2
         idlex   1.13
         jedi    0.9.0

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --format columns
         Package Version
         ------- -------
         docopt  0.6.2
         idlex   1.13
         jedi    0.9.0

#. List outdated packages with column formatting.

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list -o --format columns
         Package    Version Latest Type
         ---------- ------- ------ -----
         retry      0.8.1   0.9.1  wheel
         setuptools 20.6.7  21.0.0 wheel

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list -o --format columns
         Package    Version Latest Type
         ---------- ------- ------ -----
         retry      0.8.1   0.9.1  wheel
         setuptools 20.6.7  21.0.0 wheel

#. List packages that are not dependencies of other packages. Can be combined with
   other options.

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --outdated --not-required
         docutils (Current: 0.10 Latest: 0.11)

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --outdated --not-required
         docutils (Current: 0.10 Latest: 0.11)

#. Use legacy formatting

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --format=legacy
         colorama (0.3.7)
         docopt (0.6.2)
         idlex (1.13)
         jedi (0.9.0)

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --format=legacy
         colorama (0.3.7)
         docopt (0.6.2)
         idlex (1.13)
         jedi (0.9.0)

#. Use json formatting

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --format=json
         [{'name': 'colorama', 'version': '0.3.7'}, {'name': 'docopt', 'version': '0.6.2'}, ...

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --format=json
         [{'name': 'colorama', 'version': '0.3.7'}, {'name': 'docopt', 'version': '0.6.2'}, ...

#. Use freeze formatting

   .. tab:: Unix/macOS

      .. code-block:: console

         $ python -m pip list --format=freeze
         colorama==0.3.7
         docopt==0.6.2
         idlex==1.13
         jedi==0.9.0

   .. tab:: Windows

      .. code-block:: console

         C:\> py -m pip list --format=freeze
         colorama==0.3.7
         docopt==0.6.2
         idlex==1.13
         jedi==0.9.0