Code Monkey home page Code Monkey logo

lionel's Introduction

Command Lionel

๐Ÿ—ž The latest news from the Financial Times in your terminal.

Animation showing usage of Lionel

Features

  • View the latest curated content from the top sections of FT.com
  • Re-formats XML content into plain text for the terminal
  • Supports the display of lists, headings, and quotes
  • Works with a single key for the FT API

Installation

This is a Node.js module available through the npm registry. Node.js 8 or newer is required. If you are unsure what Node.js version is installed you can check using this command:

node --version

If Node.js is not installed or you do not have a supported versioned installed you should follow these instructions, otherwise you can continue with the installation:

npm install -g lionel

Once complete you can verify the installation by running the Lionel command:

lionel

The command will exit with the following error:

> Oh no, something went wrong: Error: No API key found

This is expected because Lionel requires a key for the FT API in order to access content. To acquire a key you should use the /get-developer-apikey Slack command and select the "C-API v2 - Internal Apps" policy.

Once you have a key for the FT API you can provide it to the Lionel command in one of two ways:

  1. Set the key as an environment variable named API_KEY:

    export API_KEY='your API key'
  2. Create a dotfile containing the key in your home directory named .ft-api-key:

    echo 'your API key' > ~/.ft-api-key

After configuring a key run the Lionel command again which should now render a list of sections to choose from:

lionel

If you receive a 403 error please check your key permissions with the Universal Publishing team.

lionel's People

Contributors

i-like-robots avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

lionel's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.