Skip to content

ErikGartner/ghostdoc-ritter

Repository files navigation

Ritter

Codeship Status for ErikGartner/ghostdoc-ritter Build Status

Ritter is the data processing engine for ghostdoc.

Ghostdoc is a semi-automatic self-generating wiki written in Meteor. To allow for more advanced data processing and NLP it is powered by this module, Ritter.

Features

Sources:

  • Table of content
  • Language detection
  • Linkifying artifacts

Artifacts:

  • Table of content
  • Gender detection (from artifact name)
  • Extraction of relevant paragraphs
  • Extraction of user defined gems (facts about artifact)
  • Centrality of artifacts
  • Community detection of artifacts
  • Friend score between artifacts
  • Find Trello cards mentioning artifacts

Installation

This project is optimized for running on Dokku but can run elsewhere as well. Ritter requires Python >= 3.4, a Mongo database and a RabbitMQ broker. Running multiple instances for the same Ghostdoc instance is possible and preferred.

Dependencies can be installed using pip or setuptools.

The following environment variables should be set and should be same as the ones set for Ghostdoc.

MONGO_URL
RABBITMQ_URL

# optionals
RITTER_TRELLO_KEY

About

Ritter is the new data processing engine for Ghostdoc.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages