README.md

newslynx-sc-facebook

Installation

Production

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

$ newslynx sc-install https://github.com/newslynx/newslynx-sc-facebook.git

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

$ newslynx sc-sync

Development

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

NOTE Will install a fresh version of newslynx via pip.

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

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

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

Tests

Requires nose

$ make all_tests

Documentation

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

Continuous Integration

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

Contributing

See the contributing guidelines.

What's in this module ?

• README.md

  • This file

• VERSION

  • newslynx-sc-facebook's source-of-truth version.

• requirements.txt

  • newslynx-sc-facebook'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 newslynx-sc-facebook'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 newslynx-sc-facebook.
  • Includes:
    • make clean:
      • Cleans out cruft from this directory.
    • make install:
      • Installs newslynx-sc-facebook. 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_facebook/ --format=rst > docs/sous-chefs.rst.
    • make all_docs:
      • Builds the sphinx docs for newslynx-sc-facebook by running the above two commands.
    • make view_docs
      • Serves documentation at localhost:8000
    • make register:
      • Registers newslynx-sc-facebook on PyPI.
    • make distribute:
      • Publishes a new version of newslynx-sc-facebook to PyPI.

• CONTRIBUTING.md

• newslynx_sc_facebook

  • newslynx-sc-facebook's source code and Sous Chef configuration files.

• docs

  • Sphnix documentation for newslynx-sc-facebook

• tests

  • nose tests for newslynx-sc-facebook