https://github.com/rtradeltd/txpb

TemporalX gRPC and Documentation Resources
https://github.com/rtradeltd/txpb

golang grpc ipfs ipld ipns java javascript libp2p libp2p-pubsub protocol-buffers pubsub python temporal

Last synced: 2 days ago
JSON representation

TemporalX gRPC and Documentation Resources

• Host: GitHub
• URL: https://github.com/rtradeltd/txpb
• Owner: RTradeLtd
• License: agpl-3.0
• Created: 2019-07-14T05:13:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-11T23:50:25.000Z (almost 2 years ago)
• Last Synced: 2025-01-14T12:00:43.029Z (8 days ago)
• Topics: golang, grpc, ipfs, ipld, ipns, java, javascript, libp2p, libp2p-pubsub, protocol-buffers, pubsub, python, temporal
• Language: Rust
• Homepage: https://docsx.temporal.cloud
• Size: 7.7 MB
• Stars: 14
• Watchers: 4
• Forks: 1
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 TxPB 



  Client Libraries · Documentation · Examples · FAQ · License



`TxPB` is the main source of information for using TemporalX, and includes protocol buffer definitions, generated code, and documentation. If you are looking for the protocol buffer definitions, check the `pb` folder.

We have pre-generated gRPC bindings for the following languages:

* [golang](https://github.com/RTradeLtd/TxPB/tree/master/go)

* [javascript (nodejs)](https://github.com/RTradeLtd/TxPB/tree/master/js)

* [typescript (grpc-web)](https://github.com/RTradeLtd/TxPB/tree/master/ts)

* [java](https://github.com/RTradeLtd/TxPB/tree/master/java/pb)

* [python](https://github.com/RTradeLtd/TxPB/tree/master/py)

* [rust](https://github.com/RTradeLtd/TxPB/tree/master/rs/src)

If you want bindings in other languages, feel free to open a github issue. Alternatively you can generate language bindings independently as long as the languages you are using support the appropriate protocol buffer and gRPC versions.

# Client Libraries

The following packages are client libraries that can be used to interact with TemporalX without needing to write any code, or writing less code than using gRPC directly:

* [go-temporalx-sdk](https://github.com/RTradeLtd/go-temporalx-sdk)

* [kronosx-rs rust sdk (WIP)](https://github.com/AIDXNZ/kronosx-rs)

  * Will eventually replace the rust bindings included in this repo once `kronosx-rs` is finished.

# Documentation

For all documentation please consult the [docs folder](https://docsx.temporal.cloud/doc/)

# Examples

We have an ever growing library of examples that will help you get started with TemporalX. For all code examples see the `examples` folder.

# Code Generation

Before generating the code, you'll need to download quite a few generators. Before downloading the generators you'll need to have a valid installation of the following, please consult appropriate installation manuals as required:

* Go 1.13+

* NodeJS

* NPM

* Python3

* Make

Once you have all of this installed, you can then install the needed generators which will allow you to generate the gRPC client stubs. To do this run `make install`. This has to download quite a few packages so it might take some time to complete. The only thing this doesn't install is a java generator, to do that visit https://search.maven.org/search?q=g:io.grpc%20a:protoc-gen-grpc-java and download the one for your platform.

After you've downloaded all generator tooling, you can generate the client stubs, and documentation with a single `make`.

# FAQ

In an effort to reduce the frequency of responding to commonly asked questions, we have provided an [FAQ](FAQ.md)

# License

As of release `v3.4.3` everything in the repository is licensed under [`GNU AFFERO GENERAL PUBLIC LICENSE Version 3`](./LICENSE).