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 ?
-
This file
-
newslynx-sc-example’s source-of-truth version.
-
newslynx-sc-example’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-example’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-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
Serves documentation at localhost:8000
make register:
Registers newslynx-sc-example on PyPI.
make distribute:
Publishes a new version of newslynx-sc-example to PyPI.
-
newslynx-sc-example’s source code and Sous Chef configuration files.
-
Sphnix documentation for newslynx-sc-example
-
nose tests for newslynx-sc-example
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-example-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddad02f6073d8898d1e1e4a91e7b5ffb3adcb0a30f3b23596b4d632b045e4b89 |
|
MD5 | c3cb52d2eaf204e395d794befedcfbce |
|
BLAKE2b-256 | 3ae2b5f3d4134e75f595286e505d6765d07df6910625616d5a40767dc7d556f2 |
Hashes for newslynx-sc-example-0.0.1.macosx-10.10-intel.exe
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68803ec5ed84dc393fb9e25f271d31fabdb28a6fbffcc4a9141ff6c9afe94a4f |
|
MD5 | 4057d3defce2761e8db10dea2883e352 |
|
BLAKE2b-256 | c71f45aa2d630dd6894dec6d567ad3c97e786a27998874797d94fa1a6e36c0ef |