Build status Documentation Status

sc-example

An example Sous Chef module generated by newslynx sc-create

Installation

Production

To install sc-example for an active installation of newslynx-core, clone it and copy into ~/.newslynx/sous-chefs

$ git clone https://github.com/newslynx/sc-example.git
$ mv sc-example/ ~/.newslynx/sous-chefs/

Now install it within the same virtual environment as newslynx:

$ cd ~/.newslynx/sous-chefs/sc-example/
$ pip install .

... and if you’re running newslynx as sudo

$ cd ~/.newslynx/sous-chefs/sc-example/
$ sudo pip install .

Finally, run newslynx sc-sync to sc-example‘s Sous Chefs for all organizations.

$ newslynx sc-sync

Development

If you want to modify / add Sous Chefs to sc-example, instal it in it’s own virtual environment.

NOTE Will install a fresh version of newslynx via pip.

$ mkvirtualenv sc-example
$ git clone https://github.com/newslynx/sc-example.git
$ cd sc-example
$ pip install --editable .

You should now be able to run sc-example‘s Sous Chefs in development mode

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

Tests

Requires nose

$ make all_tests

Documentation

Documentation for sc-example is hosted on Read The Docs.

It’s generated via the following steps

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

Continuous Integration

Builds for sc-example can be found on Travis

Contributing

See the contributing guidelines.

What’s in this module ?

  • README.md
    • This file
  • VERSION
    • sc-example‘s source-of-truth version.
  • requirements.txt
    • sc-example‘s python dependencies.
  • MANIFEST.in
    • Specifications for which files to include in the PyPI distribution.
    • See the docs on this here.
  • setup.py
    • Specification’s for building sc-example‘s PyPI distribution.
  • .travis.yml
    • Configurations for Travis Continuous Integration
    • You must activate this project on travis-ci.org for this to run on subsequent updates.
  • Makefile
    • Helpers for managing sc-example.
    • Includes:
      • make clean:
        • Cleans out cruft from this directory.
      • make install:
        • Installs sc-example. 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 sc_example/ --format=rst > docs/sous-chefs.rst.
      • make all_docs:
        • Builds the sphinx docs for sc-example by running the above two commands.
      • make view_docs
      • make register:
        • Registers sc-example on PyPI.
      • make distribute:
        • Publishes a new version of sc-example to PyPI.
  • CONTRIBUTING.md
  • sc_example
    • sc-example‘s source code and Sous Chef configuration files.
  • docs
    • Sphnix documentation for sc-example
  • tests
    • nose tests for sc-example