Categorygithub.com/depscloud/api
modulepackage
0.3.3
Repository: https://github.com/depscloud/api.git
Documentation: pkg.go.dev

# README

deps.cloud API and SDK definitions

license license check

  • API - application programming interface
  • SDK - software development kit

This repository contains all API definitions and associated language SDKs available for the deps.cloud ecosystem. APIs are defined using Google's Protocol Buffers. Using gRPC, we're able to code generate client libraries. This repository currently produces 3 libraries:

TechSourcePackage
npmnodejs source@depscloud/api
pippython sourcedepscloud_api (coming soon!)
go modgithub.com/depscloud/api

Getting Started with Go

To install:

go get -u github.com/depscloud/api

Usage:

package main

import (
    "crypto/tls"

    "github.com/depscloud/api/v1alpha/extractor"
    "github.com/depscloud/api/v1alpha/tracker"

    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
)

func main() {
    target := "api.deps.cloud:443"
    creds := credentials.NewTLS(&tls.Config{})

    conn, _ := grpc.Dial(target, grpc.WithTransportCredentials(creds))
    defer conn.Close()

    sourceService := tracker.NewSourceServiceClient(conn)
    moduleService := tracker.NewModuleServiceClient(conn)
    dependencyService := tracker.NewDependencyServiceClient(conn)
}

Support

Join our mailing list to get access to virtual events and ask any questions there.

We also have a Slack channel.

Release Checks

tag npm go.mod pypi

License Checks

fossa analytics

# Packages

Code generated for package swagger by go-bindata DO NOT EDIT.
No description provided by the author
Package v1beta is a reverse proxy.

# Variables

ErrModuleNotFound occurs when a module cannot be found in the graph.
ErrPartialDeletion occurs when a partial deletion occurs during Put.
ErrPartialInsertion occurs when a partial insertion occurs during Put.
ErrUnimplemented occurs when a method has not yet been implemented.
ErrUnsupported occurs when calling a rw method on a read only service.