wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

Add a large chunk of the docs for command line interface

Browse source 
will have to finish subcommands later
This commit is contained in:
Lance Edgar 2023-11-22 21:40:26 -06:00
parent 8a4438c725
commit af4c28b286
15 changed files with 371 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/glossary.rst
View file

@ -6,9 +6,13 @@ Glossary
.. glossary::
:sorted:
ad hoc script
Python script (text) file used for ad-hoc automation etc. See
also :doc:`narr/cli/scripts`.
app
Depending on context, may refer to the software application
overall, or the :term:`app handler`.
overall, or the :term:`app name`, or the :term:`app handler`.
app database
The main database used by the :term:`app`. There is normally
@ -26,15 +30,19 @@ Glossary
:class:`~wuttjamaican.app.AppHandler`.
app name
The code-friendly name for the :term:`app`
(e.g. ``wutta_poser``). This is available on the :term:`config
object` within Python as
:attr:`~wuttjamaican.conf.WuttaConfig.appname`.
Code-friendly name for the underlying app/config system
(e.g. ``wutta_poser``).
This must usually be specified as part of the call to
:func:`~wuttjamaican.conf.make_config()` and is then available on
the :term:`config object`
:attr:`~wuttjamaican.conf.WuttaConfig.appname` and the :term:`app
handler` :attr:`~wuttjamaican.app.AppHandler.appname`.
See also the human-friendly :term:`app title`.
app title
The human-friendly name for the :term:`app` (e.g. "Wutta Poser").
Human-friendly name for the :term:`app` (e.g. "Wutta Poser").
See also the code-friendly :term:`app name`.
@ -42,7 +50,7 @@ Glossary
A top-level command line interface for the app. Note that
top-level commands don't really "do" anything per se, and are
mostly a way to group :term:`subcommands<subcommand>`. See also
:class:`~wuttjamaican.commands.base.Command`.
:class:`~wuttjamaican.cmd.base.Command`.
config
Depending on context, may refer to any of: :term:`config file`,
@ -66,6 +74,17 @@ Glossary
values obtained from the :term:`settings table` as opposed to
:term:`config file`. See also :doc:`narr/config/settings`.
entry point
This refers to a "setuptools-style" entry point specifically,
which is a mechanism used to register "plugins" and the like.
This lets the app / config discover features dynamically. Most
notably used to register :term:`commands<command>` and
:term:`subcommands<subcommand>`.
For more info see the `Python Packaging User Guide`_.
.. _Python Packaging User Guide: https://packaging.python.org/en/latest/specifications/entry-points/
settings table
Table in the :term:`app database` which is used to store
:term:`config settings<config setting>`.
@ -74,4 +93,4 @@ Glossary
A top-level :term:`command` may expose one or more subcommands,
for the overall command line interface. Subcommands are the real
workhorse; each can perform a different function. See also
:class:`~wuttjamaican.commands.base.Subcommand`.
:class:`~wuttjamaican.cmd.base.Subcommand`.