diff --git a/docs/source/conf.py b/docs/source/conf.py index 2703c4254eba24a09f24aba4b66f417e2f4d198e..5f3e5cfdb68722ad490f6806e109023e014d51f0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,7 +17,7 @@ sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- -project = 'py-dbcn' +project = 'Pythonic Database Connector' copyright = '2022, Brandon Rodriguez' author = 'Brandon Rodriguez' diff --git a/docs/source/index.rst b/docs/source/index.rst index 02eaa03fc7f425aeae28009564ce805268cb9ccb..ce5f9ece0cf3195c3afee28400c6368e2aca8f24 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -42,6 +42,14 @@ the way. roadmap version_history +.. toctree:: + :maxdepth: 1 + :caption: Supplementary Documentation + + supplementary/sqlite_syntax_docs + supplementary/mysql_syntax_docs + supplementary/postgresql_syntax_docs + Indices and tables ================== diff --git a/docs/source/supplementary/mysql_syntax_docs.rst b/docs/source/supplementary/mysql_syntax_docs.rst new file mode 100644 index 0000000000000000000000000000000000000000..b2e984b9e9c53967df6440bef644f067678ed8f6 --- /dev/null +++ b/docs/source/supplementary/mysql_syntax_docs.rst @@ -0,0 +1,36 @@ +MySQL Syntax +************ + +Here is supplementary documentation of basic `MySQL <https://www.mysql.com/>`_ +syntax, to help with using the ``py-dbcn`` package. + + +Quote Formatting +================ +While not strictly necessary for the ``py-dbcn`` package, we document the +expected quote formatting types here: + +* ````` - Column Quote Format - Used for quoting around table column names. +* ````` - Identifier Quote Format - Used for quoting around identifiers, such + as SELECT clause field id's. +* ``"`` - Str Literal Quote Format - Used for quoting around literal strings. + + +Clause Formatting +================= + + +Database Query Formatting +========================= + + +Table Query Formatting +====================== + + +Record Query Formatting +======================= + + +See also: +https://sphinx-tabs.readthedocs.io/en/latest/ diff --git a/docs/source/supplementary/postgresql_syntax_docs.rst b/docs/source/supplementary/postgresql_syntax_docs.rst new file mode 100644 index 0000000000000000000000000000000000000000..1c01aa350460fe160118030d224b8c9c6eccdbff --- /dev/null +++ b/docs/source/supplementary/postgresql_syntax_docs.rst @@ -0,0 +1,33 @@ +PostgreSQL Syntax +***************** + +Here is supplementary documentation of basic +`PostgreSQL <https://www.postgresql.org/>`_ syntax, to help with using the +``py-dbcn`` package. + + +Quote Formatting +================ +While not strictly necessary for the ``py-dbcn`` package, we document the +expected quote formatting types here: + +* ``'`` - Column Quote Format - Used for quoting around table column names. +* ``"`` - Identifier Quote Format - Used for quoting around identifiers, such + as SELECT clause field id's. +* ``'`` - Str Literal Quote Format - Used for quoting around literal strings. + + +Clause Formatting +================= + + +Database Query Formatting +========================= + + +Table Query Formatting +====================== + + +Record Query Formatting +======================= diff --git a/docs/source/supplementary/sqlite_syntax_docs.rst b/docs/source/supplementary/sqlite_syntax_docs.rst new file mode 100644 index 0000000000000000000000000000000000000000..0f43bbab11f2e49f66327ae3f791457ff117e47e --- /dev/null +++ b/docs/source/supplementary/sqlite_syntax_docs.rst @@ -0,0 +1,11 @@ +SqLite Syntax +************* + +Here is supplementary documentation of basic +`SqLite <https://www.sqlite.org/>`_ syntax, to help with using the +``py-dbcn`` package. + + +.. warning:: + + SqLite support not yet implemented. diff --git a/py_dbcn/constants.py b/py_dbcn/constants.py index 3c36cd381cba9747eff5ef348782621d0b99ed68..1bf5306eb270dec6787270dacb0af77d4b5347c5 100644 --- a/py_dbcn/constants.py +++ b/py_dbcn/constants.py @@ -27,6 +27,7 @@ try: except ImportError: PYTZ_PRESENT = False + # Color output imports. try: from colorama import Back, Fore, Style