https://github.com/docker/go-docker

(Still WIP) Official Go SDK for Docker
https://github.com/docker/go-docker

Last synced: about 2 months ago
JSON representation

(Still WIP) Official Go SDK for Docker

• Host: GitHub
• URL: https://github.com/docker/go-docker
• Owner: docker
• Archived: true
• Created: 2017-08-30T20:49:10.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-25T12:36:29.000Z (about 3 years ago)
• Last Synced: 2024-09-18T13:49:26.288Z (about 2 months ago)
• Language: Go
• Homepage:
• Size: 233 KB
• Stars: 189
• Watchers: 13
• Forks: 41
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docker.io/go-docker

Official Go SDK for Docker

## Dependency management tool is required

This repository describes its dependencies in a `Gopkg.toml` file as created by the [`dep`](https://github.com/golang/dep#setup) tool.

It also uses semantic versioning, and requires its users to use `dep`-compatible dependency management tools to ensure stability and avoid breaking changes.

The canonical import path is `docker.io/go-docker`.

Note: you may download it with `go get -d docker.io/go-docker`, but if you omit `-d`, you may have compile errors. Hence the `dep` approach is preferred.

### How to use `dep` in your project

You can use any tool that is compatible, but in the examples below we are using `dep`.

#### Adding dependency to `vendor/`

```bash

$ cd $GOPATH/src/myproject

$ dep init 					# only if first time use

$ dep ensure -add docker.io/go-docker@v1    	# to use the latest version of v1.x.y

```

#### Updating dependency

```bash

$ cd $GOPATH/src/myproject

$ edit Gopkg.toml

$ dep ensure

```

## Reference Documentation

[godoc.org/docker.io/go-docker](https://godoc.org/docker.io/go-docker)

## Issues

Feel free to open issues on the Github issue tracker.

## Migrating from `github.com/docker/docker/client`

If you were previously depending on `github.com/docker/docker/client`, you can run the following in bash

to start using `docker.io/go-docker` v1 and benefiting from semantic versioning guarantees.

```bash

files=( $(find . -name '*.go' -not -path './vendor/*') )

for rule in \

    's|"github.com/docker/docker/api|"docker.io/go-docker/api|' \

    's|^([[:space:]]+)"github.com/docker/docker/client|\1client "docker.io/go-docker|' \

    's|"github.com/docker/docker/client|"docker.io/go-docker|' \

; do

    sed -i -E "$rule" ${files[*]}

done

```

Note that if you aliased any import they will be preserved.