Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.13 KB

README.md

File metadata and controls

53 lines (37 loc) · 2.13 KB
Raw

Treksum

Travis CI Status License BSD3 Downloads Docker Pulls

Treksum provides access to the transcripts for all episodes of the following TV series:

  • Star Trek
  • Star Trek: The Next Generation
  • Star Trek: Deep Space Nine
  • Star Trek: Voyager
  • Star Trek: Enterprise

What's Included

There are currently two utilities contained in this repository:

  • treksum-scraper: scrapes Star Trek transcripts and shoves everything into a PostgreSQL database.
  • treksum-api: a simple API to serve up random quotes from a PostgreSQL database. This utility is useless without first having used treksum-scraper to populate the PostgreSQL database.

Usage

The following environment variables are used to configure both utilities:

  • TREKSUM_DBHOST: IP address for PostgreSQL service. Default: localhost
  • TREKSUM_DBPORT: Port on which PostgreSQL is listening. Default: 5432
  • TREKSUM_DBNAME: Name of PostgreSQL database where transcripts reside. Default: treksum
  • TREKSUM_DBUSER: PostgreSQL username. Default: treksum
  • TREKSUM_DBPASSWORD: PostgreSQL password. No default.

The following environment variable is used only for treksum-api:

  • TREKSUM_APIADDR: interface and port to bind when serving requests. Default: :1323

With the appropriate environment variables set, simply invoke the desired command.

Credits

The transcripts used by treksum were scraped from http://chakoteya.net/StarTrek/

Legal

Star Trek and related marks are trademarks of CBS Studios Inc. This project is purely for educational and entertainment purposes only. All other copyrights remain property of their respective owners.