keboola/syrup

This package is abandoned and no longer maintained. No replacement package was suggested.

Syrup

11.6.1 2021-07-29 11:21 UTC

Requires

• php: ~5.6|^7.0
• aws/aws-sdk-php: ^3.178.1
• doctrine/doctrine-bundle: ^1.10.3
• doctrine/doctrine-migrations-bundle: ^1.3.2
• doctrine/orm: ^2.5.14
• elasticsearch/elasticsearch: ~1.4.1
• keboola/csv: ~1.1
• keboola/debug-log-uploader: ^1.1.0
• keboola/object-encryptor: ^0.3
• keboola/php-temp: ^1.0
• keboola/php-utils: ^2.3.1
• keboola/storage-api-client: ^10.14|^11.0|^12.2
• sensio/distribution-bundle: ^4.0.42
• sensio/framework-extra-bundle: ~3.0.29
• sensio/generator-bundle: ^2.5.3
• symfony/assetic-bundle: ^2.8.2
• symfony/monolog-bundle: ^2.12.1
• symfony/swiftmailer-bundle: ^2.6.7
• symfony/symfony: ^2.8.52

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• phpunit/phpunit: ^5.7.27
• squizlabs/php_codesniffer: 2.9.2
• symfony/var-dumper: ^2.8.52

MIT

• Miroslav Čillík
• Jakub Matějka

README

Syrup is a framework for rapid development of Keboola Connection components (i.e. extractors). It is based on Symfony2 framework.

Development

Note: Elastic & MySQL non-persistent

• Clone from GitHub

git clone https://github.com/keboola/syrup.git

• Set up Docker Compose

docker-compose build

• Create .env file with this content

SYRUP_APP_NAME=syrup-devel
DATABASE_HOST=mysql
DATABASE_USER=syrup
DATABASE_PASSWORD=syrup
DATABASE_NAME=syrup
DATABASE_PORT=3306
ELASTICSEARCH_HOST=elastic:9200
AWS_S3_BUCKET_LOGS_PATH=/debug-files
SAPI_URL=https://connection.keboola.com/

SAPI_TOKEN=

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
AWS_S3_BUCKET=
AWS_SQS_DEFAULT_QUEUE=
AWS_SQS_TEST_QUEUE_NAME=

• Create AWS resources from aws-services.json and fill AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_S3_BUCKET, AWS_SQS_DEFAULT_QUEUE and AWS_SQS_TEST_QUEUE_NAME in .env
• Insert a Storage API token into SAPI_TOKEN
• Run elasticsearch and mysql

docker-compose up elastic mysql

• Run tests

docker-compose run --rm tests

License

MIT licensed, see LICENSE file.