This module contains all Sous Chefs which operate on RSS Feeds
Project description
This module contains all Sous Chefs which operate on RSS Feeds
Installation
Via pip
$ pip install newslynx-sc-rss
From source
$ mkvirtualenv newslynx-sc-rss
$ git clone https://github.com/newslynx/newslynx-sc-rss.git
$ cd newslynx-sc-rss
$ pip install .
Tests
Requires nose
$ nosetests
Documenation
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 Documentaiton 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 ?
-
This file
-
newslynx-sc-rss’s source-of-truth version.
-
newslynx-sc-rss’s python dependencies.
-
Specifications for which files to include in the PyPI distribution.
See the docs on this here.
-
Specification’s for building newslynx-sc-rss’s PyPI dsitribution.
-
Configurations for Travis Continuous Integration
You must activate this project on travis-ci.org for this to run on subsequent updates.
-
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 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
Serves documentation at localhost:8000
make register:
Registers newslynx-sc-rss on PyPI.
make distribute:
Publishes a new version of newslynx-sc-rss to PyPI.
-
newslynx-sc-rss’s source code and Sous Chef configuration files.
-
Sphnix documentation for newslynx-sc-rss
-
nose tests for newslynx-sc-rss
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for newslynx-sc-rss-0.0.2.macosx-10.10-intel.exe
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb19b57a61c7f594cd7f6d2b9687cc6ac0ea3c56279e1c7ee81d81e984bd1765 |
|
MD5 | 08c69fa01bf6b0393bba42eb6809129b |
|
BLAKE2b-256 | f2afcde2be6b14599d5e17684355f53a9b4498e82688caeecd6e70b69f89ef45 |