Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

Financial-Times/basic-tme-transformer

Repository files navigation

basic-tme-transformer

CircleCI Go Report Card Coverage Status

Introduction

The Basic TME Transformer generates UPP representations of TME concepts for a set of taxonomies: Alphaville Series, Brands, Genres, Locations, People, Sections, Special Reports, Subjects, Topics .

Installation

Download the source code, dependencies and test dependencies:

    curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
    go get -u github.com/Financial-Times/basic-tme-transformer
    cd $GOPATH/src/github.com/Financial-Times/basic-tme-transformer
    dep ensure -v -vendor-only

Running locally

  1. Run the tests and install the binary:

     curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
     cd $GOPATH/src/github.com/Financial-Times/basic-tme-transformer
     go test -race ./...
     go install
    
  2. Run the binary (using the help flag to see the available optional arguments):

     $GOPATH/bin/basic-tme-transformer [--help]
    
  3. Test:

    1. Either using curl:

       curl http://localhost:8080/transformers/topics/__ids | json_pp
      
    2. Or using httpie:

       http GET http://localhost:8080/transformers/topics/__ids
      

Build and deployment

How can I build and deploy it (lots of this will be links out as the steps will be common)

e.g.

Endpoints

For Swagger style documentation, see here.

Healthchecks

The standard admin endpoints are supported:

  • /__health - Checks whether all taxonomies have their data loaded.
  • /__gtg - Checks whether all taxonomies have their data loaded.
  • /__build-info