Skip to main content


Project description

Build status Documentation Status




To install newslynx-sc-homepage for an active installation of newslynx-core, run the following command:

$ newslynx sc-install

To add newslynx-sc-homepage all orgnaizations, run:

$ newslynx sc-sync


If you want to modify / add Sous Chefs to newslynx-sc-homepage, do the following:

NOTE Will install a fresh version of newslynx via pip.

$ git clone
$ cd newslynx-sc-homepage
$ pip install --editable .

You should now be able to run newslynx-sc-homepage’s Sous Chefs in development mode

% newslynx sc-run newslynx_sc_homepage/say_my_name.yaml --myname='Brian Abelson'


Requires nose

$ make all_tests


Documentation for newslynx-sc-homepage is hosted on Read The Docs.

It’s generated via the following steps

  • converts this file ( into a ReStructured Text file, saving it to docs/index.rst
  • runs newslynx sc-docs newslynx_sc_homepage -f rst to generate documentation for all the Sous Chefs in newslynx-sc-homepage and saves the output to docs/sous-chefs.rst
  • Builds Sphinx Documentation from these files.

Continuous Integration

Builds for newslynx-sc-homepage can be found on Travis


See the contributing guidelines.

What’s in this module ?

    • This file
    • newslynx-sc-homepage’s source-of-truth version.
  • requirements.txt
    • newslynx-sc-homepage’s python dependencies.
    • Specifications for which files to include in the PyPI distribution.
    • See the docs on this here.
    • Specification’s for building newslynx-sc-homepage’s PyPI distribution.
  • .travis.yml
    • Configurations for Travis Continuous Integration
    • You must activate this project on for this to run on subsequent updates.
  • Makefile
    • Helpers for managing newslynx-sc-homepage.
    • Includes:
      • make clean:
        • Cleans out cruft from this directory.
      • make install:
        • Installs newslynx-sc-homepage. Assumes that you’re in a virtual environment.
      • make all_tests:
        • Runs the tests.
      • make readme
        • Converts this file to .rst, including a table of contents, and saves it to docs/index.rst
      • make sous_chef_docs
        • Programmtically generates Sous Chef documentation by running newslynx sc-docs newslynx_sc_homepage/ --format=rst > docs/sous-chefs.rst.
      • make all_docs:
        • Builds the sphinx docs for newslynx-sc-homepage by running the above two commands.
      • make view_docs
      • make register:
        • Registers newslynx-sc-homepage on PyPI.
      • make distribute:
        • Publishes a new version of newslynx-sc-homepage to PyPI.
  • newslynx_sc_homepage
    • newslynx-sc-homepage’s source code and Sous Chef configuration files.
  • docs
    • Sphnix documentation for newslynx-sc-homepage
  • tests
    • nose tests for newslynx-sc-homepage

Project details

Release history Release notifications

This version
History Node


Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page