Categorygithub.com/berrybytes/dockerhub-go
modulepackage
1.0.3
Repository: https://github.com/berrybytes/dockerhub-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
1
Files
581 SLOC

# README

dockerhub-go Build Status GoDoc

A Dockerhub client for Go

Usage

import "github.com/charliekenney23/dockerhub-go"

Construct a new DockerHub client, then use various services on the client to access different parts of the DockerHub API.

client := dockerhub.NewClient(nil)

// login to Dockerhub
err := client.Auth.Login(context.Background(), "username", "password")

// or set an auth token directly
client.SetAuthToken(os.Getenv("DOCKERHUB_API_TOKEN"))

License

MIT © 2019 Charles Kenney

# Packages

No description provided by the author

# Functions

NewClient returns a new Dockerhub client.
String returns a pointer to a string for configuration.
StringValue returns the value of a String pointer.

# Structs

A Client manages communication with the Dockerhub API.
CreateOrganizationRequest struct.
No description provided by the author
ListOptions specifies the optional parameters to various List methods that support pagination.
LoginRequest represents the payload to be sent to login to the Dockerhub API.
LoginResponse represents the payload to be responded to a successful Dockerhub API login request.
Organization struct.
OrganizationList Struct.
Repository represents a Dockerhub repository.
RepositoryList represents a list of repositories with pagination details.
RepositoryPatch represents payload to patch a Repository.
RepositoryPermissions specifies the permissions of the requesting user to the given Repository.
RepositoryPrivacyPatch represents payload to patch a Repository's privacy mode.
Tags response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

AuthService handles communication with the auth related methods of the Dockerhub API.
OrganizationService Type Service.
RepositoriesService handles communication with the repository related methods of the Dockerhub API.
TagService Type.
No description provided by the author
No description provided by the author