3
0
Fork 0

feat: remove legacy command system

typer is the recommended approach, but any could be used.  we have
nothing significant to offer so better to just not.
This commit is contained in:
Lance Edgar 2024-07-04 14:35:29 -05:00
parent fd76766f56
commit a76cbf29e9
23 changed files with 8 additions and 1193 deletions

View file

@ -1,6 +0,0 @@
``wuttjamaican.cmd.base``
=========================
.. automodule:: wuttjamaican.cmd.base
:members:

View file

@ -1,8 +0,0 @@
``wuttjamaican.cmd.date_organize``
==================================
.. automodule:: wuttjamaican.cmd.date_organize
:members:
.. program-output:: wutta date-organize -h

View file

@ -1,8 +0,0 @@
``wuttjamaican.cmd.make_appdir``
================================
.. automodule:: wuttjamaican.cmd.make_appdir
:members:
.. program-output:: wutta make-appdir -h

View file

@ -1,23 +0,0 @@
``wuttjamaican.cmd``
====================
.. automodule:: wuttjamaican.cmd
:members:
The core framework is contained in :mod:`wuttjamaican.cmd.base`.
Note that :class:`~wuttjamaican.cmd.base.Command` serves as the base
class for top-level :term:`commands<command>` but it also functions as
the top-level ``wutta`` command.
Some :term:`subcommands<subcommand>` are available as well; these are
registered under the ``wutta`` command.
.. toctree::
:maxdepth: 1
cmd.base
cmd.date_organize
cmd.make_appdir
cmd.setup

View file

@ -1,8 +0,0 @@
``wuttjamaican.cmd.setup``
==========================
.. automodule:: wuttjamaican.cmd.setup
:members:
.. program-output:: wutta setup -h

View file

@ -8,7 +8,6 @@
:maxdepth: 1
app
cmd
conf
db
db.conf

View file

@ -43,13 +43,16 @@ be used to avoid unwanted splits.
Specifying via Command Line
---------------------------
All :term:`commands<command>` accept the ``-c`` or ``--config`` params:
While no :term:`commands<command>` are shipped with WuttJamaican,
certain other packages may ship with commands (notably, Rattail). The
convention is to accept a ``--config`` (or ``-c``) param on the
command line, e.g.:
.. code-block:: sh
wutta --config=myapp.conf
rattail --config=myapp.conf
wutta -c first.conf -c second.conf
rattail -c first.conf -c second.conf
Specifying via Environment Variable

View file

@ -43,7 +43,5 @@ For more info see:
* :class:`~wuttjamaican.conf.WuttaConfig` and especially
:meth:`~wuttjamaican.conf.WuttaConfig.get()`
You can also define your own command line interface; see:
* :class:`~wuttjamaican.commands.base.Command`
* :class:`~wuttjamaican.commands.base.Subcommand`
You can also define your own command line interface; see
:doc:`/narr/cli/index`.