Git Product home page Git Product logo

go-treksum's Introduction

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.

go-treksum's People

Contributors

codekoala avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

go-treksum's Issues

Retrieve quote by ID

Some quotes must be shared. There should be a way to share a specific quote by its unique ID.

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.