Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

This module contains all Sous Chefs which deal with RSS extraction.

Project description

Build status Documentation Status

newslynx-sc-rss

This module contains all Sous Chefs which deal with RSS extraction.

Installation

$ 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 ?

  • 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 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 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

Project details


Release history Release notifications

This version
History Node

0.0.5

History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
newslynx-sc-rss-0.0.5.macosx-10.10-intel.exe (119.8 kB) Copy SHA256 hash SHA256 Windows Installer any Aug 23, 2015
newslynx-sc-rss-0.0.5.tar.gz (51.0 kB) Copy SHA256 hash SHA256 Source None Aug 23, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page