newslynx-sc-example 0.0.1
An example Sous Chef module generated by
License: MIT

|travis-img| newslynx-sc-example
==========================================================================================

An example Sous Chef module generated by

Installation
------------

Via pip
~~~~~~~

.. code:: bash

    $ pip install newslynx-sc-example

From source
~~~~~~~~~~~

.. code:: bash

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

Tests
-----

Requires ``nose``

.. code:: bash

    $ nosetests

Documenation
------------

Documentation for ``newslynx-sc-example`` is hosted on `Read The
Docs <http://newslynx-sc-example.readthedocs.org/>`__.

It's generated via the following steps

-  converts this file (``README.md``) into a ReStructured Text file,
   saving it to
   `docs/index.rst <https://github.com/newslynx/newslynx-sc-example/blob/master/docs/index.rst>`__
-  runs ``newslynx sc-docs newslynx_sc_example -f rst`` to generate
   documentation for all the Sous Chefs in ``newslynx-sc-example`` and
   saves the output to
   `docs/sous-chefs.rst <https://github.com/newslynx/newslynx-sc-example/blob/master/docs/sous-chefs.rst>`__
-  Builds Sphinx Documentaiton from these files.

Continuous Integration
----------------------

Builds for ``newslynx-sc-example`` can be found on
`Travis <https://travis-ci.org/newslynx/newslynx-sc-example>`__

Contributing
------------

See the `contributing
guidelines <https://github.com/newslynx/newslynx-sc-example/blob/master/CONTRIBUTING.md>`__.

What's in this module ?
-----------------------

-  `README.md <https://github.com/newslynx/newslynx-sc-example/blob/master/README.md>`__

   -  This file

-  `VERSION <https://github.com/newslynx/newslynx-sc-example/blob/master/VERSION>`__

   -  ``newslynx-sc-example``'s source-of-truth version.

-  `requirements.txt <https://github.com/newslynx/newslynx-sc-example/blob/master/requirements.txt>`__

   -  ``newslynx-sc-example``'s python dependencies.

-  `MANIFEST.in <https://github.com/newslynx/newslynx-sc-example/blob/master/MANIFEST.in>`__

   -  Specifications for which files to include in the PyPI
      distribution.
   -  See the docs on this
      `here <https://docs.python.org/2/distutils/sourcedist.html#specifying-the-files-to-distribute>`__.

-  `setup.py <https://github.com/newslynx/newslynx-sc-example/blob/master/setup.py>`__

   -  Specification's for building ``newslynx-sc-example``'s PyPI
      dsitribution.

-  `.travis.yml <https://github.com/newslynx/newslynx-sc-example/blob/master/.travis.yml>`__

   -  Configurations for Travis Continuous Integration
   -  You must activate this project on
      `travis-ci.org <https://github.com/newslynx/newslynx-sc-example/blob/master/http://travis-ci.org/>`__
      for this to run on subsequent updates.

-  `Makefile <https://github.com/newslynx/newslynx-sc-example/blob/master/Makefile>`__

   -  Helpers for managing ``newslynx-sc-example``.
   -  Includes:

      -  ``make clean``:

         -  Cleans out cruft from this directory.

      -  ``make install``:

         -  Installs ``newslynx-sc-example``. Assumes that you're in a
            virtual environment.

      -  ``make tests``:

         -  Runs the tests.

      -  ``make readme``

         -  Converts this file to ``.rst``, including a table of
            contents, and saves it to
            `docs/index.rst <https://github.com/newslynx/newslynx-sc-example/blob/master/docs/index.rst>`__

      -  ``make sous_chef_docs``

         -  Programmtically generates `Sous Chef
            documentation <https://github.com/newslynx/newslynx-sc-example/blob/master/docs/sous-chefs.rst>`__
            by running
            ``newslynx sc-docs newslynx_sc_example/ --format=rst > docs/sous-chefs.rst``.

      -  ``make all_docs``:

         -  Builds the sphinx docs for ``newslynx-sc-example`` by
            running the above two commands.

      -  ``make view_docs``

         -  Serves documentation at
            `localhost:8000 <http://localhost:8000>`__

      -  ``make register``:

         -  Registers ``newslynx-sc-example`` on
            `PyPI <https://pypi.python.org/pypi>`__.

      -  ``make distribute``:

         -  Publishes a new version of ``newslynx-sc-example`` to PyPI.

-  `CONTRIBUTING.md <https://github.com/newslynx/newslynx-sc-example/blob/master/CONTRIBUTING.md>`__

-  `newslynx\_sc\_example <https://github.com/newslynx/newslynx-sc-example/blob/master/newslynx_sc_example/>`__

   -  ``newslynx-sc-example``'s source code and Sous Chef configuration
      files.

-  `docs <https://github.com/newslynx/newslynx-sc-example/blob/master/docs/>`__

   -  Sphnix documentation for ``newslynx-sc-example``

-  `tests <https://github.com/newslynx/newslynx-sc-example/blob/master/tests/>`__

   -  ``nose`` tests for ``newslynx-sc-example``

.. |travis-img| image:: https://travis-ci.org/newslynx/newslynx-sc-example.svg