Skip to main content

A modular toolkit for analytics.

Project description

travis-img # newslynx-core

NewsLynx Core is an expandable open-source toolkit for building modular content analytics workflows. It provides a fully RESTful API as well as a comprehensive python client and command line interface.

NewsLynx Core was built to power `newslynx-app <http://github.com/newslynx/newslynx-app>`__ but is capable of powering a diverse range of potential applications, as well, including:

  • A Mention.net-like pipeline for your personal or company blog.

  • A Flexible timeseries store for content metrics which will automatically summarize and compare your data, as well as enable the additional of custom, computed metrics.

  • A framework for configuring, scheduling, and monitoring arbitrary python jobs via API.

  • A content-extraction API.

Installation

For most applications, refer to our installation guide. If you’d like to setup a development environment, following the instructions below for MacOS X. If you’d like to spin up a Virtual Machine, check out our automation guide.

Install newslynx, prefrerably in a virtual environment.

$ git clone https://github.com/newslynx/newslynx-core.git
$ cd newslynx-core
$ python setup.py install

If you want to actively work on the codebase, install in editable mode:

$ git clone https://github.com/newslynx/newslynx-core.git
$ cd newslynx-core
$ pip install --editable .

Install the dependencies:

Install redis:

$ brew install redis

NOTE We recommend using Postgres APP. However, if you prefer the brew distribution, make sure to install it with plpythonu.

$ brew install postgresql --build-from-source --with-python

(Re)create a postgresql database

$ dropdb newslynx
$ createdb newslynx

Set your configurations

Please refer to the configuration docs

Start the redis server

Open another shell and run:

$ redis-server

Initialize the database, super user, and install built-in sous chefs.

If you’re using our default setup, use the app defaults flag:

$ newslynx init --app-defaults

Expert mode: to install the barebones system:

$ newslynx init

Start the server

  • In debug mode: newslynx debug

  • Debug mode with errors: newslynx debug --raise-errors

  • Production gunicorn server: bin/run

Start the task workers

$ bin/start_workers

Stop the task workers

$ bin/stop_workers

Start the cron daemon

$ newslynx cron

Getting Started.

Application Structure

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newslynx-1.0.5.tar.gz (222.1 kB view hashes)

Uploaded Source

Built Distribution

newslynx-1.0.5.macosx-10.10-intel.exe (409.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page