Go client for the Write.as API https://developers.write.as
Rob Loranger b5ec9d7d0e Update PostParams 1 year ago
.github Add GitHub issue template 2 years ago
.gitignore Initial commit 4 years ago
LICENSE Add README and LICENSE 3 years ago
README.md style: Run goimports on everything 1 year ago
auth.go Rearrange status checks in LogIn 1 year ago
auth_test.go style: Run goimports on everything 1 year ago
collection.go adds GetCollectionPost 1 year ago
collection_test.go closes T589 update tests to use dev client 1 year ago
go.mod Support Go Modules 1 year ago
go.sum Support Go Modules 1 year ago
post.go include collection and id in postparams 1 year ago
post_test.go closes T589 update tests to use dev client 1 year ago
user.go style: Run goimports on everything 1 year ago
writeas.go `Set` User-Agent header instead of `Add`ing it 1 year ago

README.md

go-writeas

godoc

Official Write.as Go client library.

Installation

Warning: the v2 branch is under heavy development and its API will change without notice.

For a stable API, use go.code.as/writeas.v1 and upgrade to v2 once everything is merged into master.

go get go.code.as/writeas.v2

Documentation

See all functionality and usages in the API documentation.

Example usage

import "go.code.as/writeas.v2"

func main() {
	// Create the client
	c := writeas.NewClient()

	// Publish a post
	p, err := c.CreatePost(&writeas.PostParams{
		Title:   "Title!",
		Content: "This is a post.",
		Font:    "sans",
	})
	if err != nil {
		// Perhaps show err.Error()
	}

	// Save token for later, since it won't ever be returned again
	token := p.Token

	// Update a published post
	p, err = c.UpdatePost(p.ID, token, &writeas.PostParams{
		Content: "Now it's been updated!",
	})
	if err != nil {
		// handle
	}

	// Get a published post
	p, err = c.GetPost(p.ID)
	if err != nil {
		// handle
	}

	// Delete a post
	err = c.DeletePost(p.ID, token)
}

Contributing

The library covers our usage, but might not be comprehensive of the API. So we always welcome contributions and improvements from the community. Before sending pull requests, make sure you've done the following:

  • Run goimports on all updated .go files.
  • Document all exported structs and funcs.

License

MIT