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.
Dependencies
Postgres
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
# If you already have a database called `newslynx`, delete it first
$ dropdb newslynx
$ createdb newslynxRedis
Install redis:
$ brew install redisOpen another tab in your shell and run:
$ redis-server
Installation / Initialization
NOTE we recommend that you install newslynx in a virtual environment.
First clone this repository and move into it’s root directory
$ git clone https://github.com/newslynx/newslynx-core.git
$ cd newslynx-coreOPTIONAL Set your configuration. If you don’t do this, we will fallback on the app’s default configuration file.
Initialize a bare install.
[Expert mode] don’t install the app’s default sous chefs, tags, or recipes.
$ make bare_install
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
Testing
newslynx is a complicated applcation, to simplify testing…
Makefile
This repository contains a Makefile which provides access to the following commands:
make clean
clean out cruft generated by pip.
make clean_sc
clean out cruft generated by pip in ~/.newslynx/sous-chefs
make install
installs newslynx
will first uninstall newslynx if a version already exists.
make app_install
Installs newslynx, initializes the Super User, and adds the Recipes, Tags, and Sous Chefs needed to run newslynx-app
make bare_install
Installs newslynx and initializes the Super User
make test_install
removes all files under ~/.newslynx
runs make app_install
runs pip install -r test-requirements.txt
distribute
creates a new version of newslynx on PyPI
Docs
Application Structure
License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
1 maintainer
Metadata
1 maintainer
Release files for newslynx 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| newslynx-1.2.2.tar.gz | 228.2 kB | Without provenance | Details for newslynx-1.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| newslynx-1.2.2.macosx-10.10-intel.exe | Details for newslynx-1.2.2.macosx-10.10-intel.exe |
Total release size: 648.4 kB
Release files / newslynx-1.2.2.tar.gz
| Download URL | newslynx-1.2.2.tar.gz |
|---|---|
| Size | 228.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9ea46dc5637b3bd11370a679569796cbf8b1642463d694058b51e3c434832365
|
|
BLAKE2b-256 checksum How to use checksums |
db34237db4ef03edd879126a01f476e5eb002f02f7735d7602bdf0951b891e7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / newslynx-1.2.2.macosx-10.10-intel.exe
| Download URL | newslynx-1.2.2.macosx-10.10-intel.exe |
|---|---|
| Size | 420.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24976b719a1c3746f0a2e2cc7936b8fccc63f2592e2dfb57fc59ff30f1a07e16
|
|
BLAKE2b-256 checksum How to use checksums |
33a5a9b3e6852be9f942db5a5368c98e89ab399b7341ab8cdef4cba1737fdc5e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for newslynx 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
