diff --git a/.gitignore b/.gitignore index a596a28..212ca21 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1 @@ -*~ -*.pyc Messkit.egg-info/ -dist/ -docs/_build/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 032f33c..9793277 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,60 +5,6 @@ All notable changes to Messkit will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## v0.2.1 (2024-07-01) - -### Fix - -- use rattail function to create top-level command - -## v0.2.0 (2024-06-10) - -### Feat - -- **license**: declare project license as GNU GPL v3+ -- switch from setup.cfg to pyproject.toml + hatchling - -## [0.1.8] - 2023-10-29 -### Changed -- Remove custom emails collection. - -## [0.1.7] - 2023-02-03 -### Changed -- Remove custom list of app settings. -- Add default settings for class/table prefix. -- Use parent methods for print/prompt in install command. -- Use upstream logic for install command, and some web menus. - -## [0.1.6] - 2022-12-28 -### Changed -- Expose some more app settings. -- Add ASGI app wrapper. - -## [0.1.5] - 2022-03-07 -### Changed -- Keep `docs/_static/` folder around to prevent doc build errors. -- Force master doc to 'index' for Sphinx. -- Restrict which email settings come out of the box. -- Add `enum` module, include whatever poser says. - -## [0.1.4] - 2022-03-05 -### Changed -- Remove `--reload` flag from suggested web app command. - -## [0.1.3] - 2022-03-05 -### Changed -- Nod to mysql in the installer intro msg. -- Add `web/static/img` folder to manifest. - -## [0.1.2] - 2022-03-05 -### Changed -- Set default theme and images when installing. -- Include app setting for production flag. -- Add support for including some views based on DB settings. -- Add support for mysql database as messkit backend. -- Add upgrade script/config to installer. -- Add initial docs. - ## [0.1.1] - 2022-03-03 ### Added - Initial version...sort of. diff --git a/COPYING.txt b/COPYING.txt deleted file mode 100644 index 94a9ed0..0000000 --- a/COPYING.txt +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 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 General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is 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. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - 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. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - 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 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. Use with the GNU Affero General Public License. - - 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 Affero 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 special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU 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 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 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 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 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 General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - 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 GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 09e46ee..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,7 +0,0 @@ - -include *.md -include *.rst - -recursive-include messkit/templates *.mako - -recursive-include messkit/web/static *.png diff --git a/README.md b/README.rst similarity index 80% rename from README.md rename to README.rst index bea370f..c61b2c3 100644 --- a/README.md +++ b/README.rst @@ -1,4 +1,5 @@ -# Messkit +Messkit +======== Hopefully some kind of generic data manipulation thingy, we'll see... diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d4bb2cb..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/_static/.keepme b/docs/_static/.keepme deleted file mode 100644 index e69de29..0000000 diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 77357ef..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,65 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# TODO: not sure why i had to explicitly declare this for the sake of buildbot, -# when it worked for me fine locally without doing this. -master_doc = 'index' - - -# -- Project information ----------------------------------------------------- - -project = 'Messkit' -copyright = '2022, Lance Edgar' -author = 'Lance Edgar' - -# The full version, including alpha/beta/rc tags -release = '0.1' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.intersphinx', -] - -intersphinx_mapping = { - 'rattail-manual': ('https://docs.wuttaproject.org/rattail-manual/', None), -} - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] diff --git a/docs/features.rst b/docs/features.rst deleted file mode 100644 index 2703c29..0000000 --- a/docs/features.rst +++ /dev/null @@ -1,88 +0,0 @@ - -Features -======== - -This page lists the "completed" features for Messkit. All of the -following are considered working and stable. - -Also note, here we only highlight features deemed Messkit-specific. -Since Messkit is built on top of lots of other tech, there are `many -more features`_ which have been complete for years. Most of those -underlying features assumed a programmer would "glue" components -together in code, whereas Messkit is trying to let the admin user do -that via web app instead. So this feature list reflects only the -Messkit-specific goals. - -.. _`many more features`: https://rattailproject.org/moin/TheBigTour - - -Configurable Menus ------------------- - -Nearly the entire top-level menu is editable. The "user" menu (far -right of top menu) is *not* editable, but all other top-level menus -are "fully" editable. - -(More complexity should be allowed yet, e.g. adding a submenu, but the -common needs are met already.) - -Go to the App Settings page (/settings/app/) and from the "Go To -Configure" dropdown choose Menus. - - -Configurable Views ------------------- - -This is related to the previous point (e.g. a menu entry usually -references some sort of view), but is definitely a separate concern. - -First to clarify.. A "view" in this context really means a "Python -module containing view logic" and that "view logic" is what responds -to user requests and displays data etc. Most often a particular view -is tied to a particular table in the DB. - -Messkit comes with many views built-in, but not all will be relevant -to you. For instance you might need to see Employees but not -Products. - -Messkit allows for any such built-in view to be: - -* disabled -* enabled, using default view module -* enabled, using custom view module - -Go to the App Settings page (/settings/app/) and from the "Go To -Configure" dropdown choose Included Views. - - -Custom Reports --------------- - -Messkit comes with "some" reports built-in. However there are very -few and they serve mostly as examples. - -First to clarify, a "report" in this context really means a "Python -module containing report logic" and that "report logic" is what -generates the output file. - -Messkit allows you to create new reports (Python modules) to suit your -needs. Reporting needs can vary wildly, so Messkit does not try to -provide the full interface to create a "complete" detailed report. -But it can generate some skeleton code and get you started in the -right direction. - -More "flavors" of sample code generation should be added, but there -are some basic ones in place already. Namely they allow for either -using raw SQL to query tables, or alternately can use the SQLAlchemy -models which then auto-generate the SQL needed. - -At this time Messkit does not have any smarts about "other systems" -and therefore sample code it generates will only show how to query the -Messkit database. As time goes on more sample code will be added, -which shows how to query other (e.g. POS) databases, as well as e.g. -web API for some systems. - -Messkit "blends" the custom reports with its built-in reports, in the -user interface. Meaning, if a user goes to generate a new report -(i.e. run a module to produce output) then they will see all available -reports in the same list. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index f6b9fcd..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,40 +0,0 @@ - -Messkit -======= - -Got a mess goin' on? There's a kit for that... - -.. image:: ../messkit/web/static/img/messkit.png - :height: 300px - -Messkit aims to be a "custom app in a box" for operational data -management, automation etc. Sort of like a spreadsheet on sterroids, -where the user defines the data layout and behavior as much as -possible. - -It comes with several tables to store commonly-needed data, but the -goal is to provide an easy interface to add extra tables (and -importers!) etc. as needed. - -For now Messkit is very much a work in progress! But nearly all of -the underlying tech has been in production for years, so is quite -stable. Installation is quick and painless (as is upgrading) so get -started today and enjoy the evolution... - - - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - install - features - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/install.rst b/docs/install.rst deleted file mode 100644 index 5fdd701..0000000 --- a/docs/install.rst +++ /dev/null @@ -1,157 +0,0 @@ - -.. highlight:: sh - -Installation -============ - -We'll try to keep this brief but link to further reading where needed. - - -Prerequisites -------------- - -* Linux strongly recommended -* Python 3 -* database in PostgreSQL or MySQL (or ??) - -Linux is recommended because effectively "all" production testing has -happened on Debian and Ubuntu specifically. But the project is all -Python so should run anywhere as long as the code is accounting for -that...which to be honest it may not be in all places yet. - -The assumption is that you already have Python 3, unless on Windows in -which case see :doc:`rattail-manual:base/install/windows/python`. - -You can ostensibly use any backend `supported by SQLAlchemy`_ to store -your Messkit database; however in practice PostgreSQL has had a -gazillion times more production testing and is highly recommended. -MySQL/MariaDB also have seen some basic testing and are believed to -work fine. - -.. _`supported by SQLAlchemy`: https://docs.sqlalchemy.org/en/13/dialects/index.html - -Note that the database need not live on the same machine as the -Messkit app. - -The Messkit installer currently only supportes PostgreSQL and -MySQL/MariaDB, so if another backend is desired it just means the -installer can't automate setup for you, but manual setup is still -possible. - - -Messkit -------- - -Create a virtual environment for Messkit, e.g.:: - - python3 -m venv /path/to/envs/messkit - -If you're new to these see also :doc:`rattail-manual:base/venv`. - -Be sure to activate your virtual environment:: - - source /path/to/envs/messkit/bin/activate - -Next install the Messkit package to your environment:: - - pip install Messkit - -Now setup your database backend. Messkit will need a database, and it -will need to connect to that database with a particular set of user -credentials. - -Depending on your backend type, create the user account. The default -username is ``rattail`` so we'll assume that here. Whatever username -and password you set will be needed for the final Messkit setup. - -PostgreSQL:: - - sudo -u postgres createuser -P rattail - -MySQL:: - - sudo mysql -e "create user rattail@localhost" - sudo mysql -e "alter user rattail@localhost identified by 'THEPASSWORD'" - -Next create the database itself. - -PostgreSQL:: - - sudo -u postgres createdb -O rattail messkit - -MySQL:: - - sudo mysqladmin create messkit - sudo mysql -e "grant all on messkit.* to rattail@localhost" - -Finally run the Messkit installer. When it asks for **db type** you -can enter ``mysql`` or just accept the ``postgresql`` default. You -are advised to answer "yes" to all yes/no questions:: - - messkit -n install - -With that complete you should be able to run the web app with:: - - cd /path/to/envs/messkit - bin/pserve file+ini:app/web.conf - -Please note, you should have created an admin user during the Messkit -installer. You should be able to login to the web app with those -credentials, but by default even an "admin" user can't do much of -anything. - -However an admin user has a special power - they can "become root" -which means the same as it does for Linux. When you do this all -features which exist become unlocked. The expectation for a -"production" app is that you would define roles and grant them -permissions etc. as needed. But while testing you can just "become -root" and not really worry about the permissions. - - -Upgrading ---------- - -Upgrades are done directly in the web app, and basic details of each -are recorded. - -Default menu location is Admin -> Messkit Upgrades. Create a new -upgrade, make sure it is enabled, then execute it. That's all! - -Although, the default upgrade script will not actually restart the web -app for you, so after an upgrade completes successfully you should -restart the web app manually. - - -Starting Over -------------- - -A major goal for Messkit is to make "starting over" a simple thing, to -encourage users to experiment with it. Maybe you even keep one app in -production while having others reserved for trying new things. - -The installer is of course a big part of that, so hopefully it's easy -enough, but suggestions for improvements are always welcome! - -But depending on your situation you may prefer to "destroy" the -previous attempt before installing a new app etc. Really that is just -2 steps: - -Remove entirely your "app" folder, e.g.:: - - cd /path/to/envs/messkit - rm -rf app - -Then drop and re-create your database. Commands for creating a -database are shown above, but here are the drops. - -PostgreSQL:: - - sudo -u postgres dropdb messkit - -MySQL:: - - sudo mysqladmin drop messkit - -With that done you can re-run the installer:: - - messkit -n install diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 153be5e..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=. -set BUILDDIR=_build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/messkit/_version.py b/messkit/_version.py index 09e600c..4984097 100644 --- a/messkit/_version.py +++ b/messkit/_version.py @@ -1,6 +1,3 @@ # -*- coding: utf-8; -*- -from importlib.metadata import version - - -__version__ = version('Messkit') +__version__ = '0.1.1' diff --git a/messkit/enum.py b/messkit/appsettings.py similarity index 83% rename from messkit/enum.py rename to messkit/appsettings.py index c25b5ca..57d5d83 100644 --- a/messkit/enum.py +++ b/messkit/appsettings.py @@ -21,12 +21,15 @@ # ###################################################################### """ -Messkit Enumerations +Messkit app settings """ -from rattail.enum import * +# bring in some common settings from rattail +from rattail.settings import ( -try: - from poser.enum import * -except ImportError: - pass + # (General) + rattail_app_title, + + # Mail + rattail_mail_record_attempts, +) diff --git a/messkit/commands.py b/messkit/commands.py index 921161e..e9fde15 100644 --- a/messkit/commands.py +++ b/messkit/commands.py @@ -2,7 +2,7 @@ ###################################################################### # # Messkit -- Generic-ish Data Utility App -# Copyright © 2022-2024 Lance Edgar +# Copyright © 2022 Lance Edgar # # This file is part of Messkit. # @@ -24,34 +24,226 @@ Messkit commands """ -import typer +import os +import sys +import subprocess -from rattail.commands.typer import make_typer +import sqlalchemy as sa +from prompt_toolkit import prompt +from prompt_toolkit.styles import Style +from rich import print as rprint +from alembic.util.messaging import obfuscate_url_pw + +from rattail import commands + +from messkit import __version__ -messkit_typer = make_typer( - name='messkit', - help="Messkit (Generic Data App)" -) - - -@messkit_typer.command() -def install( - ctx: typer.Context, -): +def main(*args): """ - Install the Messkit app + Main entry point for Messkit command system """ - from messkit.install import MesskitInstallHandler + args = list(args or sys.argv[1:]) + cmd = Command() + cmd.run(*args) - config = ctx.parent.rattail_config - handler = MesskitInstallHandler( - config, - app_title="Messkit", - app_package='messkit', - app_eggname='Messkit', - app_pypiname='Messkit', - main_image_url='/messkit/img/messkit.png', - header_image_url='/messkit/img/messkit-small.png', - favicon_url='/messkit/img/messkit-small.png') - handler.run() + +class Command(commands.Command): + """ + Main command for Messkit + """ + name = 'messkit' + version = __version__ + description = "Messkit (Generic Data App)" + long_description = '' + + +class Install(commands.Subcommand): + """ + Install a Messkit app + """ + name = 'install' + description = __doc__.strip() + + def run(self, args): + + rprint("\n\t[blue]Welcome to Messkit![/blue]") + rprint("\n\tThis tool will install and configure a new app.") + rprint("\n\t[italic]NB. You should already have created a new database in PostgreSQL.[/italic]") + + # get appdir path + appdir = os.path.join(sys.prefix, 'app') + appdir = self.basic_prompt('appdir path', appdir) + + # appdir must not yet exist + if os.path.exists(appdir): + rprint("\n\t[bold red]appdir already exists:[/bold red] {}\n".format(appdir)) + sys.exit(1) + + # get db info + dbhost = self.basic_prompt('postgres host', 'localhost') + dbport = self.basic_prompt('postgres port', '5432') + dbname = self.basic_prompt('postgres db', 'messkit') + dbuser = self.basic_prompt('postgres user', 'rattail') + + # get db password + dbpass = None + while not dbpass: + dbpass = self.basic_prompt('postgres pass', is_password=True) + + # test db connection + rprint("\n\ttesting db connection... ", end='') + dburl = self.make_db_url(dbhost, dbport, dbname, dbuser, dbpass) + error = self.test_db_connection(dburl) + if error: + rprint("[bold red]cannot connect![/bold red] ..error was:") + rprint("\n{}".format(error)) + rprint("\n\t[bold yellow]aborting mission[/bold yellow]\n") + sys.exit(1) + rprint("[bold green]good[/bold green]") + + # make the appdir + self.app.make_appdir(appdir) + + # make config files + context = { + 'app_title': "Messkit", + 'appdir': appdir, + 'db_url': dburl, + 'pyramid_egg': 'Messkit', + 'beaker_key': 'messkit', + } + rattail_conf = self.app.make_config_file( + 'rattail-complete', os.path.join(appdir, 'rattail.conf'), + **context) + quiet_conf = self.app.make_config_file('quiet', appdir) + web_conf = self.app.make_config_file( + 'web-complete', os.path.join(appdir, 'web.conf'), + **context) + + rprint("\n\tappdir created at: [bold green]{}[/bold green]".format(appdir)) + + bindir = os.path.join(sys.prefix, 'bin') + + schema_installed = False + if self.basic_prompt("install db schema?", True, is_bool=True): + rprint() + + # install db schema + alembic = os.path.join(bindir, 'alembic') + cmd = [alembic, '-c', rattail_conf, 'upgrade', 'heads'] + subprocess.check_call(cmd) + schema_installed = True + + rprint("\n\tdb schema installed to: [bold green]{}[/bold green]".format( + obfuscate_url_pw(dburl))) + + if self.basic_prompt("create admin user?", True, is_bool=True): + + # get admin credentials + username = self.basic_prompt('admin username', 'admin') + password = None + while not password: + password = self.basic_prompt('admin password', is_password=True) + if password: + confirm = self.basic_prompt('confirm password', is_password=True) + if not confirm or confirm != password: + rprint("[bold yellow]passwords did not match[/bold yellow]") + password = None + + rprint() + + # make admin user + rattail = os.path.join(bindir, 'rattail') + cmd = [rattail, '-c', quiet_conf, 'make-user', '-A', username, + '--password', password] + subprocess.check_call(cmd) + + rprint("\n\tadmin user created: [bold green]{}[/bold green]".format( + username)) + + if self.basic_prompt("make poser dir?", True, is_bool=True): + rprint() + + poser_handler = self.app.get_poser_handler() + poserdir = poser_handler.make_poser_dir() + + rprint("\n\tposer dir created: [bold green]{}[/bold green]".format( + poserdir)) + + rprint("\n\t[bold green]initial setup is complete![/bold green]") + + if schema_installed: + rprint("\n\tyou can run the web app with this command:") + pserve = os.path.join(bindir, 'pserve') + rprint("\n\t[blue]{} --reload file+ini:{}[/blue]".format(pserve, web_conf)) + + rprint() + + def basic_prompt(self, info, default=None, is_password=False, is_bool=False): + + # message formatting styles + style = Style.from_dict({ + '': '', + 'bold': 'bold', + }) + + # build prompt message + message = [ + ('', '\n'), + ('class:bold', info), + ] + if default is not None: + if is_bool: + message.append(('', ' [{}]: '.format('Y' if default else 'N'))) + else: + message.append(('', ' [{}]: '.format(default))) + else: + message.append(('', ': ')) + + # prompt user for input + try: + text = prompt(message, style=style, is_password=is_password) + except (KeyboardInterrupt, EOFError): + rprint("\n\t[bold yellow]operation canceled by user[/bold yellow]\n", + file=self.stderr) + sys.exit(2) + + if is_bool: + if text == '': + return default + elif text.upper() == 'Y': + return True + elif text.upper() == 'N': + return False + rprint("\n\t[bold yellow]ambiguous, please try again[/bold yellow]\n") + return self.basic_prompt(info, default, is_bool=True) + + return text or default + + def make_db_url(self, dbhost, dbport, dbname, dbuser, dbpass): + try: + # newer style + from sqlalchemy.engine import URL + factory = URL.create + except ImportError: + # older style + from sqlalchemy.engine.url import URL + factory = URL + + return factory(drivername='postgresql+psycopg2', + username=dbuser, + password=dbpass, + host=dbhost, + port=dbport, + database=dbname) + + def test_db_connection(self, url): + engine = sa.create_engine(url) + + # check for random table; does not matter if it exists, we + # just need to test interaction and this is a neutral way + try: + engine.has_table('whatever') + except Exception as error: + return str(error) diff --git a/messkit/config.py b/messkit/config.py index cdd034c..a5bb434 100644 --- a/messkit/config.py +++ b/messkit/config.py @@ -2,7 +2,7 @@ ###################################################################### # # Messkit -- Generic-ish Data Utility App -# Copyright © 2022-2024 Lance Edgar +# Copyright © 2022 Lance Edgar # # This file is part of Messkit. # @@ -40,12 +40,12 @@ class MesskitConfig(ConfigExtension): # set some default config values config.setdefault('rattail', 'app_title', "Messkit") - config.setdefault('rattail', 'app_class_prefix', 'Messkit') - config.setdefault('rattail', 'app_table_prefix', 'messkit') - config.setdefault('rattail', 'enum', 'messkit.enum') + config.setdefault('tailbone', 'menus', 'messkit.web.menus') + config.setdefault('rattail', 'model', 'messkit.db.model') + config.setdefault('rattail', 'settings', 'messkit.appsettings') - # model - config.setdefault('rattail.model_spec', 'messkit.db.model') - - # menus - config.setdefault('rattail.web.menus.handler_spec', 'messkit.web.menus:MesskitMenuHandler') + # # always try to append poser to path + # # TODO: location of poser dir should come from config/app/handler? + # poser = os.path.join(sys.prefix, 'app', 'poser') + # if poser not in sys.path and os.path.isdir(poser): + # sys.path.append(poser) diff --git a/messkit/web/app.py b/messkit/web/app.py index dd64e33..a9c6ea0 100644 --- a/messkit/web/app.py +++ b/messkit/web/app.py @@ -52,12 +52,3 @@ def main(global_config, **settings): under='pyramid_tm.tm_tween_factory') return pyramid_config.make_wsgi_app() - - -def asgi_main(): - """ - This function returns an ASGI application. - """ - from tailbone.asgi import make_asgi_app - - return make_asgi_app(main) diff --git a/messkit/web/menus.py b/messkit/web/menus.py index f10a713..932ecaa 100644 --- a/messkit/web/menus.py +++ b/messkit/web/menus.py @@ -2,7 +2,7 @@ ###################################################################### # # Messkit -- Generic-ish Data Utility App -# Copyright © 2022-2024 Lance Edgar +# Copyright © 2022 Lance Edgar # # This file is part of Messkit. # @@ -24,36 +24,117 @@ Web Menus """ -from tailbone import menus as base +def simple_menus(request): + url = request.route_url -class MesskitMenuHandler(base.TailboneMenuHandler): - """ - Messkit menu handler - """ + # reports_menu = { + # 'title': "Reports", + # 'type': 'menu', + # 'items': [ + # { + # 'title': "New Report", + # 'url': url('report_output.create'), + # 'perm': 'report_output.create', + # }, + # { + # 'title': "Generated Reports", + # 'url': url('report_output'), + # 'perm': 'report_output.list', + # }, + # { + # 'title': "Problem Reports", + # 'url': url('problem_reports'), + # 'perm': 'problem_reports.list', + # }, + # ], + # } - def make_menus(self, request, **kwargs): + # other_menu = { + # 'title': "Other", + # 'type': 'menu', + # 'items': [ + # { + # 'title': "Generate New Feature", + # 'url': url('generate_feature'), + # 'perm': 'common.generate_feature', + # }, + # { + # 'title': "Generate New Project", + # 'url': url('generate_project'), + # 'perm': 'common.generate_project', + # }, + # ], + # } - people_menu = { - 'title': "People", - 'type': 'menu', - 'items': [ - { - 'title': "All People", - 'route': 'people', - 'perm': 'people.list', - }, - ], - } + admin_menu = { + 'title': "Admin", + 'type': 'menu', + 'items': [ + { + 'title': "Users", + 'url': url('users'), + 'perm': 'users.list', + }, + # { + # 'title': "User Events", + # 'url': url('userevents'), + # 'perm': 'userevents.list', + # }, + { + 'title': "Roles", + 'url': url('roles'), + 'perm': 'roles.list', + }, + {'type': 'sep'}, + { + 'title': "App Settings", + 'url': url('appsettings'), + 'perm': 'settings.list', + }, + { + 'title': "Email Settings", + 'url': url('emailprofiles'), + 'perm': 'emailprofiles.list', + }, + # { + # 'title': "Email Attempts", + # 'url': url('email_attempts'), + # 'perm': 'email_attempts.list', + # }, + { + 'title': "Raw Settings", + 'url': url('settings'), + 'perm': 'settings.list', + }, + {'type': 'sep'}, + # { + # 'title': "DataSync Changes", + # 'url': url('datasyncchanges'), + # 'perm': 'datasync_changes.list', + # }, + # { + # 'title': "Importing / Exporting", + # 'url': url('importing'), + # 'perm': 'importing.list', + # }, + { + 'title': "Tables", + 'url': url('tables'), + 'perm': 'tables.list', + }, + { + 'title': "Messkit Upgrades", + 'url': url('upgrades'), + 'perm': 'upgrades.list', + }, + ], + } - reports_menu = self.make_reports_menu(request, include_poser=True) + menus = [ + # reports_menu, + # other_menu, + admin_menu, + ] - admin_menu = self.make_admin_menu(request, include_stores=False) - - menus = [ - people_menu, - reports_menu, - admin_menu, - ] - - return menus + return menus diff --git a/messkit/web/static/img/messkit-small.png b/messkit/web/static/img/messkit-small.png deleted file mode 100644 index f466840..0000000 Binary files a/messkit/web/static/img/messkit-small.png and /dev/null differ diff --git a/messkit/web/static/img/messkit.png b/messkit/web/static/img/messkit.png deleted file mode 100644 index ea64f93..0000000 Binary files a/messkit/web/static/img/messkit.png and /dev/null differ diff --git a/messkit/web/views/__init__.py b/messkit/web/views/__init__.py index 378c518..b3c55d6 100644 --- a/messkit/web/views/__init__.py +++ b/messkit/web/views/__init__.py @@ -2,7 +2,7 @@ ###################################################################### # # Messkit -- Generic-ish Data Utility App -# Copyright © 2022-2023 Lance Edgar +# Copyright © 2022 Lance Edgar # # This file is part of Messkit. # @@ -24,12 +24,26 @@ Messkit web views """ -from tailbone.util import include_configured_views - def includeme(config): - config.include('tailbone.views.essentials') + # core + config.include('messkit.web.views.common') + config.include('tailbone.views.auth') + config.include('tailbone.views.menus') + # config.include('tailbone.views.importing') config.include('tailbone.views.poser') + config.include('tailbone.views.progress') - include_configured_views(config) + # config.include('tailbone.views.features') + + config.include('tailbone.views.reports') + + # main tables + config.include('tailbone.views.email') + config.include('tailbone.views.people') + config.include('tailbone.views.roles') + config.include('tailbone.views.settings') + config.include('tailbone.views.tables') + config.include('tailbone.views.upgrades') + config.include('tailbone.views.users') diff --git a/messkit/install.py b/messkit/web/views/common.py similarity index 54% rename from messkit/install.py rename to messkit/web/views/common.py index 041ecc7..a2b2664 100644 --- a/messkit/install.py +++ b/messkit/web/views/common.py @@ -2,7 +2,7 @@ ###################################################################### # # Messkit -- Generic-ish Data Utility App -# Copyright © 2022-2024 Lance Edgar +# Copyright © 2022 Lance Edgar # # This file is part of Messkit. # @@ -21,32 +21,19 @@ # ###################################################################### """ -Messkit install handler +Common views """ -from rattail import install as base -from rattail.commands.util import rprint, basic_prompt +from tailbone.views import common as base + +import messkit -class MesskitInstallHandler(base.InstallHandler): - """ - Custom install handler for Messkit - """ +class CommonView(base.CommonView): - def do_install_steps(self): - super().do_install_steps() - self.install_poser() + project_title = "Messkit" + project_version = messkit.__version__ + '+dev' - def install_poser(self): - if not basic_prompt("make poser dir?", True, is_bool=True): - return False - rprint() - - # make poser dir - poser_handler = self.app.get_poser_handler() - poserdir = poser_handler.make_poser_dir() - - rprint("\n\tposer dir created: [bold green]{}[/bold green]".format( - poserdir)) - return True +def includeme(config): + CommonView.defaults(config) diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index c723e0b..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,69 +0,0 @@ - -[build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" - - -[project] -name = "Messkit" -version = "0.2.1" -description = "Generic-ish Data Utility App" -readme = "README.md" -authors = [{name = "Lance Edgar", email = "lance@edbob.org"}] -license = {text = "GNU GPL v3+"} -classifiers = [ - "Development Status :: 3 - Alpha", - "Environment :: Console", - "Environment :: Web Environment", - "Framework :: Pyramid", - "Intended Audience :: Developers", - "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", - "Natural Language :: English", - "Operating System :: POSIX :: Linux", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Topic :: Office/Business", -] -dependencies = [ - - # TODO: user should get to choose which of these is needed? - "mysql-connector-python", - "psycopg2", - - "prompt_toolkit", - "rich", - "Sphinx", - "Tailbone", - "typer", -] - - -[project.scripts] -messkit = "messkit.commands:messkit_typer" - - -[project.entry-points."paste.app_factory"] -main = "messkit.web.app:main" - - -[project.entry-points."rattail.config.extensions"] -messkit = "messkit.config:MesskitConfig" - - -[project.urls] -Homepage = "https://rattailproject.org" -Repository = "https://forgejo.wuttaproject.org/rattail/messkit" -Issues = "https://forgejo.wuttaproject.org/rattail/messkit/issues" -Changelog = "https://forgejo.wuttaproject.org/rattail/messkit/src/branch/master/CHANGELOG.md" - - -[tool.commitizen] -version_provider = "pep621" -tag_format = "v$version" -update_changelog_on_bump = true - - -# [tool.hatch.build.targets.sdist] -# exclude = [ -# "machines/", -# ] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..fb02cef --- /dev/null +++ b/setup.py @@ -0,0 +1,119 @@ +# -*- coding: utf-8; -*- +###################################################################### +# +# Messkit -- Generic-ish Data Utility App +# Copyright © 2022 Lance Edgar +# +# This file is part of Messkit. +# +# Messkit is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Messkit 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 +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Messkit. If not, see . +# +###################################################################### +""" +Messkit setup script +""" + +import os +from setuptools import setup, find_packages + + +here = os.path.abspath(os.path.dirname(__file__)) +exec(open(os.path.join(here, 'messkit', '_version.py')).read()) +README = open(os.path.join(here, 'README.rst')).read() + + +requires = [ + # + # Version numbers within comments below have specific meanings. + # Basically the 'low' value is a "soft low," and 'high' a "soft high." + # In other words: + # + # If either a 'low' or 'high' value exists, the primary point to be + # made about the value is that it represents the most current (stable) + # version available for the package (assuming typical public access + # methods) whenever this project was started and/or documented. + # Therefore: + # + # If a 'low' version is present, you should know that attempts to use + # versions of the package significantly older than the 'low' version + # may not yield happy results. (A "hard" high limit may or may not be + # indicated by a true version requirement.) + # + # Similarly, if a 'high' version is present, and especially if this + # project has laid dormant for a while, you may need to refactor a bit + # when attempting to support a more recent version of the package. (A + # "hard" low limit should be indicated by a true version requirement + # when a 'high' version is present.) + # + # In any case, developers and other users are encouraged to play + # outside the lines with regard to these soft limits. If bugs are + # encountered then they should be filed as such. + # + # package # low high + + # TODO: user should get to choose which of these is needed? + 'mysql-connector-python', # 8.0.28 + 'psycopg2', # 2.9.3 + + 'prompt_toolkit', # 3.0.28 + 'rich', # 11.2.0 + 'Tailbone', # 0.8.206 +] + + +setup( + name = "Messkit", + version = __version__, + author = "Lance Edgar", + author_email = "lance@edbob.org", + url = "https://rattailproject.org", + description = "Generic-ish Data Utility App", + long_description = README, + + classifiers = [ + 'Development Status :: 3 - Alpha', + 'Environment :: Console', + 'Environment :: Web Environment', + 'Framework :: Pyramid', + 'Intended Audience :: Developers', + 'Natural Language :: English', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python', + 'Programming Language :: Python :: 3', + 'Topic :: Office/Business', + ], + + install_requires = requires, + packages = find_packages(), + include_package_data = True, + + entry_points = { + + 'rattail.config.extensions': [ + 'messkit = messkit.config:MesskitConfig', + ], + + 'console_scripts': [ + 'messkit = messkit.commands:main', + ], + + 'messkit.commands': [ + 'install = messkit.commands:Install', + ], + + 'paste.app_factory': [ + 'main = messkit.web.app:main', + ], + }, +) diff --git a/tasks.py b/tasks.py index cd27f57..5ad2c81 100644 --- a/tasks.py +++ b/tasks.py @@ -9,17 +9,18 @@ import shutil from invoke import task +here = os.path.abspath(os.path.dirname(__file__)) +exec(open(os.path.join(here, 'messkit', '_version.py')).read()) + + @task -def release(c): +def release(ctx): """ Release a new version of Messkit """ - # rebuild package - if os.path.exists('dist'): - shutil.rmtree('dist') - if os.path.exists('Messkit.egg-info'): - shutil.rmtree('Messkit.egg-info') - c.run('python -m build --sdist') + # rebuild local tar.gz file for distribution + shutil.rmtree('Messkit.egg-info') + ctx.run('python setup.py sdist --formats=gztar') # upload to public PyPI - c.run('twine upload dist/*') + ctx.run('twine upload dist/Messkit-{}.tar.gz'.format(__version__))