From e95e341c45e26fe6606e5b586dda71c2dc721e09 Mon Sep 17 00:00:00 2001 From: ZeLibertineGamer Date: Fri, 20 May 2016 09:01:53 -0700 Subject: Initial commit I was dumb and didn't start committing as soon as I started. vgstash is considered ready for 0.1 and beta usage. There's a somewhat long road ahead, but I look forward to making this tool finally come to fruition. --- .gitignore | 1 + AUTHORS | 2 + COPYING | 674 +++++++++++++++++++++++++++++++++++++++++++++++ README.mdown | 257 ++++++++++++++++++ scripts/system-search.sh | 37 +++ vgstash | 405 ++++++++++++++++++++++++++++ 6 files changed, 1376 insertions(+) create mode 100644 .gitignore create mode 100644 AUTHORS create mode 100644 COPYING create mode 100644 README.mdown create mode 100755 scripts/system-search.sh create mode 100755 vgstash diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0fd1bcf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/*.sw? diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..16f9dc6 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,2 @@ +zlg, gopher://zelibertinegamer.me + Original author, maintainer diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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/README.mdown b/README.mdown new file mode 100644 index 0000000..7d617c6 --- /dev/null +++ b/README.mdown @@ -0,0 +1,257 @@ +vgstash is a tool used to keep track of a video game collection. In addition to +basic inventory maintenance, vgstash supports the ability to clarify whether or +not the user owns a game, and their progress through said game. This makes it +easy to manage a backlog and serve as a "memory" for which games someone has +finished. + +# Concept + +Essentially, vgstash just gets out of your way and lets you manage things. +Nothing fancy like box art or finding games in a massive dropdown box. There are +easy flags to track common searches, like "All games that are owned and haven't +been beaten", making vgstash convenient. + +Since vgstash itself is just a front-end to an SQLite dataabase, other +interfaces to this basic database format can be built to extend the basic +concept. SQLite is supported across tons of languages and platforms, so it's +rather trivial to build another frontend to it. If that's not enough, vgstash +also supports exporting collections as YAML or pipe-delimited lines, and +importing from YAML. This makes batch-editing by a human easy with YAML, and the +raw format is great for pushing vgstash's output through pipes, as any good +\*nix tool should. + +## Data Format + +The key to managing things is keeping it simple, but flexible enough to give you +meaningful insight to the data itself. vgstash gets straight to business +with its data format: + +* Name (string) +* System (string) +* Ownership (boolean) +* Completion Level (integer) + * 0 (Fresh) + * 1 (In Progress) + * 2 (Beaten) + * 3 (Completed) + +There isn't a hard limit on the length of the Name or System strings. SQLite +itself, however, has internal limits. Those limits may differ between platforms, +so there's no guarantee that vgstash databases will work across them. + +# Usage + +Using vgstash is fairly easy, for a command-line program. It accepts +a handful of commands, which will be explained below: + +* init +* add +* update +* delete +* list +* import +* export + +## Tips + +For the sake of accessibility and ease of use, there are some synonyms: + +When specifying ownership, `0` (zero) and `n` mean the same thing. The same is +true of `1` (one) and `y`. + +When specifying progress, the numbers and letters can both be used: + +`0` is also `f` or "fresh". +`1` is also `i` (lowercase I) or "in-progress". +`2` is also `b` (lowercase B) or "beaten". +`3` is also `c` (lowercase C) or "completed". + +Since vgstash relies on the shell and SQLite to function, unquoted strings +are likely to not be handled well. If your data ever looks funky, try correcting +it with a quoted string. Bugs or issues that are reported without quoted strings +will be discarded as WONTFIX, as that's basic, sane practice in every shell +under the sun. + +## Getting Started + +Initialize the database, where your information will be stored: + +~~~ +vgstash init +~~~ + +The location of the database may be set using an environment variable. To learn +more, see the Environment Variables section. + +## Adding + +Next, add a game or two: + +~~~ +vgstash add "Super Mario Bros" NES yes i +~~~ + +In the above example, we're adding *Super Mario Bros* for the NES system. We own +it, and haven't beaten it yet. + +Let's add another: + +~~~ +vgstash add "Borderlands 2" PC +~~~ + +This command has just the basics: game name, and game platform. For the sake of +simplicity, the ownership and progress flags have default values: ownership +defaults to "yes" and progress defaults to "in progress". In both cases, they +are the most typical state for a video game to be added to ones collection. This +can be influenced; see the Environment Variables section for more info. + +## Listing + +vgstash has plenty of methods to interface with your game collection. The +simplest listing would be "list every game in the database": + +~~~ +# The 'all' is optional +vgstash list all +~~~ + +This will output a human-readable list of games you have in the database, with +proper flags and unique IDs, which will come in handy later. For ease of use, +`list all` will sort by system, then by title. Here's an example: + +~~~ +ID | Title | System | Own | Progress +---+---------------------+--------+-----+---------- +3 | Metroid | NES | * | I +1 | Super Mario Bros | NES | | C +2 | The Legend of Zelda | NES | * | B +4 | Borderlands | PC | * | F +~~~ + +From the above output, we can gather that we don't own *Super Mario Bros* +anymore. It's been completed, however, so that's good news. We own *Zelda*, and +it's been beaten, but not completed. We also own *Metroid*, but it's still +in-progress. Lastly, we own Borderlands for the PC, but haven't started playing +it yet. + +The output format is designed to be easy to read, and omits information to serve +as a visual guide whenever possible. From a single glance, you should be able to +spot which games you own and which haven't been started yet. + +### List Filtering + +Seeing all of your games is great when you're just getting started, but what +about after you've added your massive 500 game collection? Nobody wants to sort +through screenfulls of text. That's where filtering comes in. The `list` command +accepts the following filters: + +* **completed** + List games that have been completed. + +* **done** +List games that have been beaten *or* completed. + +* **owned** +List games that you own. + +* **unowned** +List games that you don't own. + +* **wishlist** +List games that you don't own AND are fresh. + +* **incomplete** +List games that have been beaten, but not completed, that you also own. + +* **backlog** +List games that have not been beaten or completed, that you also own. + +## Update + +The `update` command requires the game's ID, the field you're changing, and the +value you're changing it to. + +The fields you can change are + +* title +* system +* ownership +* progress + +As explained in **Data Format**, ownership and progress can use single letters +to substitute for the internal numeric representations. + +To get a game's ID, try using something like `vgstash list | grep "foo"` to find +what you're looking for. + +## Deleting + +For one reason or another, you may need to remove items from your game database. +The `delete` command, coupled with the game's ID, will take care of that for +you. If you want to remove *every* game from your collection, delete the +`.vgstash.db` file from your $HOME directory (or whatever `VGSTASH_DB_LOCATION` +is set to) and start over with `vgstash init`. + +# Environment Variables + +Customization is pretty important if you're going to manage hundreds of games. +There are only a few, but they may come in handy for you! + +* `VGSTASH_DB_LOCATION` + Defaults to `$HOME`. A file named `.vgstash.db` will be found there. + +* `VGSTASH_DEFAULT_OWNERSHIP` + Can be 0 or 1. Default is 1 (yes). + +* `VGSTASH_DEFAULT_PROGRESS` + Can be 0 through 3. Default is 1 (in-progress). + +* `VGSTASH_TABLE_WIDTH` + The width of the table output by the `list` command. For readability +reasons, vgstash will only allow values that are 50 or above. If this variable +is set to zero (0) however, it will expand to fit the entire width of your +terminal/tty. It defaults to 80 characters. + +# Contributing + +vgstash was first written in Python 3.4. There are no plans to produce a Python +2.x version. Patches and pull requests are welcome! However, please do not +contribute to this project unless you are fine with your contributions also +being licensed under the GPL 3.0. This is to simplify licensing issues and keep +things neat. + +Before submitting a Pull Request, please ensure that your commit(s) contain +an addition of your name to the `AUTHORS` file. Others may not use GitHub (or +even git) to get or use vgstash, and every contributor deserves recognition. An +example of what one would add to the `AUTHORS` file is: + +~~~ +John Q. Public, GitHub: @hellomynameisjohn + Corrected typos in manpage +~~~ + +Note that the indent is four spaces. + +# Roadmap + +vgstash is considered beta-quality at this time. Please report any issues, bugs, +or even suggestions on how to improve vgstash. + +One feature that will not be built (at least by zlg) is search functionality. +Since vgstash cooperates with piping, it's trivial to pass its output through +other programs and get the fine-grained information a more advanced user may +need. + +Here are the current goals: + +* manpage +* bash-completion file +* refined argument handling for shorthand commands + +# Copyright + +vgstash is Copyright © 2016 Ze Libertine Gamer. It is licensed under the GNU +General Public License, version 3.0. A copy of this license may be found in the +`COPYING` file within this project. It may also be found on the World Wide Web +at http://gnu.org/licenses/gpl-3.0.html. diff --git a/scripts/system-search.sh b/scripts/system-search.sh new file mode 100755 index 0000000..329ead9 --- /dev/null +++ b/scripts/system-search.sh @@ -0,0 +1,37 @@ +#!/bin/bash + +# system-search.sh: List all games from a specific system + +# Accepts either one argument (the system name), or the filter to send +# to vgstash and then the system name. + +show_help() { + cat <<-FOOBAR + system-search.sh [filter] SYSTEM + + filter: The filter to pass to vgstash. "all" by default + SYSTEM: The value in the System column to search for. Accepts + awk-style regex. + + For example, to check which games for the NES that are in progress, + you would do: + + system-search.sh incomplete NES +FOOBAR +} + +case $# in + 1) + filter="all" + system="$1" + ;; + 2) + filter="$1" + system="$2" + ;; + *) + show_help + ;; +esac + +vgstash list "${filter}" | awk -F '|' "\$3 ~ \"${system}\"" diff --git a/vgstash b/vgstash new file mode 100755 index 0000000..c1775d6 --- /dev/null +++ b/vgstash @@ -0,0 +1,405 @@ +#!/usr/bin/env python3 + +# TODO: Consider putting all help messages into a dict for easier management +# TODO: Decide on docstring delimiter and stick to it + +import sys +import os +import sqlite3 +import argparse +import yaml +import subprocess # to handle the piping use case + +DB_LOCATION = '' +OWNERSHIP = 1 +PROGRESS = 1 +TABLE_WIDTH = 80 + +def set_env(): + '''Ensures environment variables are respected. Sets defaults if + they're not present. If the defaults are not usable, it throws an + AssertionError and alerts the user.''' + # This makes outside-scope referencing and assignment possible + global DB_LOCATION, OWNERSHIP, PROGRESS, TABLE_WIDTH + + # Precedence = $VGSTASH_DB_LOCATION, $HOME, or current directory + DB_LOCATION = os.getenv('VGSTASH_DB_LOCATION', os.getenv('HOME', os.getcwd())) + + try: + assert(os.path.isdir(DB_LOCATION)) + except AssertionError: + print("VGSTASH_DB_LOCATION is not a valid directory. Unset it to fall back to $HOME, or correct the environment variable.") + sys.exit() + + DB_LOCATION = os.path.join(DB_LOCATION, ".vgstash.db") + + OWNERSHIP = int(os.getenv('VGSTASH_DEFAULT_OWNERSHIP', OWNERSHIP)) + try: + assert(OWNERSHIP == 0 or OWNERSHIP == 1) + except AssertionError: + print("VGSTASH_DEFAULT_OWNERSHIP is not zero or one. Ensure your variable is set correctly.") + sys.exit() + + PROGRESS = int(os.getenv('VGSTASH_DEFAULT_PROGRESS', PROGRESS)) + try: + assert(PROGRESS >= 0 and PROGRESS <= 3) + except AssertionError: + print("VGSTASH_DEFAULT_PROGRESS is not between zero and three. Ensure your variable is set correctly.") + sys.exit() + + TABLE_WIDTH = int(os.getenv('VGSTASH_TABLE_WIDTH', TABLE_WIDTH)) + try: + assert(TABLE_WIDTH >= 50 or TABLE_WIDTH == 0) + except AssertionError: + print("VGSTASH_TABLE_WIDTH must be a number that's zero, or a number that's 50 or greater, to facilitate readability. A value of zero will use your terminal's width.") + sys.exit() + +def init_db(args): + '''Creates the database schema and the relevant views, preparing it + for use with vgstash. Will not overwrite an extant database.''' + + # Confirm we can create the file + try: + assert(os.path.isfile(DB_LOCATION) == False) + conn = sqlite3.connect(DB_LOCATION) + print("DB successfully connected!") + except sqlite3.OperationalError: + print("The database could not be created and/or connected to.") + sys.exit() + except AssertionError: + print("The database already exists! Delete '%s' and init the database again." % loc) + sys.exit() + + # Now let's run a bunch of queries! Fun... + try: + conn.execute("CREATE TABLE games (\ + title TEXT NOT NULL,\ + system TEXT NOT NULL,\ + ownership INTEGER NOT NULL DEFAULT 1,\ + progress INTEGER NOT NULL DEFAULT 1\ + );") + print("Table created.") + # TODO: Consider executescript() + conn.execute("CREATE VIEW allgames AS SELECT rowid,* FROM games ORDER BY system,title ASC;") + conn.execute("CREATE VIEW complete AS SELECT rowid,* FROM games WHERE progress = 3 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW backlog AS SELECT rowid,* FROM games WHERE ownership = 1 AND progress < 2 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW done AS SELECT rowid,* FROM games WHERE progress >= 2 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW fresh AS SELECT rowid,* FROM games WHERE progress = 0 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW incomplete AS SELECT rowid,* FROM games WHERE ownership = 1 AND progress = 2 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW owned AS SELECT rowid,* FROM games WHERE ownership = 1 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW unowned AS SELECT rowid,* FROM games WHERE ownership = 0 ORDER BY system,title ASC;") + conn.execute("CREATE VIEW wishlist AS SELECT rowid,* FROM games WHERE ownership = 0 AND progress < 2 ORDER BY system,title ASC;") + print("Views created.") + conn.commit() + except sqlite3.OperationalError as e: + print("Query error:", e) + finally: + conn.close() + +def export_db(args): + '''Exports a YAML representation of the database to a given file.''' + try: + if args.path == None: + fp = sys.stdout + else: + fp = open(args.path, 'w') + except PermissionError: + print("The path is not writable by the current user. Please double-check permissions.") + sys.exit() + else: + conn = sqlite3.connect(DB_LOCATION) + conn.row_factory = sqlite3.Row + c = conn.cursor() + fp.write("# vgstash DB file version 0.1\n") + db_tree = [] + # The .format() call supports the optional -i flag + for row in c.execute("SELECT {}title,system,ownership,progress FROM games".format("rowid," if args.ids else '')): + game = {} + for field in row.keys(): + game.update({field: row[field]}) + db_tree.append(game) + yaml.dump(db_tree, fp, default_flow_style=False, indent=4, allow_unicode=True) + fp.close() + if fp is not sys.stdout: + print("Database exported to {}.".format(args.path)) + +def import_db(args): + '''Read yaml lines from a file (or stdin) to add to the database.''' + try: + if args.path == None: + fp = sys.stdin + else: + fp = open(args.path, 'r') + except PermissionError: + print("The path is not readable by the current user. Please check permissions.") + sys.exit() + # Time for business! :D + records = 0 + data = yaml.safe_load(fp) + conn = sqlite3.connect(DB_LOCATION) + conn.row_factory = sqlite3.Row + c = conn.cursor() + # List comprehensions are why I like Python. + # inline conditionals are badass, too + c.executemany("INSERT {}INTO games ({}title,system,ownership,progress) VALUES ({}:title, :system, :ownership, :progress)".format("OR REPLACE " if args.ids else "", "rowid," if args.ids else "", ":rowid," if args.ids else ""), (game for game in data)) + conn.commit() + conn.close() + print("Imported {} games.".format(c.rowcount)) + + +def add_game(args): + '''Adds a game to the database. Requires at least a title and + system. + + Ownership can be 0 (not owned) or 1 (owned). The default is 1. + + Completion can be 0 to 3: + 0 (fresh, never played) + 1 (in-progress) (default) + 2 (beaten) + 3 (completed 100%) + ''' + if args.ownership == '-': + args.ownership = OWNERSHIP + if args.progress == '-': + args.progress = PROGRESS + # Translate our args so they can be added and reflected correctly + args.ownership = translate_arg(args.ownership) + args.progress = translate_arg(args.progress) + + conn = sqlite3.connect(DB_LOCATION) + game = (args.title, args.system, args.ownership, args.progress) + conn.execute("INSERT INTO games VALUES(:title, :system, :ownership, :progress)", game) + conn.commit() + conn.close() + qual = "don't own" if args.ownership == 0 else 'own' + comp = ("fresh", "in-progress", "beaten", "completed") + # I shouldn't have to coerce that last argument but I don't know a better + # solution. + print("Added {0} for {1}. You {2} it and it's {3}.".format(args.title, args.system, qual, comp[int(args.progress)])) + +def delete_game(args): + '''Removes a game from the database.''' + target = game_found(args.id) + if target != None: + try: + conn = sqlite3.connect(DB_LOCATION) + c = conn.cursor() + conn.execute("DELETE FROM games WHERE rowid = :id", {'id': args.id}) + conn.commit() + print("Removed {0} for {1} from your database.".format(target[0], target[1])) + except sqlite3.OperationalError: + print("Could not remove game from the database. Check the file and ensure you have write access.") + finally: + conn.close() + else: + print("That game ID does not exist in the database.") + +def translate_arg(arg): + '''Translate approximate argument names to their internal values for + inserting into the database.''' + # Verify we're working with a string. + try: + if len(arg) != 1: + print("Argument must be a single character.") + sys.exit() + if not arg.isnumeric(): + # We know it can't be coerced to a number, so it must be a string + vals = {'f': 0, 'n': 0, 'i': 1, 'y': 1, 'b': 2, 'c': 3} + try: + return vals[arg] + except KeyError: + # Note to self, doubling a brace escapes it. This was tucked away in the Python docs... + print("Value '{}' not valid. Try one of {{y, n, f, i, b, c}}.".format(arg)) + sys.exit() + else: + return arg + except TypeError: + # It's a number, go ahead and return it + return arg + +def update_game(args): + '''Changes a specific field for a game. Mostly used for correcting + mistakes and updating game status as it changes.''' + target = game_found(args.gid) + # Let's accept anything remotely matching the field names + opts = ['system', 'title', 'ownership', 'progress'] + for i in opts: + if i.startswith(args.field): + args.field = i + if not (args.field in opts): + print("Invalid field name indicated! Please choose from {}".format(', '.join(opts))) + sys.exit() + # Translate y, n, f, i, b, and c + if args.field == 'ownership' or args.field == 'progress': + args.value = translate_arg(args.value) + # We need this workaround because execute() doesn't like variable column names + update_stmt = "UPDATE games SET {} = :val WHERE rowid = :id".format(args.field) + conn = sqlite3.connect(DB_LOCATION) + c = conn.cursor() + c.execute(update_stmt, {'id': args.gid, 'val': args.value}) + conn.commit() + if c.rowcount == 1: + own_msg = ('not owned', 'owned') + prog_msg = ('fresh', 'in-progress', 'beaten', 'complete') + update_msg = { + 'title': "{ot} on {os} is now named {val}.", + 'system': "{ot} on {os} is now on {val}.", + 'ownership': "{ot} on {os} is now marked {val}.", + 'progress': "{ot} on {os} is now marked {val}." + } + print(update_msg[args.field].format(ot = target['title'], os = target['system'], val = args.value if args.field == 'title' or args.field == 'system' else own_msg[int(args.value)] if args.field == 'ownership' else prog_msg[int(args.value)])) + else: + print("Could not update game information. Check the DB's permissions.") + conn.close() + +def list_games(args): + '''Filters games according to preset queries. Internally, + they are SQLite VIEWs + + Each filter targets different games: + + all: everything, sorted by system then title + backlog: * have not been beaten or completed + complete: have been completed + done: are beaten or complete + fresh: haven't been started yet + incomplete: * beaten, but not completed + owned: are marked as 'owned' + unowned: are marked as 'unowned' + wishlist: are both 'unowned' and 'fresh' or 'in-progress' + + * Will only target games that are owned. + ''' + if args.filter == 'all': + args.filter = 'allgames' + # DBs don't allow table names to be parameterized. This little hack + # works around that limitation. + conn = sqlite3.connect(DB_LOCATION) + conn.row_factory = sqlite3.Row + select_stmts = { + 'allgames': "SELECT * FROM allgames", + 'backlog': "SELECT * FROM backlog", + 'complete': "SELECT * FROM complete", + 'done': "SELECT * FROM done", + 'fresh': "SELECT * FROM fresh", + 'incomplete': "SELECT * FROM incomplete", + 'owned': "SELECT * FROM owned", + 'unowned': "SELECT * FROM unowned", + 'wishlist': "SELECT * FROM wishlist" + } + # We're emulating a do-while loop + first_pass = True + for row in conn.execute(select_stmts[args.filter]): + if args.raw: + # Use this for raw output, for use with other tools + print('|'.join(map(str,row))) + continue + else: + row_format(row, header=first_pass) + first_pass = False + + +def game_found(gid): + '''Confirms the given ID is in the database and, if found, returns it. + Used in conjunction with delete_game() and update_game().''' + conn = sqlite3.connect(DB_LOCATION) + # Give us access to .keys() + conn.row_factory = sqlite3.Row + c = conn.cursor() + c.execute("SELECT title,system,ownership,progress FROM games WHERE rowid = :id", {'id': gid}) + row = c.fetchone() + conn.close() + return row + +def row_format(args, header): + # There's another way to do this, involving gathering the entire results and *then* formatting them + # That is incredibly wasteful of resources imo, so it may need some testing to see if it's better. + # Ideally, we'd only make the table as wide as needed; that can't happen unless we know the longest + # title's length... + # Get our maximum width so we can toy around with things. + if TABLE_WIDTH >= 50: + maxwidth = TABLE_WIDTH + else: + try: + maxwidth = os.get_terminal_size().columns + except OSError: + with open('/dev/tty') as tty: + curwidth = int(subprocess.check_output(['stty', 'size']).split()[1]) + maxwidth = curwidth + twidth = maxwidth - 35 + if header == True: + print("{:^4s} | {:<{w}s} | {:<8s} | {:^3s} | {:<7s}".format("ID", "Title", "System", "Own", "Status", w=twidth)) + print("-" * maxwidth) + + gidstr = "{: >4d}".format(args['rowid']) + titlestr = "{: <{w}s}".format(args['title'][:twidth], w=twidth) + systemstr = "{: ^8s}".format(args['system'][:8]) + ownstr = "{: ^3s}".format("*" if args['ownership'] == 1 else " ") + statltr = ['F', 'I', 'B', 'C'] + statstr = "{: <7s}".format((" " * args['progress'] * 2) + statltr[args['progress']]) + """ + ID | Title | System | Own | Status + ------------------------------------------------- + 1234 | This is a title | Wii U VC | * | F I B C + """ + print(" | ".join((gidstr, titlestr, systemstr, ownstr, statstr))) + +def main(): + # Establish our important variables + set_env() + + # Set up the command parsers + parser = argparse.ArgumentParser() + subparsers = parser.add_subparsers() + + # 'add' command + parser_add = subparsers.add_parser('add', help="Add a game to your database") + parser_add.add_argument('title', type=str, help="The title of the game you're adding") + parser_add.add_argument('system', type=str, help="The system your game is for") + parser_add.add_argument('ownership', type=str, nargs='?', default='-', help="0 or 'n' for no, 1 or 'y' for yes. Defaults to {0}. Accepts '-' for default, in case you want to set progress but not ownership".format(OWNERSHIP)) + parser_add.add_argument('progress', type=str, nargs='?', default='-', help="Indicates completion level. 0 = [f]resh, never played; 1 = [i]n progress; 2 = [b]eaten; 3 = [c]ompleted. Defaults to {0}".format(PROGRESS)) + parser_add.set_defaults(func=add_game) + + # 'init' command + parser_init = subparsers.add_parser('init', help="Initialize the database so it can be used") + parser_init.set_defaults(func=init_db) + + # 'delete' command + parser_del = subparsers.add_parser('delete', help="Remove a game from your database") + parser_del.add_argument('id', type=int, help="The ID of the game to be deleted") + parser_del.set_defaults(func=delete_game) + + # 'list' command + parser_list = subparsers.add_parser('list', help="List your games with preset views") + list_filters = ['all', 'backlog', 'complete', 'done', 'fresh', 'incomplete', 'owned', 'unowned', 'wishlist'] + parser_list.add_argument('filter', nargs='?', choices=list_filters, default='all', help='Filter games accerding to preset queries. Valid filters: {}'.format(', '.join(list_filters))) + parser_list.add_argument('-r', '--raw', action="store_true", help="Output the list in a machine-readable format, separated by pipe characters.") + parser_list.set_defaults(func=list_games) + + # 'update' command + parser_up = subparsers.add_parser('update', help="Update a specific game") + parser_up.add_argument('gid', type=int, help="The game's ID (found in 'vgstash list' output)") + parser_up.add_argument('field', help="The field you wish to update") + parser_up.add_argument('value', type=str, help="The new value for the field") + parser_up.set_defaults(func=update_game) + + # 'export' command + parser_ex = subparsers.add_parser('export', help="Export the database's information to a YAML file.") + parser_ex.add_argument('path', nargs='?', default=None, help="The full path of the file you want to write to. Defaults to stdout") + parser_ex.add_argument('-i', '--ids', action="store_true", help="Export game IDs along with game information. Useful if preparing a batch update.") + parser_ex.set_defaults(func=export_db) + + # 'import' command + parser_im = subparsers.add_parser('import', help="Import a YAML file's content into the database.") + parser_im.add_argument('path', nargs='?', default=None, help="The full path of the file you want to read from. Defaults to stdin") + parser_im.add_argument('-i', '--ids', action="store_true", help="Update via game IDs in the database instead of appending") + parser_im.set_defaults(func=import_db) + + # Let'er rip! + args = parser.parse_args() + args.func(args) + +# Our usual incantation +if __name__ == "__main__": + main() -- cgit v1.2.3-54-g00ecf