kittycad / kittycad.go

The Golang API client for Zoo.

kittycad.go

The Golang API client for KittyCAD.

• Go docs
• KittyCAD API Docs

Generating

You can trigger a build with the GitHub action to generate the client. This will automatically update the client to the latest version based on the spec hosted at api.kittycad.io.

Alternatively, if you wish to generate the client locally, run:

$ make generate

Contributing

Please do not change the code directly since it is generated. PRs that change the code directly will be automatically closed by a bot.

kittycad.go's Issues

Center of mass bug

I noticed a problem with the CreateCenterOfMass function when adding a sample in KittyCAD/litterbox#52. The below code produces this error

panic: error decoding response body: json: cannot unmarshal number into Go struct field FileCenterOfMass.center_of_mass of type string

To me that seems like there might be a typing issue in the generated code?
https://github.com/KittyCAD/kittycad.go/blob/main/types.go#L1286 has

type FileCenterOfMass struct {
	// CenterOfMass: The resulting center of mass.
	CenterOfMass []string `json:"center_of_mass" yaml:"center_of_mass" schema:"center_of_mass"`
        // ...
}

Which should probably be []float64?

example code I was using 👇

package main

import (
	"fmt"
	"github.com/kittycad/kittycad.go"
	"os"
)

func main() {
	client, _ := kittycad.NewClientFromEnv("your apps user agent")

	fileBytes, _ := os.ReadFile("./ORIGINALVOXEL-3.obj")

	densitySteelGramsPerCubicMillimeter := 0.00784

	fc, err := client.File.CreateCenterOfMass(
		densitySteelGramsPerCubicMillimeter,
		"obj",
		fileBytes,
	)
	if err != nil {
		panic(err)
	}
	fmt.Print(fc)
	fmt.Println("File center of mass: ", fc.CenterOfMass)

}

Use zap or zerolog instead of logrus

They're much faster logging libraries compared to logrus.

use generics for the oneofs

use pointers for values that are not required

generate the go docs for the functions as well [KCAD-139]

json patch file issues

the json patch file generates "removes" which effs with the website

handle any ofs

handle all ofs

Websockets