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
|
Podman: Python scripting for Podman services
==============================================
.. image:: https://img.shields.io/pypi/l/podman.svg
:target: https://pypi.org/project/podman/
.. image:: https://img.shields.io/pypi/wheel/podman.svg
:target: https://pypi.org/project/podman/
.. image:: https://img.shields.io/pypi/pyversions/podman.svg
:target: https://pypi.org/project/podman/
PodmanPy is a Python3 module that allows you to write Python scripts that access resources
maintained by a Podman service. It leverages the Podman service RESTful API.
Podman services are addressed using a URL where the scheme signals to the client how to connect to
service. Supported schemes are: ``http+ssh``, ``http+unix`` or ``tcp``. Formats are the following styles:
- ``http+ssh://[<login>@]<hostname>[:<port>]/<full filesystem path>``
- ``http+ssh://alice@api.example:22/run/user/1000/podman/podman.sock``
- The scheme ``ssh`` is excepted as an alias
- ``http+unix://<full filesystem path>``
- ``http+unix:///run/podman/podman.sock``
- The scheme ``unix`` is excepted as an alias
- ``tcp://<hostname>:<port>``
- ``tcp://api.example:8888``
Example
-------
.. code-block:: python
:linenos:
import podman
with podman.PodmanClient() as client:
if client.ping():
images = client.images.list()
for image in images:
print(image.id)
.. toctree::
:caption: Podman Client
:hidden:
podman.client
.. toctree::
:caption: Podman Entities
:glob:
:hidden:
podman.domain.config
podman.domain.containers*
podman.domain.images*
podman.domain.ipam
podman.domain.events
podman.domain.manager
podman.domain.manifests
podman.domain.networks*
podman.domain.pods*
podman.domain.registry_data
podman.domain.secrets
podman.domain.system
podman.domain.volumes
podman.errors.exceptions
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
