activity

module

v0.1.2 Latest Latest Go to latest Published: Nov 16, 2018 License: BSD-3-Clause

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/writeas/activity

Links

Open Source Insights

README ¶

activity

go get github.com/go-fed/activity

This repository supports vgo and is remotely verifiable.

This repository contains three libraries for use in your golang applications:

vocab: An ActivityStreams Vocabulary library
streams: A convenience library for the ActivityStreams Vocabulary
pub: ActivityPub SocialAPI (Client-to-Server) and FederateAPI (Server-to-Server)

This library is biased. It forgoes understanding JSON-LD in exchange for static typing. It provides a large amount of default behavior to let Social, Federated, or both kinds of ActivityPub applications just work.

Status

0.1.1 (Semantic Versioning)

There is no official implementation report available... yet!

Unofficial implementation reports are available in issue #46.

Please see CHANGELOG for changes between versions.

Getting Started

See each subdirectory for its own README for further elaboration. The recommended reading order is vocab, streams, and then pub. Others are optional.

How can I get help, file issues, or contribute?

Please see the CONTRIBUTING.md file!

How well tested are these libraries?

I took great care to add numerous tests using examples directly from specifications, official test repositories, and my own end-to-end tests.

Who is using this library currently?

No one. Please let me know if you are using it!

How do I use these libraries?

Please see each subdirectory for its own README for further elaboration. The recommended reading order is vocab, streams, and then pub. Others are optional.

Passing familiarity with ActivityStreams and ActivityPub is recommended.

Other Libraries

tools - Code generation wizardry and ActivityPub-spec-as-data.
deliverer - Provides an asynchronous Deliverer for use with the pub lib

FAQ

Please see the CONTRIBUTING.md file!

Useful References

Thanks

I would like to thank those that have worked hard to create the technologies and standards that created the opportunity to implement this suite of libraries.

Directories ¶

Path	Synopsis
deliverer
pub Package pub provides generic support for the ActivityPub Social API and Federation Protocol for client-to-server and server-to-server interactions.	Package pub provides generic support for the ActivityPub Social API and Federation Protocol for client-to-server and server-to-server interactions.
streams Package streams is a convenience wrapper around the raw ActivityStream vocabulary.	Package streams is a convenience wrapper around the raw ActivityStream vocabulary.
tools
defs
streams
streams/gen Package gen contains the libraries and algorithms used to generate the code for the activitystreams package.	Package gen contains the libraries and algorithms used to generate the code for the activitystreams package.
vocab
vocab/gen Package gen contains the libraries and algorithms used to generate the code for the vocab package.	Package gen contains the libraries and algorithms used to generate the code for the vocab package.
vocab Package vocab provides an implementation of serializing and deserializing activity streams into native golang structs without relying on reflection.	Package vocab provides an implementation of serializing and deserializing activity streams into native golang structs without relying on reflection.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL