wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

docs: improve docs relating to app db, setup thereof

Browse source
This commit is contained in:
Lance Edgar 2024-12-08 12:19:42 -06:00
parent d70df11be6
commit 45ea5c5bdc
9 changed files with 241 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/narr/install/prereqs.rst
View file

@ -8,11 +8,7 @@ Wuttjamaican requires Python, and optionally a database of some sort.
Python
------
Currently at least Python 3.6 is required, however:
As of writing only Python 3.8 and newer are supported by the official
Python team, so that is strongly recommended. It is likely that will
soon become the minimum requirement for WuttJamaican as well.
Currently at least Python 3.8 is required.
Also note, Python 3.11 is the newest version being tested so far.
@ -22,15 +18,8 @@ See also https://endoflife.date/python
Database
--------
There is not yet much logic in WuttJamaican which pertains to the
:term:`app database` so we will not document much about that here
either.
If you need an :term:`app database` then you will also need the
backend and/or libraries to support that.
For now just know that in a production environment, PostgreSQL is
recommended for the DB backend. So install that if you want to be
certain of a good experience.
But technically speaking, anything supported by `SQLAlchemy`_ should
work. See also :doc:`/narr/config/table`.
.. _SQLAlchemy: https://www.sqlalchemy.org
The recommendation is to use PostgreSQL but this is further documented
elsewhere; see :ref:`create-appdb`.