From a0b516c278ad82465d6b5be9f1b88d8b11cad1b0 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 24 Jan 2021 00:10:27 -0600 Subject: [PATCH] Better description --- README.rst | 40 ++++++---------------------------------- 1 file changed, 6 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index 32f4f5a..395d2bb 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. Copyright (C) 2018 The Meme Factory, Inc. http://www.karlpinc.com/ +.. Copyright (C) 2018, 2021 The Meme Factory, Inc. http://www.karlpinc.com/ This file is part of PGWUI_Upload. @@ -27,43 +27,16 @@ PGWUI_Upload Short Documentation ------------------- -PGWUI_Upload stands for `PostgreSQL`_ Web User Interface Upload. - -A generic WSGI web form for validation and bulk uploading of tabular -data into a `PostgreSQL`_ database. The form presented requests -database, login credentials, the name of the table or view into which -the data should be uploaded, and the type and source of data. The -all-or-nothing data modification property which transactions provide -is supported. - -PGWUI_Upload's distinguishing feature is the reporting of multiple -errors per batch of uploaded data, while at the same time uploading -each batch of data in a transaction so that either all the data in the -batch goes into the database or of the data none does. +PGWUI_Upload_Core stands for `PostgreSQL`_ Web User Interface Upload Core +files. +Core files to support uploading. Usage ----- -PGWUI_Upload is included when PGWUI is installed. - -It is recommended but not required to install PGWUI_Logout when -installing PGWUI_Upload. - -When writing your own `Pyramid`_ application, in addition to -configuring ``pgwui_upload``, ``pgwui_common`` must typically be -configured. This can be done with any of `Pyramid's `_ -configuration mechanisms. - - -URL Configuration ------------------ - -The default URL for PGWUI_Upload looks like -*https://www.example.com/upload*. - -See the PGWUI_Server documentation for how to configure a different -URL. +PGWUI_Upload is included when other PGWUI components are installed. +It should not need to be installed manually. Development Status @@ -103,4 +76,3 @@ provided by `The Dian Fossey Gorilla Fund .. _PGWUI_Core: http://pgwui_core.readthedocs.io/ .. _PostgreSQL: https://www.postgresql.org/ -.. _Pyramid: https://trypyramid.com/ -- 2.34.1