.. Copyright (C) 2018, 2020, 2021 The Meme Factory, Inc.
   http://www.karlpinc.com/


   This file is part of PGWUI_Develop.
  
   This program is free software: you can redistribute it and/or
   modify it under the terms of the GNU Affero General Public License
   as published by the Free Software Foundation, either version 3 of
   the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public
   License along with this program.  If not, see
   <http://www.gnu.org/licenses/>.

   Karl O. Pinc <kop@karlpinc.com>

.. #End Of Copyright Marker#

PGWUI_Develop
=============

Short Documentation
-------------------

PGWUI_Develop stands for `PostgreSQL`_ Web User Interface development tools.

Utilities to assist in the testing and development of the PGWUI suite
of programs.

The `pgwui` command is used by developers.  It has one sub-command,
`cookiecutter`.  The cookiecutter writes a template directory
containing "starter code" suitable for developing a new PGWUI
component.  Type `pgwui cookiecutter --help` for usage information.

There are 2 sorts of libraries made available.  To enable the pytest
plugin:

  # Activiate the pytest plugin
  pytest_plugins = ("pgwui",)

This makes the following fixtures available:

  pyramid_config
    Input: None

    Is a Pyramid auto-committing Configurator instance.

  pyramid_request_config
    Input: None

    Is a Pyramid auto-committing Configurator instance.

    Side Effects: pyramid.threadlocal.get_current_request() returns
    a Pyramid DummyRequest instance.

  pgwui__component_entry_point
    Input: A pgwui component name, as a string

    Returns: Boolean, does the supplied component have a PGWUI component
    entry point?

  pgwui_check_settings_entry_point
    Input: A pgwui component name, as a string

    Returns: Boolean, does the supplied component have a check_settings
    entry point?


Development Status
------------------

Although in use in production systems the PGWUI suite must be
considered Beta code.  You may wish to install a specific version to
ensure consistent behavior as PGWUI_Develop is developed.


Complete Documentation
----------------------

The complete documentation set can be found on the PGWUI_Develop home
page at http://pgwui_develop.readthedocs.io/.


License
-------

Except for files otherwise marked, distributed WITHOUT ANY WARRANTY
under the terms of the GNU Affero General Public License, version 3 or
a later version at your option.  See the copyright notices at the top
of each file and the LICENSE.txt file for details.


Acknowledgments
---------------

Support for extracting PGWUI_Core from GMI_Pyramid, its Python
packaging, and further enhancement was provided by `The Dian Fossey
Gorilla Fund <https://www.gorillafund.org>`_.


.. _PostgreSQL: https://www.postgresql.org/