From: Karl O. Pinc Date: Wed, 14 Nov 2018 15:21:54 +0000 (-0600) Subject: Document how to use in your own Pyramid application X-Git-Url: https://papio.biology.duke.edu/gitweb/?a=commitdiff_plain;h=969e1fd7efb9158244aac7456366924adae0e396;p=pgwui_common Document how to use in your own Pyramid application --- diff --git a/README.rst b/README.rst index c573c59..d243c57 100644 --- a/README.rst +++ b/README.rst @@ -41,10 +41,21 @@ discovering and reporting as many errors as is possible per bulk interaction with the database. +Usage +----- + +When utilizing PGWUI modules in your own `Pyramid`_ application, +modules which require the PGWUI_Common module, PGWUI_Common must be +explicitly configured. This can be done with any of `Pyramid's +`_ configuration mechanisms, ``pyramid_includes = +pgwui_common`` in a ``.ini`` file or +``config.include('pgwui_common')`` in Python code. + + Configuration By Python Code ---------------------------- -If you are writing a complete Pyramid application, or simply want full +If you are writing a complete `Pyramid`_ application, or simply want full control over configuration you will need to make a Python distribution. (Something to be installed, perhaps with ``pip``.) In this case use pgwui_common to configure your pyramid app by putting