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

89 lines
2.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
============
fix: add basic support for wutta-continuum data versioning/history not much "support" per se in here, mostly some stubs to allow for smooth operation if/when it is installed
2024-08-27 20:26:22 -05:00
This package aims to provide a "base layer" for apps regardless of
platform or environment (console, web, GUI).
Add docs for handlers, app handler
2023-11-24 15:49:57 -06:00
fix: add basic support for wutta-continuum data versioning/history not much "support" per se in here, mostly some stubs to allow for smooth operation if/when it is installed
2024-08-27 20:26:22 -05:00
It comes from patterns developed within the `Rattail Project`_, and
roughly corresponds with the "base and data layers" as described in
:doc:`rattail-manual: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 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
feat: add `wutta` top-level command with `make-uuid` subcommand i think it only makes sense to have an "opinion" for command line interface in this project, and we probably need more `wutta` subcommands too but we'll see. main motivation for this currently is to allow poser apps to define their own CLI, in particular e.g. `poser install`
2024-11-23 11:48:28 -06:00
* flexible command line interface, using `Typer`_
Add basic database docs
2023-11-24 19:14:48 -06:00
* flexible database support, using `SQLAlchemy`_
feat: add `wutta` top-level command with `make-uuid` subcommand i think it only makes sense to have an "opinion" for command line interface in this project, and we probably need more `wutta` subcommands too but we'll see. main motivation for this currently is to allow poser apps to define their own CLI, in particular e.g. `poser install`
2024-11-23 11:48:28 -06:00
.. _Typer: https://typer.tiangolo.com
Add basic database docs
2023-11-24 19:14:48 -06:00
.. _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
fix: add basic support for wutta-continuum data versioning/history not much "support" per se in here, mostly some stubs to allow for smooth operation if/when it is installed
2024-08-27 20:26:22 -05:00
See also these projects which build on WuttJamaican:
docs: rearrange API docs per conventions used elsewhere e.g. in WuttaSync..this convention is better i think..?
2024-12-07 19:05:22 -06:00
* `WuttaWeb <https://rattailproject.org/docs/wuttaweb/>`_ - web app
framework
* `WuttaSync <https://rattailproject.org/docs/wuttasync/>`_ - data
import/export and real-time sync
* :doc:`wutta-continuum:index` - data versioning with
SQLAchemy-Continuum
fix: add basic support for wutta-continuum data versioning/history not much "support" per se in here, mostly some stubs to allow for smooth operation if/when it is installed
2024-08-27 20:26:22 -05:00
docs: add link to Victor Wooten's song!
2024-12-07 22:01:40 -06:00
And for something completely different...go give a listen to `Victor
Wooten's song <https://www.youtube.com/watch?v=ZrcjlK9e8rg>`_!
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::
docs: rearrange API docs per conventions used elsewhere e.g. in WuttaSync..this convention is better i think..?
2024-12-07 19:05:22 -06:00
:maxdepth: 2
:caption: Documentation
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
glossary
docs: rearrange API docs per conventions used elsewhere e.g. in WuttaSync..this convention is better i think..?
2024-12-07 19:05:22 -06:00
narr/install/index
narr/config/index
narr/cli/index
narr/handlers/index
narr/providers/index
narr/db/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
docs: rearrange API docs per conventions used elsewhere e.g. in WuttaSync..this convention is better i think..?
2024-12-07 19:05:22 -06:00
.. toctree::
:maxdepth: 1
:caption: API
api/wuttjamaican.app
api/wuttjamaican.auth
api/wuttjamaican.cli
api/wuttjamaican.cli.base
api/wuttjamaican.cli.make_uuid
api/wuttjamaican.conf
api/wuttjamaican.db
api/wuttjamaican.db.conf
api/wuttjamaican.db.model
api/wuttjamaican.db.model.auth
api/wuttjamaican.db.model.base
api/wuttjamaican.db.model.upgrades
api/wuttjamaican.db.sess
api/wuttjamaican.db.util
api/wuttjamaican.email
api/wuttjamaican.email.handler
api/wuttjamaican.email.message
api/wuttjamaican.enum
api/wuttjamaican.exc
api/wuttjamaican.install
api/wuttjamaican.people
api/wuttjamaican.progress
api/wuttjamaican.testing
api/wuttjamaican.util
Copy permalink