{ "info": { "author": "Merlynne", "author_email": "UNKNOWN", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python" ], "description": "|Build status| |Documentation Status|\n\nnewslynx-sc-homepage\n====================\n\nInstallation\n------------\n\nProduction\n~~~~~~~~~~\n\nTo install ``newslynx-sc-homepage`` for an active installation of\n``newslynx-core``, run the following command:\n\n.. code:: bash\n\n $ newslynx sc-install https://github.com/newslynx/newslynx-sc-homepage.git\n\nTo add ``newslynx-sc-homepage`` all orgnaizations, run:\n\n.. code:: bash\n\n $ newslynx sc-sync\n\nDevelopment\n~~~~~~~~~~~\n\nIf you want to modify / add Sous Chefs to ``newslynx-sc-homepage``, do\nthe following:\n\n**NOTE** Will install a fresh version of ``newslynx`` via ``pip``.\n\n.. code:: bash\n\n $ git clone https://github.com/newslynx/newslynx-sc-homepage.git\n $ cd newslynx-sc-homepage\n $ pip install --editable .\n\nYou should now be able to run ``newslynx-sc-homepage``'s Sous Chefs in\ndevelopment mode\n\n.. code:: bash\n\n % newslynx sc-run newslynx_sc_homepage/say_my_name.yaml --myname='Brian Abelson'\n\nTests\n-----\n\nRequires ``nose``\n\n.. code:: bash\n\n $ make all_tests\n\nDocumentation\n-------------\n\nDocumentation for ``newslynx-sc-homepage`` is hosted on `Read The\nDocs `__.\n\nIt's generated via the following steps\n\n- converts this file (``README.md``) into a ReStructured Text file,\n saving it to\n `docs/index.rst `__\n- runs ``newslynx sc-docs newslynx_sc_homepage -f rst`` to generate\n documentation for all the Sous Chefs in ``newslynx-sc-homepage`` and\n saves the output to\n `docs/sous-chefs.rst `__\n- Builds Sphinx Documentation from these files.\n\nContinuous Integration\n----------------------\n\nBuilds for ``newslynx-sc-homepage`` can be found on\n`Travis `__\n\nContributing\n------------\n\nSee the `contributing\nguidelines `__.\n\nWhat's in this module ?\n-----------------------\n\n- `README.md `__\n\n - This file\n\n- `VERSION `__\n\n - ``newslynx-sc-homepage``'s source-of-truth version.\n\n- `requirements.txt `__\n\n - ``newslynx-sc-homepage``'s python dependencies.\n\n- `MANIFEST.in `__\n\n - Specifications for which files to include in the PyPI\n distribution.\n - See the docs on this\n `here `__.\n\n- `setup.py `__\n\n - Specification's for building ``newslynx-sc-homepage``'s PyPI\n distribution.\n\n- `.travis.yml `__\n\n - Configurations for Travis Continuous Integration\n - You must activate this project on\n `travis-ci.org `__\n for this to run on subsequent updates.\n\n- `Makefile `__\n\n - Helpers for managing ``newslynx-sc-homepage``.\n - Includes:\n\n - ``make clean``:\n\n - Cleans out cruft from this directory.\n\n - ``make install``:\n\n - Installs ``newslynx-sc-homepage``. Assumes that you're in a\n virtual environment.\n\n - ``make all_tests``:\n\n - Runs the tests.\n\n - ``make readme``\n\n - Converts this file to ``.rst``, including a table of\n contents, and saves it to\n `docs/index.rst `__\n\n - ``make sous_chef_docs``\n\n - Programmtically generates `Sous Chef\n documentation `__\n by running\n ``newslynx sc-docs newslynx_sc_homepage/ --format=rst > docs/sous-chefs.rst``.\n\n - ``make all_docs``:\n\n - Builds the sphinx docs for ``newslynx-sc-homepage`` by\n running the above two commands.\n\n - ``make view_docs``\n\n - Serves documentation at\n `localhost:8000 `__\n\n - ``make register``:\n\n - Registers ``newslynx-sc-homepage`` on\n `PyPI `__.\n\n - ``make distribute``:\n\n - Publishes a new version of ``newslynx-sc-homepage`` to PyPI.\n\n- `CONTRIBUTING.md `__\n\n- `newslynx\\_sc\\_homepage `__\n\n - ``newslynx-sc-homepage``'s source code and Sous Chef configuration\n files.\n\n- `docs `__\n\n - Sphnix documentation for ``newslynx-sc-homepage``\n\n- `tests `__\n\n - ``nose`` tests for ``newslynx-sc-homepage``\n\n.. |Build status| image:: https://travis-ci.org/newslynx/newslynx-sc-homepage.svg\n :target: https://travis-ci.org/newslynx/newslynx-sc-homepage\n.. |Documentation Status| image:: https://readthedocs.org/projects/newslynx-sc-homepage/badge/?version=latest\n :target: https://readthedocs.org/projects/newslynx-sc-homepage/?badge=latest", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/newslynx/newslynx-sc-homepage", "keywords": "", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "newslynx-sc-homepage", "package_url": "https://pypi.org/project/newslynx-sc-homepage/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/newslynx-sc-homepage/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/newslynx/newslynx-sc-homepage" }, "release_url": "https://pypi.org/project/newslynx-sc-homepage/0.0.1/", "requires_dist": null, "requires_python": null, "summary": "UNKNOWN", "version": "0.0.1" }, "last_serial": 1755592, "releases": { "0.0.1": [] }, "urls": [] }