Skip to content

newslynx/newslynx-sc-rss

Repository files navigation

Build status Documentation Status

newslynx-sc-rss

Installation

Production

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

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

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

$ newslynx sc-sync

Development

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

NOTE Will install a fresh version of newslynx via pip.

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

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

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

Tests

Requires nose

$ make all_tests

Documentation

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

Continuous Integration

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

Contributing

See the contributing guidelines.

What's in this module ?

  • README.md

    • This file
  • VERSION

    • newslynx-sc-rss's source-of-truth version.
  • requirements.txt

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

  • newslynx_sc_rss

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

    • Sphnix documentation for newslynx-sc-rss
  • tests

    • nose tests for newslynx-sc-rss

About

All Sous Chefs which operate on RSS Feeds

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published