File: quickstart.rst

package info (click to toggle)
python-pip 20.3.4-4%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 7,008 kB
  • sloc: python: 77,841; makefile: 60; sh: 59
file content (136 lines) | stat: -rw-r--r-- 2,933 bytes parent folder | download
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
==========
Quickstart
==========

First, :doc:`install pip <installing>`.

Install a package from `PyPI`_:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip install SomePackage
      [...]
      Successfully installed SomePackage

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip install SomePackage
      [...]
      Successfully installed SomePackage


Install a package that's already been downloaded from `PyPI`_ or
obtained from elsewhere. This is useful if the target machine does not have a
network connection:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip install SomePackage-1.0-py2.py3-none-any.whl
      [...]
      Successfully installed SomePackage

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip install SomePackage-1.0-py2.py3-none-any.whl
      [...]
      Successfully installed SomePackage

Show what files were installed:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip show --files SomePackage
      Name: SomePackage
      Version: 1.0
      Location: /my/env/lib/pythonx.x/site-packages
      Files:
      ../somepackage/__init__.py
      [...]

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip show --files SomePackage
      Name: SomePackage
      Version: 1.0
      Location: /my/env/lib/pythonx.x/site-packages
      Files:
      ../somepackage/__init__.py
      [...]

List what packages are outdated:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip list --outdated
      SomePackage (Current: 1.0 Latest: 2.0)

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip list --outdated
      SomePackage (Current: 1.0 Latest: 2.0)

Upgrade a package:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip install --upgrade SomePackage
      [...]
      Found existing installation: SomePackage 1.0
      Uninstalling SomePackage:
      Successfully uninstalled SomePackage
      Running setup.py install for SomePackage
      Successfully installed SomePackage

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip install --upgrade SomePackage
      [...]
      Found existing installation: SomePackage 1.0
      Uninstalling SomePackage:
      Successfully uninstalled SomePackage
      Running setup.py install for SomePackage
      Successfully installed SomePackage

Uninstall a package:

.. tab:: Unix/macOS

   .. code-block:: console

      $ python -m pip uninstall SomePackage
      Uninstalling SomePackage:
      /my/env/lib/pythonx.x/site-packages/somepackage
      Proceed (y/n)? y
      Successfully uninstalled SomePackage

.. tab:: Windows

   .. code-block:: console

      C:\> py -m pip uninstall SomePackage
      Uninstalling SomePackage:
         /my/env/lib/pythonx.x/site-packages/somepackage
      Proceed (y/n)? y
      Successfully uninstalled SomePackage

.. _PyPI: https://pypi.org/