2017 © Pedro Peláez
 

project syrup

Syrup

image

keboola/syrup

Syrup

  • Wednesday, June 20, 2018
  • by Keboola
  • Repository
  • 8 Watchers
  • 0 Stars
  • 26,028 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 1 Forks
  • 18 Open issues
  • 100 Versions
  • 2 % Grown

The README.md

Syrup

Build Status Code Climate Test Coverage, (*1)

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

Development

Note: Elastic & MySQL non-persistent, (*3)

  • 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., (*4)

The Versions