wutta/wuttjamaican
2
0
Fork 0
Code Activity
wuttjamaican/docs/index.rst

56 lines
1.2 KiB
ReStructuredText
Raw Normal View History

First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
WuttJamaican
============
Add docs for handlers, app handler
2023-11-24 15:49:57 -06:00
This package provides a "base layer" for custom apps, regardless of
environment/platform:
* console
* web
* GUI
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
It mostly is a distillation of certain patterns developed within the
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
`Rattail Project`_, which are deemed generally useful. (At least,
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
according to the author.) It roughly corresponds to the "base layer"
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
as described in the Rattail Manual (see
:doc:`rattail-manual:base/index`).
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
.. _Rattail Project: https://rattailproject.org/
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
Add link to coverage in main docs
2023-11-24 19:47:08 -06:00
Good documentation and 100% `test coverage`_ are priorities for this
project.
.. _test coverage: https://buildbot.rattailproject.org/coverage/wuttjamaican/
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
Rattail is still the main use case so far, and will be refactored
along the way to incorporate what this package has to offer.
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
Add basic command line framework `wutta setup` is the only real sub/command yet, and it does nothing
2023-11-19 14:22:25 -06:00
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
Features
--------
Add basic command line framework `wutta setup` is the only real sub/command yet, and it does nothing
2023-11-19 14:22:25 -06:00
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
* flexible configuration, using config files and/or DB settings table
Add docs for handlers, app handler
2023-11-24 15:49:57 -06:00
* flexible architecture, abstracting various portions of the overall app
Add basic database docs
2023-11-24 19:14:48 -06:00
* flexible database support, using `SQLAlchemy`_
.. _SQLAlchemy: https://www.sqlalchemy.org
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
Contents
--------
.. toctree::
:maxdepth: 3
Add narrative docs for app configuration
2023-11-21 18:27:29 -06:00
glossary
narr/index
First commit, basic config (with db) and app handler this has 100% test coverage and i intend to keep it that way. api docs have a good start but still need narrative. several more things must be added before i can seriously consider incorporating into rattail but this seemed a good save point
2023-10-28 17:48:37 -05:00
api/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy permalink