Metadata-Version: 2.1
Name: podman
Version: 0.0.0
Summary: A library to interact with a Podman server
Home-page: https://github.com/containers/python-podman
Author: Jhon Honce
Author-email: jhonce@redhat.com
License: Apache Software License
Project-URL: Bug Tracker, https://github.com/containers/python-podman/issues
Project-URL: Source Code, https://github.com/containers/python-podman
Keywords: varlink, libpod, podman
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: devel
Provides-Extra: test
License-File: LICENSE
License-File: AUTHORS

# podman - pythonic library for working with varlink interface to Podman

[![Build Status](https://travis-ci.org/containers/python-podman.svg?branch=master)](https://travis-ci.org/containers/python-podman)
![PyPI](https://img.shields.io/pypi/v/podman.svg)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/podman.svg)
![PyPI - Status](https://img.shields.io/pypi/status/podman.svg)

## Status: Active Development

See [libpod](https://github.com/containers/libpod)

## Overview

Python podman library.

Provide a stable API to call into.

**Notice:** The varlink interface to Podman is currently deprecated and in maintenance mode.  When Podman version 2.0 is released in 2020, it will include a fully supported REST API that will replace the varlink interface.  The varlink interface will be removed from Podman at a later release.  Starting with Podman v1.8.0, the REST API is available for test usage.  The documentation for the REST API resides [here](http://docs.podman.io/en/latest/_static/api.html#operation/changesContainer).

## Releases

### Requirements

* Python 3.5+
  * See [How to install Python 3 on Red Hat Enterprise Linux](https://developers.redhat.com/blog/2018/08/13/install-python3-rhel/) if your installed version of Python is too old.
* OpenSSH 6.7+
* Python dependencies in requirements.txt

### Install

#### From pypi

Install `python-podman` to the standard location for third-party
Python modules:

```sh
python3 -m pip install podman
```

To use this method on Unix/Linux system you need to have permission to write
to the standard third-party module directory.

Else, you can install the latest version of python-podman published on
pypi to the Python user install directory for your platform.
Typically ~/.local/. ([See the Python documentation for site.USER_BASE for full
details.](https://pip.pypa.io/en/stable/user_guide/#user-installs))
You can install like this by using the `--user` option:

```sh
python3 -m pip install --user podman
```

This method can be useful in many situations, for example,
on a Unix system you might not have permission to write to the
standard third-party module directory. Or you might wish to try out a module
before making it a standard part of your local Python installation.
This is especially true when upgrading a distribution already present: you want
to make sure your existing base of scripts still works with the new version
before actually upgrading.

For further reading about how python installation works [you can read
this documentation](https://docs.python.org/3/install/index.html#how-installation-works).

#### By building from source

To build the podman egg and install as user:

```sh
cd ~/python-podman
python3 setup.py clean -a && python3 setup.py sdist bdist
python3 setup.py install --user
```

## 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)))
```

CHANGES
=======

* Fix pypi deployment by using documentation at markdown format

v0.0.2
------

* Fix up pushing to pypi

v0.0.1
------

* Pull image function throws KeyError for id
* Secure Travis
* Introduce travis-ci and autodeployments on tags
* Improve packaging by using PBR
* Add base requirements to README.md
* Remove pypodman to python-pypodman repo
* Update module to align with varlink API changes
* Use GetVersion instead of Ping, as recommended
* Improve README
* pypodman: add options to handle ssh host keys
* Update README.md
* add missing bits
* Initial copy from containers/libpod
* Initial commit

Anders F Björklund <anders.f.bjorklund@gmail.com>
Brent Baude <bbaude@redhat.com>
Daniel J Walsh <dwalsh@redhat.com>
Dhanisha Phadate <phadate.d@husky.neu.edu>
Hervé Beraud <hberaud@redhat.com>
Jhon Honce <jhonce@redhat.com>
Jhon Honce <jwhonce@gmail.com>



