newslynx 1.0.1

A modular toolkit for analytics.

# 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](http://newslynx.readthedocs.org/en/latest/install.html). 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](https://github.com/newslynx/automation).

##### Install newslynx, prefrerably in a virtual environment.

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

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

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

##### Install the dependencies:

Install redis:

` $ brew install redis `

NOTE We recommend using [Postgres APP](http://postgresapp.com/). 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](http://newslynx.readthedocs.org/en/latest/config.html)

##### Start the redis server

Open another shell and run:

` $ redis-server `

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

` $ newslynx init `

Include app defaults:

` $ newslynx init --app-defaults `

##### Start the server

• In debug mode: newslynx debug

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

• Production guniorn 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.

• [Configuration](http://newslynx.readthedocs.org/en/latest/config.html)

• [First steps](http://newslynx.readthedocs.org/en/latest/getting-started.html)

• [Understanding Sous Chefs](http://newslynx.readthedocs.org/en/latest/sous-chefs.html)

• [Understanding Recipes](http://newslynx.readthedocs.org/en/latest/recipes.html)

• [Understanding Metrics](http://newslynx.readthedocs.org/en/latest/metrics.html)

• [Understanding Tags](http://newslynx.readthedocs.org/en/latest/taxonomy.html)

• [Understanding Content](http://newslynx.readthedocs.org/en/latest/content-items.html)

• [Understanding Events](http://newslynx.readthedocs.org/en/latest/events.html)

• [Full API Reference](http://newslynx.readthedocs.org/en/latest/api.html)

• [Command Line Interface](http://newslynx.readthedocs.org/en/latest/cli.html)

• [Write your own Sous Chef](http://newslynx.readthedocs.org/en/latest/writing-sous-chefs.html)

## Application Structure

## License

<a rel=”license” href=”http://creativecommons.org/licenses/by-nc-sa/4.0/”><img alt=”Creative Commons License” style=”border-width:0” src=”https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png” /></a><br />This work is licensed under a <a rel=”license” href=”http://creativecommons.org/licenses/by-nc-sa/4.0/”>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.