twirp/twirp

PHP port of Twitch's Twirp RPC framework

v0.5.3 2019-08-20 08:30 UTC

This package is auto-updated.

Last update: 2020-03-20 09:53:14 UTC


README

CircleCI Twirp Version Go Report Card GolangCI GoDoc Composer Package

Installation

Download the plugin from the Releases page.

Alternatively you can use the following oneliner to install the plugin:

curl -Ls https://git.io/twirphp | bash -b path/to/bin

See the documentation for details.

Documentation

See the official documentation.

Example

To use the example and run certain test suites you need to build a Docker image from this directory:

$ docker build -t twirphp .

Tests

The following set of commands runs the complete test suite for the project:

docker run --rm -it -v $PWD:/app composer install # Optionall add "-v $COMPOSER_HOME:/tmp" to the docker command

go test -v ./protoc-gen-twirp_php/...
# OR
docker run --rm -it -v $PWD:/workspace -v $GOPATH:/go twirphp go test -v ./protoc-gen-twirp_php/...

docker run --rm -it -v $PWD:/workspace twirphp vendor/bin/phpunit -v
docker run --rm -it -v $PWD:/workspace twirphp vendor/bin/phpunit -v --group example

./gencompat.sh
# OR
docker run --rm -it -v $PWD:/workspace -v $GOPATH:/go twirphp ./gencompat.sh

docker run --rm -it -v $PWD:/workspace twirphp clientcompat -client clientcompat/compat.sh

Security

If you discover any security related issues, please contact us at mark.sagikazar+twirphp@gmail.com.

License

The MIT License (MIT). Please see License File for more information.

The original Twirp library is licensed under the Apache 2.0 License.