Skip to main content

An example Sous Chef module generated by

Project description

An example Sous Chef module generated by

Installation

Via pip

$ pip install newslynx-sc-example

From source

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

Tests

Requires nose

$ nosetests

Documenation

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

Continuous Integration

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

Contributing

See the contributing guidelines.

What’s in this module ?

  • README.md
    • This file
  • VERSION
    • newslynx-sc-example’s source-of-truth version.
  • requirements.txt
    • newslynx-sc-example’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-example’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-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
      • make sous_chef_docs
        • Programmtically generates Sous Chef documentation 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
      • make register:
        • Registers newslynx-sc-example on PyPI.
      • make distribute:
        • Publishes a new version of newslynx-sc-example to PyPI.
  • CONTRIBUTING.md
  • newslynx_sc_example
    • newslynx-sc-example’s source code and Sous Chef configuration files.
  • docs
    • Sphnix documentation for newslynx-sc-example
  • tests
    • nose tests for newslynx-sc-example

Project details


Download files

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

Files for newslynx-sc-example, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size newslynx-sc-example-0.0.1.macosx-10.10-intel.exe (70.5 kB) File type Windows Installer Python version any Upload date Hashes View
Filename, size newslynx-sc-example-0.0.1.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page