summaryrefslogtreecommitdiff
path: root/contrib/python/README.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2018-06-01 09:51:32 -0700
committerAtomic Bot <atomic-devel@projectatomic.io>2018-06-01 21:19:56 +0000
commit4f5e6728b713798dd0fe4d6f3c8b52e438285190 (patch)
tree2a5a127dead51dc4b850302f7955bff17ab66769 /contrib/python/README.md
parentb6753238bcf2e996b1116c6f91e25a6688f835ea (diff)
downloadpodman-4f5e6728b713798dd0fe4d6f3c8b52e438285190.tar.gz
podman-4f5e6728b713798dd0fe4d6f3c8b52e438285190.tar.bz2
podman-4f5e6728b713798dd0fe4d6f3c8b52e438285190.zip
Provide examples for python podman API
Signed-off-by: Jhon Honce <jhonce@redhat.com> Closes: #870 Approved by: rhatdan
Diffstat (limited to 'contrib/python/README.md')
-rw-r--r--contrib/python/README.md38
1 files changed, 33 insertions, 5 deletions
diff --git a/contrib/python/README.md b/contrib/python/README.md
index 747e71559..dcf40a1a9 100644
--- a/contrib/python/README.md
+++ b/contrib/python/README.md
@@ -1,15 +1,43 @@
# podman - pythonic library for working with varlink interface to Podman
-### Status: Active Development
+## Status: Active Development
See [libpod](https://github.com/projectatomic/libpod)
+## Releases
-###
-
-To build the podman wheel:
+To build the podman egg:
```sh
cd ~/libpod/contrib/pypodman
-python3 setup.py clean -a && python3 setup.py bdist_wheel
+python3 setup.py clean -a && python3 setup.py bdist
+```
+
+## Code snippets/examples:
+
+### Show images in storage
+
+```python
+import podman
+
+with podman.Client() as client:
+ list(map(print, client.images.list()))
+```
+
+### Show containers created since midnight
+
+```python
+from datetime import datetime, time, timezone
+
+import podman
+
+midnight = datetime.combine(datetime.today(), time.min, tzinfo=timezone.utc)
+
+with podman.Client() as client:
+ for c in client.containers.list():
+ created_at = podman.datetime_parse(c.createdat)
+
+ if created_at > midnight:
+ print('Container {}: image: {} created at: {}'.format(
+ c.id[:12], c.image[:32], podman.datetime_format(created_at)))
```