newslynx-sc-reddit¶
Installation¶
Production¶
To install newslynx-sc-reddit
for an active installation of
newslynx-core
, clone it and copy into ~/.newslynx/sous-chefs
$ git clone https://github.com/newslynx/newslynx-sc-reddit.git
$ mv newslynx-sc-reddit/ ~/.newslynx/sous-chefs/
Now install it within the same virtual environment as newslynx
:
$ cd ~/.newslynx/sous-chefs/newslynx-sc-reddit/
$ pip install .
... and if you’re running newslynx
as sudo
$ cd ~/.newslynx/sous-chefs/newslynx-sc-reddit/
$ sudo pip install .
Finally, run newslynx sc-sync
to newslynx-sc-reddit
‘s Sous Chefs
for all organizations.
$ newslynx sc-sync
Development¶
If you want to modify / add Sous Chefs to newslynx-sc-reddit
, instal
it in it’s own virtual environment.
NOTE Will install a fresh version of newslynx
via pip
.
$ mkvirtualenv newslynx-sc-reddit
$ git clone https://github.com/newslynx/newslynx-sc-reddit.git
$ cd newslynx-sc-reddit
$ pip install --editable .
You should now be able to run newslynx-sc-reddit
‘s Sous Chefs in
development mode
% newslynx sc newslynx_sc_reddit/say_my_name.yaml --myname='Brian Abelson'
Documentation¶
Documentation for newslynx-sc-reddit
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_reddit -f rst
to generate documentation for all the Sous Chefs innewslynx-sc-reddit
and saves the output to docs/sous-chefs.rst - Builds Sphinx Documentation from these files.
Contributing¶
See the contributing guidelines.
What’s in this module ?¶
- README.md
- This file
- VERSION
newslynx-sc-reddit
‘s source-of-truth version.
- requirements.txt
newslynx-sc-reddit
‘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-reddit
‘s PyPI distribution.
- Specification’s for building
- .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-reddit
. - Includes:
make clean
:- Cleans out cruft from this directory.
make install
:- Installs
newslynx-sc-reddit
. Assumes that you’re in a virtual environment.
- Installs
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
- Converts this file to
make sous_chef_docs
- Programmtically generates Sous Chef
documentation
by running
newslynx sc-docs newslynx_sc_reddit/ --format=rst > docs/sous-chefs.rst
.
- Programmtically generates Sous Chef
documentation
by running
make all_docs
:- Builds the sphinx docs for
newslynx-sc-reddit
by running the above two commands.
- Builds the sphinx docs for
make view_docs
- Serves documentation at localhost:8000
make register
:- Registers
newslynx-sc-reddit
on PyPI.
- Registers
make distribute
:- Publishes a new version of
newslynx-sc-reddit
to PyPI.
- Publishes a new version of
- Helpers for managing
- CONTRIBUTING.md
- newslynx_sc_reddit
newslynx-sc-reddit
‘s source code and Sous Chef configuration files.
- docs
- Sphnix documentation for
newslynx-sc-reddit
- Sphnix documentation for
- tests
nose
tests fornewslynx-sc-reddit