Skip to content

softwarefactory-project/podman-haskell

Repository files navigation

podman

Hackage

A client library for podman

Overview and scope

At a high level, the scope of podman-haskell is to provide a REST client for the podman API based on the swagger description. The goal is to validate the definitions and enable using the podman service in Haskell application.

For the compat API, use the docker client instead.

Features

  • JSON decoder for API endpoints.
  • HTTP client helper functions.

Contribute

Contributions are most welcome, for example the project needs help to:

  • Add missing endpoint (e.g. Pod, Image).
  • Add test case json sample.
  • Report and fix mismatchs in the upstream podman swagger documentation.
  • Higher level functions to simplify usage.

To work on this project you need a Haskell toolchain, for example on fedora:

$ sudo dnf install -y ghc cabal-install && cabal update

Then grab a copy of the swagger file:

$ curl -OL https://storage.googleapis.com/libpod-master-releases/swagger-latest.yaml

Run tests:

$ cabal build --enable-tests --enable-benchmarks --write-ghc-environment-files=always -O0 all
$ cabal test --enable-tests --test-show-details=direct -O0
$ cabal haddock

Update the types by running the podman-codegen utility.

Validate the API using the podman-quickcheck and the podman-demo utility.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages