https://github.com/unstoppablemango/docker.dotnet.fsharp

Idiomatic F# support for Docker.DotNet
https://github.com/unstoppablemango/docker.dotnet.fsharp

Last synced: 1 day ago
JSON representation

Idiomatic F# support for Docker.DotNet

• Host: GitHub
• URL: https://github.com/unstoppablemango/docker.dotnet.fsharp
• Owner: UnstoppableMango
• License: mit
• Created: 2024-05-04T20:36:30.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-19T14:35:15.000Z (about 1 month ago)
• Last Synced: 2024-12-13T02:40:39.240Z (13 days ago)
• Language: F#
• Size: 79.1 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docker.DotNet.FSharp

[![Build](https://img.shields.io/github/actions/workflow/status/UnstoppableMango/Docker.DotNet.FSharp/main.yml?branch=main)](https://github.com/UnstoppableMango/Docker.DotNet.FSharp/actions)

[![Codecov](https://img.shields.io/codecov/c/github/UnstoppableMango/Docker.DotNet.FSharp)](https://app.codecov.io/gh/UnstoppableMango/Docker.DotNet.FSharp)

[![GitHub Release](https://img.shields.io/github/v/release/UnstoppableMango/Docker.DotNet.FSharp)](https://github.com/UnstoppableMango/Docker.DotNet.FSharp/releases)

[![NuGet Version](https://img.shields.io/nuget/v/UnMango.Docker.DotNet.FSharp)](https://nuget.org/packages/UnMango.Docker.DotNet.FSharp)

[![NuGet Downloads](https://img.shields.io/nuget/dt/UnMango.Docker.DotNet.FSharp)](https://nuget.org/packages/UnMango.Docker.DotNet.FSharp)

Idiomatic F# support for [Docker.DotNet](https://github.com/dotnet/Docker.DotNet).

## Install

- [NuGet](https://nuget.org/packages/UnMango.Docker.DotNet.FSharp): `dotnet add package UnMango.Docker.DotNet.FSharp`

- [GitHub Packages](https://github.com/UnstoppableMango/Docker.DotNet.FSharp/pkgs/nuget/UnMango.Docker.DotNet.FSharp): `dotnet add package UnMango.Docker.DotNet.FSharp -s github`

  - [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry#authenticating-to-github-packages)

  - [Installing from GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry#installing-a-package)

## Usage

This project is still a work in progress and nothing is guaranteed to work!

At the moment, the library supports thin bindings for `IImageOperations` and `IContainerOperations`.

```fsharp

let docker: IDockerClient // Create a client

let auth: AuthConfig // Auth stuff if required

let progress: IProgress // Callbacks

let config = ImageCreateParameters(Image = "ubuntu")

do! docker.Images |> Image.create config auth progress

```

```fsharp

let docker: IDockerClient // Create a client

let config = ContainerCreateParameters(Image = "ubuntu:latest")

let! container = docker.Containers |> Container.create config

```

You can define a very minimal computation expression to create an image.

```fsharp

let docker: IDockerClient // Create a client

image { create { fromImage "ubuntu" } }

|> Image.runAll docker.Images

```

## Q/A

### Idiomatic? This looks nothing like the F# I write!

If something looks off please open an issue! I've only recently been diving further into the F# ecosystem.

### Deprecated Operations

When I started this project there were a few deprecated operations and I chose not to implement them.

Future deprecations will be tagged and removed along with upstream.