Package: newslynx
# newslynx-coreNewsLynx Core is an expandable open-source toolkit for building modular
content analytics workflows. It provides a fully RESTful API as well as
a comprehensivepythonclient 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 arbitrarypythonjobs via API.A content-extraction API.InstallationFor most applications, refer to ourinstallation
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 ourautomation
guide.DependenciesPostgresNOTEWe recommend usingPostgres APP.
However, if you prefer thebrewdistribution, make sure to install
it with plpythonu.$ brew install postgresql --build-from-source --with-python(Re)create apostgresqldatabase# If you already have a database called `newslynx`, delete it first$dropdbnewslynx$createdbnewslynxRedisInstallredis:$brewinstallredisOpen another tab in your shell and run:$ redis-serverInstallation / InitializationNOTEwe recommend that you installnewslynxin avirtual
environment.First clone this repository and move into it’s root directory$gitclonehttps://github.com/newslynx/newslynx-core.git$cdnewslynx-coreOPTIONALSet yourconfiguration.
If you don’t do this, we will fallback on theapp’s default
configuration file.Initialize the database, super user, and install default sous chefs, tags, and recipes.Run this command when working withnewslynx-app$makeapp_installInitialize a bare install.[Expert mode]don’t install the app’s default sous chefs, tags, or
recipes.$ make bare_installStart the serverIn debug mode:newslynx debugDebug mode with errors:newslynx debug--raise-errorsProductiongunicornserver:bin/runStart the task workers$ bin/start_workersStop the task workers$ bin/stop_workersStart the cron daemon$ newslynx cronTestingnewslynxis a complicated applcation, to simplify testing…MakefileThis repository contains aMakefilewhich provides access to the
following commands:make cleanclean out cruft generated bypip.make clean_scclean out cruft generated bypipin~/.newslynx/sous-chefsmake installinstallsnewslynxwill first uninstallnewslynxif a version already exists.make app_installInstallsnewslynx, initializes the Super User, and adds the
Recipes, Tags, and Sous Chefs needed to runnewslynx-appmake bare_installInstallsnewslynxand initializes the Super Usermake test_installremoves all files under~/.newslynxrunsmake app_installrunspip install-rtest-requirements.txtdistributecreates a new version ofnewslynxon PyPIDocsConfigurationFirst
stepsUnderstanding Sous
ChefsUnderstanding
RecipesUnderstanding
MetricsUnderstanding
TagsUnderstanding
ContentUnderstanding
EventsFull API
ReferenceCommand Line
InterfaceWrite your own Sous
ChefApplication StructureLicenseThis work is licensed under a Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International License.