From 7624600581479bcced55e81fe1faa525eb764be4 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Thu, 1 Nov 2018 11:51:04 -0500 Subject: [PATCH] Initial import from GMI_Pyramid --- .coveragerc | 7 + .gitignore | 11 + LICENSE.txt | 661 +++++++++++++++++++++++++++++++++++ MANIFEST.in | 9 + Makefile | 180 ++++++++++ README.rst | 274 +++++++++++++++ examples/development.ini | 122 +++++++ examples/pgwui.ini | 127 +++++++ setup.cfg | 3 + setup.py | 175 ++++++++++ src/pgwui_server/VERSION | 1 + src/pgwui_server/__init__.py | 35 ++ tests/test___init__.py | 40 +++ tox.ini | 30 ++ 14 files changed, 1675 insertions(+) create mode 100644 .coveragerc create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 MANIFEST.in create mode 100644 Makefile create mode 100644 README.rst create mode 100644 examples/development.ini create mode 100644 examples/pgwui.ini create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 src/pgwui_server/VERSION create mode 100644 src/pgwui_server/__init__.py create mode 100644 tests/test___init__.py create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..a6d44e4 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,7 @@ +[run] +branch = True +source = + pgwui_server + +[report] +show_missing = True diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9dbc77 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +__pycache__/ +.pytest_cache/ +.cache/ +.coverage +.tox/ +build/ +devel/ +dist/ +docs/build/ +README.html +src/pgwui_server.egg-info/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c4d1cb1 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,9 @@ +recursive-include tests *.py +include .coveragerc +# List all the examples, so we don't accidently include editor backups +include examples/development.ini +include examples/pgwui.ini +include LICENSE.txt +include Makefile +include src/pgwui_server/VERSION +include tox.ini diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..b621fd8 --- /dev/null +++ b/Makefile @@ -0,0 +1,180 @@ +# Copyright (C) 2016, 2017, 2018 The Meme Factory, Inc. http://www.meme.com/ + +# This file is part of PGWUI_Server. +# +# 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 +# . +# + +# Karl O. Pinc + +# This works on debian... +PYTHON_EXE=python3 +VIRTUALENV=virtualenv -p ${PYTHON_EXE} + +TARGETS = +EXTRA_TARGETS = README.html +SETUPTOOLS_STUFF = build dist src/pgwui_server.egg-info +PYTEST_STUFF = .cache .pytest_cache tests/__pycache__ tests/.pytest_cache +COVERAGE_STUFF = .coverage +TOX_STUFF = .tox + +all: ${TARGETS} + +help: + @echo + @echo 'Usage: make TARGET' + @echo + @echo 'TARGET is one of:' + @echo 'README.html Make html version of README.rst' + @echo 'publish Update all public-facing info' + @echo ' ("check-manifest" + "upload" + "push")' + @echo 'run_tests Run regression tests' + @echo 'dist Create sdist Python package in ./dist' + @echo 'clean Removed generated data' + @echo + @echo 'Less used TARGETS are:' + @echo 'register_test Register project at pypi test site' + @echo 'register Register project at pypi live site' + @echo 'upload_test Upload project to pypi test site' + @echo 'upload Upload project to pypi live site' + @echo 'push Push repo changes to public repo' + @echo ' (Hooks at bitbucket update readthedocs)' + @echo 'check Quick run of regression tests,' + @echo 'pudb Run the python pudb debugger' + @echo ' only with the default python' + @echo 'devel/check-manifest' + @echo ' Create a check-manifest venv' + @echo 'check-manifest Run check-manifest' + @echo 'update_check-manifest' + @echo ' Upgrade check-manifest venv to latest' + @echo ' versions' + @echo + @echo 'This Makefile does not work with the docs. See:' + @echo 'cd docs; make help' + +README.html: README.rst + rst2html --strict README.rst > README.html + + +# Useless targets +# Register with pypi. +.PHONY: register_test +register_test: + python setup.py register -r https://testpypi.python.org/pypi + +.PHONY: register +register: + python setup.py register + + +# Not so useless targets, used by the package owners for package management +.PHONY: upload_test +upload_test: + python setup.py sdist upload -r https://testpypi.python.org/pypi + +.PHONY: upload +upload: + python setup.py sdist upload + +.PHONY: push + hg push + +.PHONY: publish +publish: check-manifest upload push + + +# Development related targets + +# Re-create development environment when setup.py changes +devel: setup.py + rm -rf devel + mkdir devel + +devel/check-manifest: devel + [ -d devel/check-manifest ] \ + || ( ${VIRTUALENV} devel/check-manifest ; \ + devel/check-manifest/bin/pip install --upgrade pip ; \ + devel/check-manifest/bin/pip install --upgrade setuptools ; \ + devel/check-manifest/bin/pip install check-manifest ) + +update_check-manifest: devel/check-manifest + devel/check-manifest/bin/pip -U + +check-manifest: devel/check-manifest + devel/check-manifest/bin/check-manifest + +devel/testenv: devel + [ -d devel/testenv ] \ + || ( ${VIRTUALENV} devel/testenv ; \ + devel/testenv/bin/pip install --upgrade pip ; \ + devel/testenv/bin/pip install --upgrade setuptools ; \ + devel/testenv/bin/pip install tox) + +update_testenv: devel/testenv + devel/testenv/bin/pip -U + +.PHONY: run_tests +run_tests: devel/testenv + devel/testenv/bin/tox --skip-missing-interpreters + +.PHONY: dist +dist: + rm -rf dist + python setup.py sdist + +devel/pytest: devel dist + if [ ! -d devel/pytest ] ; then \ + ( ${VIRTUALENV} devel/pytest ; \ + devel/pytest/bin/pip install --upgrade pip ; \ + devel/pytest/bin/pip install --upgrade setuptools ; \ + devel/pytest/bin/pip install --upgrade wheel ; \ + devel/pytest/bin/pip install dist/pgwui_server-*.tar.gz ; \ + devel/pytest/bin/pip install flake8 ; \ + devel/pytest/bin/pip install pytest-cov ; ) \ + else \ + ( devel/pytest/bin/pip uninstall -y pgwui_server ; \ + devel/pytest/bin/pip install dist/pgwui_server-*.tar.gz ) ; \ + fi + +.PHONY: check +check: devel/pytest + devel/pytest/bin/flake8 . + devel/pytest/bin/py.test --cov=pgwui_server tests + +devel/pudb: devel dist + if [ ! -d devel/pudb ] ; then \ + ( ${VIRTUALENV} devel/pudb ; \ + devel/pudb/bin/pip install --upgrade pip ; \ + devel/pudb/bin/pip install --upgrade setuptools ; \ + devel/pytest/bin/pip install --upgrade wheel ; \ + devel/pudb/bin/pip install dist/pgwui_server-*.tar.gz ; \ + devel/pudb/bin/pip install pudb ; ) \ + else \ + ( devel/pudb/bin/pip uninstall -y pgwui_server ; \ + devel/pudb/bin/pip install dist/pgwui_server-*.tar.gz ) ; \ + fi + +.PHONY: pudb +pudb: devel/pudb + # echo 'import pudb; pu.db' | devel/pudb/bin/python + devel/pudb/bin/python + + +# Expected targets +.PHONY: clean +clean: + #$(MAKE) -C docs clean + rm -rf ${TARGETS} ${EXTRA_TARGETS} ${SETUPTOOLS_STUFF} \ + ${PYTEST_STUFF} ${COVERAGE_STUFF} ${TOX_STUFF} devel diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6b4e258 --- /dev/null +++ b/README.rst @@ -0,0 +1,274 @@ +.. Copyright (C) 2018 The Meme Factory, Inc. http://www.meme.com/ + + + This file is part of PGWUI_Server. + + 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 + . + + Karl O. Pinc + +.. #End Of Copyright Marker# + +PGWUI_Server +=========== + +Short Documentation +------------------- + +PGWUI_Server contains what's needed to put the PGWUI components on the +web. It should be installed by most PGWUI users. The alternative to +installing PGWUI_Server is writing your own `Pyramid`_ application. + +PGWUI_Server stands for `PostgreSQL`_ Web User Interface, Server support. + +PGWUI_Server contains a basic webserver for those who want something +simple and stand-alone. More advanced users may use PGWUI_Server's +WSGI interface to connect to a more full-featured webserver such as +Apache or Nginx. + +PGWUI_Server supports configuration using a traditional *.ini* file. + + +About PGWUI +----------- + +The PGWUI package suite is a Python framework for creating +`PostgreSQL`_ web user interfaces, and a collection of user interfaces +built using the framework.. The focus is on interfaces supporting +bulk data upload or download, on execution of batches of arbitrary +SQL, and on transactions. A distinguishing feature is an emphasis on +discovering and reporting as many errors as is possible per bulk +interaction with the database. + + +Installation +------------ + +Install into a Python 3 virtual environment with commands like:: + + # Create virtual environment + virtualenv -p python3 pgwui_venv + # Install PGWUI web server support + pgwui_venv/bin/pip install pgwui_server + # Install waitress web server (see below)) + pgwui_venv/bin/pip install waitress + # Install desired PGWUI components + pgwui_venv/bin/pip install pgwui_logout + pgwui_venv/bin/pip install pgwui_upload + + +Startup and Usage +----------------- + +Start the stand-alone webserver with:: + + pgwui_venv/bin/pserve pgwui.ini + +PGWUI_Server comes with *waitress* configured as the webserver started +by pserve, and a default waitress configuration. The simplest approach +is to install and use waitress as the applications WSGI server. + +The installation can then be accessed via URLs similar to:: + + http://localhost:6543/logout + +Putting PGWUI on the Internet +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The default configuration does not expose the website to the network. +Of course this can be reconfigured in the .ini file. However exposing +pserve/waitress to the Internet is not recommended. Use a reverse web +proxy instead, or configure your webserver of choice to talk with +PGWUI via WSGI. + +`Nginx`_ is often the simplest, and best, choice for an +Internet-facing web server. A useful reverse-proxy configuration to +connect the default WSGI server to the Internet might be:: + + location / { + proxy_pass http://localhost:6543; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } + +For more information see the `Nginx`_ documentation. + +It is beyond the scope of this documentation to describe how to use +PGWUI_Server's WSGI support. Any WSGI web server can be used with +PGWUI_Server, with or without reverse-proxying. + +"pserve" does not support HTTPS. Consult your webserver documentation +for HTTPS support. + + +Configuration +------------- + +Configuration is done in the ``[app:main]`` section of an ``.ini`` +configuration file. + +Advanced Configuration +^^^^^^^^^^^^^^^^^^^^^^ + +If you do not want to autodetect the installed PGWUI components +you may manually specify them: + +A sample ``.ini`` file:: + + [app:main] + # Turn off component autodetection + pgwui.autoconfigure = False + # The PGWUI components to use + pyramid.include = pgwui_common + pgwui_logout + pgwui_upload + +Manual specification, with or without autoconfiguration, can be +convenient when writing your own components. (It also eliminates the +trivial overhead involved in autoconfiguration.) + +Configuring Routing +^^^^^^^^^^^^^^^^^^^ + +Configuring routing means changing the part of the URL which comes +after the domain, the part after the *https://www.example.com* part. +PGWUI_Server comes with sensible defaults. Configuring routing is +optional. + +A prefix can be put in front of every route, so that instead of the +default route of *logout* in the URL *https://www.example.com/logout* +the URL can be set to +*https://www.example.com/pgwui/programs/logout*:: + + # Set a global route prefix. URLs will look like: + # https://www.example.com/pgwui/programs/logout + pgwui.route_prefix = /pgwui/programs + + +The routes of individual PGWUI components can be changed:: + + pgwui.routes = + # The syntax is: routename = new/route/value + # Make PGWUI Logout available at https://www.example.com/logmeout + logout = /logmeout + # Make PGWUI upload available at https://www.example.com/gimmie + upload = /gimmie + +The route names of each of the PGWUI components is given in their +respective documentation. In general, route names correspond to +component names. + +Both ``pgwui.route_prefix`` and ``pgwui.routes`` may be used in one +configuration. + +Customizing Pages +^^^^^^^^^^^^^^^^^ + +The PGWUI files which control what is displayed on pages and how pages +are displayed can be *overridden*, replaced with files which you have +customized. The files which can be overridden are identified by their +Pyramid asset specifications. + +There are 2 categories of assets, CSS files and `Mako`_ HTML +templates. CSS files control colors, sizes, placement, and the like. +HTML templates are used to generate the page's HTML. Templates +control what is displayed. + +Here is a list of the current asset specifications with brief +descriptions:: + + pgwui_common:static/pgwui.css The CSS file for PGWUI. + + pgwui_common:templates/base.mak Common "background" items on all pages. + + pgwui_common:templates/auth_base.mak Common "background" items on all + pages requesting connection and login data. + + pgwui_logout:templates/logout.mak The logout page. + + pgwui_upload:templates/upload.mak The upload page. + +Assets can be overridden in the configuration file with +``pgwui.override_asset``: + + pgwui.override_asset = + # Syntax is: asset_to_override = override_with + # Paths must be fully qualified. + pgwui_common:static/pgwui.css = /var/www/custom/static/my.css + pgwui_logout:templates/logout.mak = /var/www/custom/templates/mylogout.mak + +When overriding assets it is probably best to start with a copy of the +original file taken from the source code and make changes from there. + +For more information on the override feature and possible values of +``asset_to_override`` and ``override_with`` see: `Overriding Assets +`_ + + +Configuring Your Own Application +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +See the PGWUI_Common documentation for information how to configure +PGWUI if you are writing a complete Pyramid application, or simply +want full control. + + +Development Status +------------------ + +Although in use in production systems, and suitable for production +use, PGWUI_Server must be considered Beta code. There is a reasonable +likelihood that it may undergo some change before final Production +release. Install a specific version of PGWUI_Server to ensure a +backwards incompatible change does not break your code. + + +Developing PGWUI +---------------- + +In addition to the above components, the pyramid_debugtoolbar must be +installed in the virtual environment:: + + pgwui_venv/bin/pip install pyramid_debugtoolbar + + +Complete Documentation +---------------------- + +The complete documentation set can be found on the PGWUI_Server home page at +http://pgwui_server.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 +--------------- + +The PGWUI_Server code is based on the GMI_Pyramid sub-system created for +the `Gombe Mother Infant Database Project +`_. + + +.. _Mako: https://www.makotemplates.org/ +.. _Nginx: https://www.nginx.org/ +.. _PostgreSQL: https://www.postgresql.org/ +.. _Pyramid: https://trypyramid.com/ diff --git a/examples/development.ini b/examples/development.ini new file mode 100644 index 0000000..9475cef --- /dev/null +++ b/examples/development.ini @@ -0,0 +1,122 @@ +### +# app configuration +### + +[app:main] + +# PasteDeploy configuration +# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/paste.html#pastedeploy-entry-points + +use = egg:PGWUI_Server + + +# +# PGWUI configuration +# + +# Postgres client configuration. +# (An empty string for host means use the unix socket.) +pg_host = +pg_port = 5432 + +# What PGWUI modules to use. +pyramid.includes = + pgwui_logout + pgwui_upload + pyramid_debugtoolbar + +# Whether or not to change the db content. +#dry_run = True +dry_run = False + + +# +# Pyramid configuration +# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html +# +pyramid.reload_templates = True +pyramid.debug_authorization = False +pyramid.debug_notfound = False +pyramid.debug_routematch = False +pyramid.default_locale_name = en +#pyramid.includes = +# pyramid_debugtoolbar + +# For turning off the toolbar +#pyramid.debug_authorization = False +#pyramid.debug_notfound = False +#pyramid.debug_routematch = False +#pyramid.default_locale_name = en + +# By default, the toolbar only appears for clients from IP addresses +# '127.0.0.1' and '::1'. +# debugtoolbar.hosts = 127.0.0.1 ::1 + + +# +# Beaker session management configuration +# https://beaker.readthedocs.io/en/latest/configuration.html +# +session.type = memory +session.lock_dir = /var/lock/pgwui_server +# Remove cookie in browser on browser close. +session.cookie_expires = True +session.key = pgwui_server +# HMAC secret +#session.secret = xxxxxxrandomstring40characterslongxxxxxxx +# Send cookie only over https +# (True for production) +session.secure = False +# Sessions timeout after an hour if unused. +session.timeout = 3600 +# Pyramid sends cookies for exception pages +session.cookie_on_exception = True + + +# +# Mako templates +# +#mako.strict_undefined = True + + +### +# wsgi server configuration +### + +[server:main] +use = egg:waitress#main +host = 127.0.0.1 +port = 6543 + + +### +# logging configuration +# http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html +### + +[loggers] +keys = root, pgwui_server + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = INFO +handlers = console + +[logger_pgwui_server] +level = DEBUG +handlers = +qualname = pgwui_server + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s diff --git a/examples/pgwui.ini b/examples/pgwui.ini new file mode 100644 index 0000000..74b563b --- /dev/null +++ b/examples/pgwui.ini @@ -0,0 +1,127 @@ +### +# app configuration +### + +[app:main] + +# PasteDeploy configuration +# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/paste.html#pastedeploy-entry-points + +use = egg:PGWUI_Server + + +# +# PGWUI configuration +# + +# Postgres client configuration. +# (An empty string for host means use the unix socket.) +pg_host = +pg_port = 5432 + +# What PGWUI modules to use. +pyramid.includes = + pgwui_logout + pgwui_upload + +# Whether or not to change the db content. +dry_run = False + + +# +# Pyramid configuration +# https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html +# +pyramid.reload_templates = False +pyramid.debug_authorization = False +pyramid.debug_notfound = False +pyramid.debug_routematch = False +pyramid.default_locale_name = en + + +# +# Beaker session management configuration +# https://beaker.readthedocs.io/en/latest/configuration.html +# +session.type = memory +session.lock_dir = /var/lock/pgwui_server +# Remove cookie in browser on browser close. +session.cookie_expires = True +session.key = pgwui_server +# HMAC secret +#session.secret = xxxxxxrandomstring40characterslongxxxxxxx +# Send cookie only over https +session.secure = True +# Sessions timeout after an hour if unused. +session.timeout = 3600 +# Pyramid sends cookies for exception pages +session.cookie_on_exception = True + + +# +# Mako templates +# +#mako.strict_undefined = True + + +### +# wsgi server configuration +### + +[server:main] +# When using a standalone WSGI server like uwsgi or Apache's mod_wsgi +# use the pgwui_server's WSGI. +#use = egg:PGWUI_Server + +# Use waitress as the webserver and configure a reverse-proxy to the network. +# +# An Nginx (https://www.nginx.org) reverse-proxy configuration might look like: +# +# location / { +# proxy_pass http://localhost:6543; +# proxy_set_header Host $host; +# proxy_set_header X-Real-IP $remote_addr; +# } +# +use = egg:waitress#main +host = 127.0.0.1 +port = 6543 + + +### +# logging configuration +# http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/logging.html +### + +[loggers] +keys = root, pgwui_server + +[handlers] +keys = syslog, console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console + +[logger_pgwui_server] +level = INFO +handlers = +qualname = pgwui_server + +[handler_syslog] +class = logging.handlers.SysLogHandler +args = ('/dev/log',) +level = NOTSET +formatter = generic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(asctime)s %(levelname)-5.5s [%(name)s][%(threadName)s] %(message)s diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..24eff81 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[bdist_wheel] +# Work with both python 2 and 3. +universal=1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..22e2a41 --- /dev/null +++ b/setup.py @@ -0,0 +1,175 @@ +"""A setuptools based setup module. + +Copied from: +https://github.com/pypa/sampleproject +It's license applies to this file. +""" +# Copyright (c) 2016 The Python Packaging Authority (PyPA) +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. + + +# Always prefer setuptools over distutils +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + + +# Get the long description from the README file +def filter_readme(): + '''Return README content with copyright at top removed''' + lines = [] + past_copyright = False + with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + for line in f: + if past_copyright: + lines.append(line) + else: + if line == '.. #End Of Copyright Marker#\n': + past_copyright = True + return ''.join(lines) + + +here = path.abspath(path.dirname(__file__)) + +# Get program version +with open(path.join(here, 'src', 'pgwui_server', 'VERSION'), + encoding='utf-8') as version_file: + version = version_file.read().strip() + +# Get the long description from the README file +long_description = filter_readme() + +setup( + name='pgwui_server', + + # Versioning is major.minor.fixes. Major releases change (after 1.0.0) + # when backward incompatibility is introduced. Minor releases introduce + # new features. Fix releases introduce fixes. + version=version, + + description=( + 'Web server and WSGI app for the Postgres Web Interface programs.'), + long_description=long_description, + + # The project's main homepage. + url='http://pgwui_server.readthedocs.io/', + + # Author details + author='Karl O. Pinc', + author_email='kop@meme.com', + + # Choose your license + license='AGPLv3+', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + # How mature is this project? Common values are + # 3 - Alpha + # 4 - Beta + # 5 - Production/Stable + 'Development Status :: 4 - Beta', + + # Indicate who your project is intended for + 'Environment :: Web Environment', + 'Framework :: Pyramid', + 'Intended Audience :: End Users/Desktop', + 'Intended Audience :: Information Technology', + 'Intended Audience :: Science/Research', + 'Intended Audience :: System Administrators', + 'Topic :: Database :: Front-Ends', + 'Topic :: Internet :: WWW/HTTP', + 'Topic :: Scientific/Engineering', + 'Topic :: Utilities', + + # Pick your license as you wish (should match "license" above) + ('License :: OSI Approved ' + ':: GNU Affero General Public License v3 or later (AGPLv3+)'), + + # Specify the Python versions you support here. In particular, ensure + # that you indicate whether you support Python 2, Python 3 or both. + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + ], + + # What does your project relate to? + keywords=( + 'batch', + 'batch upload', + 'bulk', + 'bulk data upload', + 'bulk upload', + 'data upload', + 'database front end', + 'error reporting', + 'interface', + 'Postgres', + 'Postgres user interface', + 'Postgres web interface', + 'PostgreSQL', + 'Postgres front end', + 'transaction', + 'upload', + 'user interface', + 'web', + 'web front end', + ), + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + packages=find_packages('src'), + package_dir={'': 'src'}, + + # Run-time dependencies. + install_requires=[ + 'pyramid', + ], + + # List additional groups of dependencies here (e.g. development + # dependencies). You can install these using the following syntax, + # for example: + # $ pip install -e .[dev,test] + # extras_require={ + # 'dev': ['check-manifest'], + # 'test': ['coverage'], + # }, + + # If there are data files included in your packages that need to be + # installed, specify them here. + package_data={ + 'pgwui_server': [ + 'src/pgwui_server/VERSION', + 'examples/development.ini', + 'examples/pgwui.ini', + ], + }, + + # To provide executable scripts, use entry points in preference to the + # "scripts" keyword. Entry points provide cross-platform support and allow + # pip to create the appropriate form of executable for the target platform. + entry_points="""\ + [paste.app_factory] + main = pgwui_server:main + """ + # }, +) diff --git a/src/pgwui_server/VERSION b/src/pgwui_server/VERSION new file mode 100644 index 0000000..77d6f4c --- /dev/null +++ b/src/pgwui_server/VERSION @@ -0,0 +1 @@ +0.0.0 diff --git a/src/pgwui_server/__init__.py b/src/pgwui_server/__init__.py new file mode 100644 index 0000000..0e5a17b --- /dev/null +++ b/src/pgwui_server/__init__.py @@ -0,0 +1,35 @@ +# Copyright (C) 2018 The Meme Factory, Inc. http://www.meme.com/ + +# This file is part of PGWUI_Server. +# +# 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 +# . +# + +# Karl O. Pinc + +'''Provide a way to configure PGWUI. +''' + +from pyramid.config import Configurator + + +def main(global_config, **settings): + '''Return a Pyramid WSGI application + ''' + rp = settings.get('pgwui.route_prefix') + config = Configurator(settings=settings, + route_prefix=rp) + config.include('pgwui_common') + return config.make_wsgi_app() diff --git a/tests/test___init__.py b/tests/test___init__.py new file mode 100644 index 0000000..cf1c0ae --- /dev/null +++ b/tests/test___init__.py @@ -0,0 +1,40 @@ +# Copyright (C) 2018 The Meme Factory, Inc. http://www.meme.com/ + +# This file is part of PGWUI_Server. +# +# 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 +# . +# + +# Karl O. Pinc + +import pgwui_server.__init__ as pgwui_server_init + + +class MockConfigurator(): + def __init__(self, **kwargs): + pass + + def make_wsgi_app(self): + return 'wsgi_app' + + def include(self, *args): + pass + + +def test_configure_includecalled(monkeypatch): + monkeypatch.setattr(pgwui_server_init, 'Configurator', MockConfigurator) + + result = pgwui_server_init.main({}) + assert result == 'wsgi_app' diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..a8e4a66 --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +[tox] +envlist = py{34,35,36,37} + +[testenv] +basepython = + py34: python3.4 + py35: python3.5 + py36: python3.6 + py37: python3.7 +deps = + check-manifest + cmarkgfm + flake8 + pytest + pytest-cov + twine + # coverage +commands = + check-manifest + python setup.py sdist + twine check dist/* + flake8 . + py.test --cov=pgwui_server tests/ + # coverage run --source src/pgwui_server -m py.test + # coverage report + +[flake8] +exclude = .tox,*.egg,build,data,devel +select = E,W,F +ignore = W503 -- 2.34.1