curated_feed.template
=====================

.. py:module:: curated_feed.template

.. autoapi-nested-parse::

   The two documents a new runner is copied from.

   A runner is a directory holding a config, an editorial policy and a subscription
   list, and every one of them is written by hand. The two that have a shape worth
   writing down travel with the engine rather than sitting beside the runners: the
   settings reference is derived from the settings model and is checked against it,
   and the policy reference records the conventions the scoring prompt depends on.
   Both are the engine's to keep current, so a copy kept next to somebody's feeds
   would be the copy that went stale.

   They are printed rather than copied, because the engine is installed rather than
   checked out wherever a runner is created — an image, a virtual environment, an
   editable tree. Nothing reads either file at runtime.



Attributes
----------

.. autoapisummary::

   curated_feed.template.PACKAGE
   curated_feed.template.FILENAME_BY_TEMPLATE


Functions
---------

.. autoapisummary::

   curated_feed.template.template_path
   curated_feed.template.read_template
   curated_feed.template.build_parser
   curated_feed.template.main


Module Contents
---------------

.. py:data:: PACKAGE
   :value: 'curated_feed'


.. py:data:: FILENAME_BY_TEMPLATE

.. py:function:: template_path(which: str) -> pathlib.Path

   Where a template is installed.

   >>> template_path("config").name
   'config.template.toml'
   >>> template_path("policy").is_file()
   True


.. py:function:: read_template(which: str) -> str

   A template's text, exactly as it ships.


.. py:function:: build_parser() -> argparse.ArgumentParser

.. py:function:: main(argv: collections.abc.Sequence[str] | None = None) -> int