Improving documentation with examples

[inknos]

Hey folks,

This morning I got some feedback from the community that the repository examples directory is quite empty. I couldn't agree more.

I would like to have some examples written down about how to use the library, but before committing to it, I would like to take the chance to ask what could be critical things to be added in the examples.

My idea is to have examples to cover:

• images
  • pull
  • build
  • push
• networks
  • create new
  • attach container to network
• volumes
  • create, remove
• building images
  • Containerfile manipulation
• pods
  • creating and removing pods
  • attaching container to pods
  • checking pod status
• quadlets
  • create, remove, restart containers via quadlets

If I don't receive feedback I'll convert this discussion to issues to improve the repo.

Thanks

[ptoscano]

On top of what @inknos wrote (which is good), it'd be nice also if there were examples mapping common workflows of the podman CLI into Python code. This way, when you are already familiar with the CLI and you need to write something in Python, you can make more use of podman-py rather than resorting to invoke the CLI.