travis-img example-sous-chef

An example Sous Chef module generated by newslynx sc-create

Installation

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

Tests

Requires nose

$ nosetests

Documenation

Documentation for example-sous-chef 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 example_sous_chef -f rst to generate documentation for all the Sous Chefs in example-sous-chef and saves the output to docs/sous-chefs.rst
  • Builds Sphinx Documentaiton from these files.

Continuous Integration

Builds for example-sous-chef can be found on Travis

Contributing

See the contributing guidelines.

What’s in this module ?

  • README.md
    • This file
  • VERSION
    • example-sous-chef‘s source-of-truth version.
  • requirements.txt
    • example-sous-chef‘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 example-sous-chef‘s PyPI dsitribution.
  • .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 example-sous-chef.
    • Includes:
      • make clean:
        • Cleans out cruft from this directory.
      • make install:
        • Installs example-sous-chef. 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 example_sous_chef/ --format=rst > docs/sous-chefs.rst.
      • make all_docs:
        • Builds the sphinx docs for example-sous-chef by running the above two commands.
      • make view_docs
      • make register:
        • Registers example-sous-chef on PyPI.
      • make distribute:
        • Publishes a new version of example-sous-chef to PyPI.
  • CONTRIBUTING.md
  • example_sous_chef
    • example-sous-chef‘s source code and Sous Chef configuration files.
  • docs
    • Sphnix documentation for example-sous-chef
  • tests
    • nose tests for example-sous-chef