commit 801848cdd38acbe8385aa8d12d39aabc5993c5a1 Author: Lucidiot Date: Mon Mar 2 11:13:15 2020 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0a02bb4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,64 @@ +__pycache__/ +*.py[cod] +*$py.class + +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST +docs/_build/ + +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ +.mypy_cache/ + +profile_default/ +ipython_config.py + +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +.ropeproject + +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] +Session.vim +.netrwhist +*~ +tags +[._]*.un~ + +.vscode/* + +output/ +aliases.private.yml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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.rst b/README.rst new file mode 100644 index 0000000..6082564 --- /dev/null +++ b/README.rst @@ -0,0 +1,8 @@ +aliasindex +========== + +A YAML file to hold all of my shell aliases and some script to manage +them, so that I can synchronize everything between my devices and +share everything `online`_. + +.. _online: https://tilde.town/~lucidiot/aliasindex/ diff --git a/aliases.yml b/aliases.yml new file mode 100644 index 0000000..3aef924 --- /dev/null +++ b/aliases.yml @@ -0,0 +1,683 @@ +%YAML 1.1 +--- +tags: + - name: fun + description: >- + Aliases of questionable usefulness, mostly for puns, private jokes, + or showing off. + - name: git + description: Git-related shortcuts. + - name: docker + description: Docker-related shortcuts. + - name: python + description: Python-related shortcuts. + - name: basic + description: >- + Rather basic aliases that you might already have built into your shell. + - name: specific + description: Aliases that are quite specific to my own setup. + +aliases: + - name: aliasless + description: In honour of ~aliasless! + value: 'alias | less' + tag: fun + + - name: please + description: For when you want to be polite with your terminal. + value: sudo + tag: fun + + - name: ':q' + description: For when I get confused between Vim and a shell. + value: exit + tag: fun + + - name: ':q!' + value: exit + tag: fun + + - name: ':wq' + value: exit + tag: fun + + - name: gs + value: git status + tag: git + + - name: gch + value: git checkout + tag: git + + - name: gchm + value: git checkout master + tag: git + + - name: gchb + value: git checkout -b + tag: git + + - name: gl + description: >- + Yet another git log alias. + You will probably want to customize it with your own format. + value: >- + git log + --graph + --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s + %Cgreen(%cr) %C(bold blue)<%an>%Creset' + --abbrev-commit + --all + tag: git + + - name: ga + value: git add + tag: git + + - name: gaa + value: git add -A + tag: git + + - name: gapa + value: git add --patch + tag: git + + - name: gb + value: git branch + tag: git + + - name: gbd + value: git branch -d + tag: git + + - name: gbD + value: git branch -D + tag: git + + - name: gbs + value: git bisect + tag: git + + - name: gbs! + value: git bisect start + tag: git + + - name: gbsg + value: git bisect good + tag: git + + - name: gbsb + value: git bisect bad + tag: git + + - name: gbss + value: git bisect skip + tag: git + + - name: gbsr + value: git bisect reset + tag: git + + + - name: gc + value: git commit + tag: git + + - name: gca + value: git commit -a + tag: git + + - name: gcas + value: git commit -a -s + tag: git + + - name: gcm + value: git commit -m + tag: git + + - name: gcms + value: git commit -s -m + tag: git + + - name: gcs + value: git commit -s + tag: git + + - name: gcam + value: git commit -a -m + tag: git + + - name: gcams + value: git commit -a -s -m + tag: git + + - name: gcan + value: git commit --amend --no-edit + tag: git + + - name: gcans + value: git commit --amend -s --no-edit + tag: git + + - name: gcaan + value: git commit --amend -a --no-edit + tag: git + + - name: gcaans + value: git commit --amend -a -s --no-edit + tag: git + + - name: gcp + value: git cherry-pick + tag: git + + - name: gcpa + value: git cherry-pick --abort + tag: git + + - name: gcpc + value: git cherry-pick --continue + tag: git + + - name: gd + value: git diff + tag: git + + - name: gds + value: git diff --staged + tag: git + + - name: gf + value: git fetch + tag: git + + - name: gfp + value: git fetch --prune + tag: git + + - name: gg + description: For when you give up with command-line Git. + value: git gui + tag: git + + - name: gm + value: git merge + tag: git + + - name: gma + value: git merge --abort + tag: git + + - name: gp + value: git push + tag: git + + - name: gpf + value: git push --force-with-lease + tag: git + + - name: gpfo + value: git push --force-with-lease origin + tag: git + + - name: gpu + value: git push -u origin + tag: git + + - name: gr + value: git remote + tag: git + + - name: gra + value: git remote add + tag: git + + - name: grrm + value: git remote remove + tag: git + + - name: grmv + value: git remote rename + tag: git + + - name: grb + value: git rebase + tag: git + + - name: grba + value: git rebase --abort + tag: git + + - name: grbc + value: git rebase --continue + tag: git + + - name: grbi + value: git rebase -i + tag: git + + - name: grbm + value: git rebase master + tag: git + + - name: grbs + value: git rebase --skip + tag: git + + - name: grh + value: git reset + tag: git + + - name: grhh + value: git reset --hard + tag: git + + - name: grl + value: git reflog + tag: git + + - name: gst + value: git stash + tag: git + + - name: gsta + value: git stash push + tag: git + + - name: gstam + value: git stash push -m + tag: git + + - name: gstd + value: git stash clear + tag: git + + - name: gstl + value: git stash list + tag: git + + - name: gstp + value: git stash pop + tag: git + + - name: gsts + value: git stash show --text + tag: git + + - name: gt + value: git tag + tag: git + + - name: gtf + value: git tag -f + tag: git + + - name: gtd + value: git tag -d + tag: git + + - name: hd + value: hexdump -C + tag: basic + + - name: https + description: An alias for HTTPie to use HTTPS more quickly + value: http --default-scheme=https + + - name: ka + value: killall + tag: basic + + - name: nuke + value: kill -9 + tag: fun + + - name: l + value: ls -lah + tag: basic + + - name: la + value: ls -lAh + tag: basic + + - name: ll + value: ls -lh + tag: basic + + - name: md + value: mkdir + tag: basic + + - name: rd + value: rmdir + tag: basic + + - name: mdp + value: mkdir -p + tag: basic + + - name: chown + description: Why isn't this the default?! + value: chown --preserve-root + tag: basic + + - name: chmod + description: Why isn't this the default?! + value: chmod --preserve-root + tag: basic + + - name: oneplus + description: >- + I have KDEConnect installed on my OnePlus One, + and I often use its not-so-comfortable CLI. + value: "kdeconnect-cli -n 'OnePlus One'" + tag: specific + + - name: nuketheswap + description: |- + Named after a private joke at work. Cleans up your swap. + + Be careful not to run this if you do not have enough space in RAM or if + you still have some programs eating up your RAM: this could freeze + your machine. + value: sudo swapoff -a; sudo swapon -a + tag: specific + + - name: scream + value: "tr '[[:lower:]]' '[[:upper:]]'" + tag: fun + + - name: whisper + value: "tr '[[:upper:]]' '[[:lower:]]'" + tag: fun + + - name: cowscream + description: For the big moo-ds. + value: "figlet -f big -w 999999 | cowsay -nw" + tag: fun + + - name: cowanxiety + description: For the big bad moo-ds. + value: "figlet -f big -w 999999 | cowthink -nw" + tag: fun + + - name: sl + description: I like trains, but not too much. + value: sl -e + tag: fun + + - name: fullwidth + description: >- + Convert normal character to their full-width equivalents. + Great for vaporware-style text, or for messing up some terminals. + value: "sed \"y/!\\\"#\\$%&'()*+,-.\\/0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\\\]^_\\`abcdefghijklmnopqrstuvwxyz{|}~¢£¬¯¦¥ /！＂＃＄％＆＇（）＊＋，－．／０１２３４５６７８９：；＜＝＞？＠ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺ［＼］＾＿｀ａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ｛｜｝～￠￡￢￣￤￥　/\"" + tag: fun + + - name: dco + value: docker-compose + tag: docker + + - name: dcp + value: docker container prune + tag: docker + + - name: dccp + value: docker container cp + tag: docker + + - name: dcpf + value: docker container prune -f + tag: docker + + - name: de + value: docker exec + tag: docker + + - name: dei + value: docker exec -it + tag: docker + + - name: di + value: docker inspect + tag: docker + + - name: dip + value: docker image prune + tag: docker + + - name: dipf + value: docker image prune -f + tag: docker + + - name: drmi + value: docker rmi + tag: docker + + - name: drmia + value: docker images -q | xargs docker rmi + tag: docker + + - name: dk + value: docker kill + tag: docker + + - name: dka + value: docker ps -q | xargs docker kill + tag: docker + + - name: dl + value: docker logs + tag: docker + + - name: dlf + value: docker logs -f + tag: docker + + - name: dlft + value: docker logs -f --tail + tag: docker + + - name: dlt + value: docker logs --tail + tag: docker + + - name: dn + value: docker network + tag: docker + + - name: dnc + value: docker network create + tag: docker + + - name: dnp + value: docker network prune + tag: docker + + - name: dnpf + value: docker network prune -f + tag: docker + + - name: dp + value: docker ps + tag: docker + + - name: dpq + value: docker ps -q + tag: docker + + - name: dr + value: docker run + tag: docker + + - name: dri + value: docker run -it + tag: docker + + - name: dsp + value: docker system prune + tag: docker + + - name: dspf + value: docker system prune -f + tag: docker + + - name: gut + description: >- + You can also have a function that looks for 'status' in the argument, + and prints 'hungry' for `gut status`. + value: git + tag: git + + - name: got + description: For when you type your aliases so fast you miss a key. + value: git + tag: git + + - name: cdp + value: cdproject + tag: python + + - name: wk + value: workon + tag: python + + - name: sqlite + value: sqlite3 + + - name: ssh + description: >- + Used in my Termux setup because the ssh-agent compatible ssh is ssha. + value: ssha + tag: specific + hosts: + - termux + + - name: shutdown + value: exit + description: |- + As an i3 user, the easiest way for me to shut the computer down is to + use `shutdown now`. I can use i3's launcher to do that, or I can just + run that in any terminal that I already have opened. As I often leave an + SSH connection to tilde.town opened for a while when my home computer is + running, sometimes I accidentally try to shut the town down! + + Luckily, it does not let me do that because there are other users + logged on, but I set an alias just to avoid the little scare I can + get from that. + tag: specific + hosts: + - tildetown + + - name: joke + type: git + value: '!curl -s https://raw.githubusercontent.com/EugeneKay/git-jokes/lulz/Jokes.txt | shuf | head -n1' + tag: fun + + - name: ytdl + value: youtube-dl + + - name: weather + value: 'curl --fail -s "https://wttr.in/?format=v2"' + + - name: moon + value: 'curl --fail -s "https://wttr.in/moon"' + + - name: ./maange.py + description: Yet another fat finger autocorrector, but for Django. + value: ./manage.py + tag: python + + - name: ./maange.Py + value: ./manage.py + tag: python + + - name: prunetmpenv + description: >- + Using virtualenvwrapper's `mktmpenv`, then not deactivating properly, + results in useless environments piling up! + value: 'rmvirtualenv $(wk | grep ^tmp-)' + tag: python + + - name: unzst + description: Because I always forget how to extract .tar.zst archives. + value: tar -I zstd -xf + + - name: flushall + description: Clear all of the local Redis database! + value: "echo FLUSHALL | redis-cli" + tag: specific + + - name: poule + value: pull + description: >- + French pun: the french noun «poule» (chicken) is pronounced + in the same way as the english verb "pull". + type: git + tag: fun + + - name: gud + description: Mac- and Linux-compatible. + value: >- + !xdg-open http://lmgtfy.com/\?s\=d\&iie\=1\&q\=how+to+use+git 2>/dev/null + || open http://lmgtfy.com/\?s\=d\&iie\=1\&q\=how+to+use+git + type: git + tag: fun + + - name: mkcd + type: function + description: Stolen from some reply on StackExchange. + value: |- + case "$1" in + */..|*/../) cd -- "$1";; + /*/../*) (cd "${1%/../*}/.." && mkdir -p "./${1##*/../}") && cd -- "$1";; + /*) mkdir -p "$1" && cd "$1";; + */../*) (cd "./${1%/../*}/.." && mkdir -p "./${1##*/../}") && cd "./$1";; + ../*) (cd .. && mkdir -p "${1#.}") && cd "$1";; + *) mkdir -p "./$1" && cd "./$1";; + esac + + - name: ytmp3 + type: function + description: >- + I mostly only ever use youtube-dl to fill my music library. + You can use this as `ytmp3 dQw4w9WgXcQ` to use the video's original title, + or `ytmp3 dQw4w9WgXcQ "We Are Number One"` to use your own. + value: 'youtube-dl -x --audio-format mp3 -o "${2:-%(title)s}.%(ext)s" "$1"' + + - name: ttm + type: function + value: 'curl -F"file=@$1" https://ttm.sh' + + - name: ttmu + type: function + value: 'curl -F"url=$1" https://ttm.sh' + + - name: shorten + type: function + value: 'curl -F"shorten=$1" https://ttm.sh' + + - name: oxo + type: function + value: 'curl -F"file=@$1" https://0x0.st' + + - name: gbdo + type: function + value: 'git push origin -d $@ && git branch -D $@' + tag: git + + - name: gpmr + type: function + description: >- + Git push with options for automatically creating a GitLab merge request + with a given title. + value: |- + [ "$#" -le 0 ] && echo "Usage: $0 <other options>" && return 1 + local title=$1 + shift + git push -u origin \ + -o merge_request.create \ + -o merge_request.target=master \ + -o merge_request.remove_source_branch \ + -o merge_request.title="$title" \ + $* + tag: git diff --git a/aliasindex/__init__.py b/aliasindex/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/aliasindex/__main__.py b/aliasindex/__main__.py new file mode 100755 index 0000000..21d4a8c --- /dev/null +++ b/aliasindex/__main__.py @@ -0,0 +1,157 @@ +#!/usr/bin/python3 +from datetime import datetime, timezone +from jinja2 import Environment, select_autoescape +from pathlib import Path +from .schema import Document +import argparse +import re +import shlex +import unicodedata +import yaml + +BASE_DIR = Path(__file__).absolute().parent +ENV = Environment( + extensions=[ + 'jinja2_highlight.HighlightExtension', + 'jinja2_markdown.MarkdownExtension', + ], + autoescape=select_autoescape(['html']), + trim_blocks=True, + lstrip_blocks=True, +) + + +def slugify(text): + text = unicodedata \ + .normalize('NFKD', text) \ + .encode('ascii', 'ignore') \ + .decode('ascii') + text = re.sub(r'[^\w\s-]', '', text).strip().lower() + return re.sub(r'[-\s]+', '-', text) + + +ENV.filters.update({ + 'slug': slugify, + 'quote': shlex.quote, +}) + + +def build_html(*, data=None, template=None, dest_dir=None): + with template.open() as f: + tpl = ENV.from_string(f.read()) + + timestamp = datetime.now(timezone.utc).isoformat(timespec='seconds') + + with (dest_dir / 'index.html').open('w') as f: + f.write(tpl.render(timestamp=timestamp, data=data)) + + +def build_sh(*, data=None, template=None, dest_dir=None): + with template.open() as f: + tpl = ENV.from_string(f.read()) + + with (dest_dir / 'aliases.sh').open('w') as f: + f.write(tpl.render(data=data)) + + +def validate_args(args): + assert args.src.is_file(), 'src should be an existing file' + assert args.dest_dir.is_dir(), 'dest_dir should be an existing directory' + assert any([ + args.validate, + args.html_template, + args.shell_template, + ]), 'Nothing to do!' + + if args.html_template: + assert args.html_template.is_file(), 'HTML template does not exist' + if args.shell_template: + assert args.shell_template.is_file(), 'Shell template does not exist' + + +def absolute_path(value): + return Path(value).expanduser().absolute() + + +def main(): + parser = argparse.ArgumentParser(description='Generate the alias index.') + parser.add_argument( + '--src', + type=absolute_path, + help='YAML file to fetch alias data from', + default='./aliases.yml', + ) + parser.add_argument( + '--dest-dir', + type=absolute_path, + help='Destination path', + default='./output', + ) + + action_group = parser.add_mutually_exclusive_group() + action_group.add_argument( + '--validate', + help='Validate the schema without generating anything', + action='store_true', + ) + + html_group = parser.add_mutually_exclusive_group() + html_group.add_argument( + '-H', '--html-template', + type=absolute_path, + help='HTML template path', + default=BASE_DIR / 'template.html', + ) + html_group.add_argument( + '--no-html', + help='Disable HTML generation', + action='store_false', + dest='html_template', + ) + + shell_group = parser.add_mutually_exclusive_group() + shell_group.add_argument( + '-S', '--shell-template', + type=absolute_path, + help='Shell script template path', + default=BASE_DIR / 'template.sh', + ) + shell_group.add_argument( + '--no-shell', + help='Disable shell script generation', + action='store_false', + dest='shell_template', + ) + + args = parser.parse_args() + + try: + validate_args(args) + except AssertionError as e: + parser.error(str(e)) + + with args.src.open() as f: + data = yaml.load(f.read()) + + data = Document.validate(data) + + if args.validate: + return + + if args.html_template: + build_html( + data=data, + template=args.html_template, + dest_dir=args.dest_dir, + ) + + if args.shell_template: + build_sh( + data=data, + template=args.shell_template, + dest_dir=args.dest_dir, + ) + + +if __name__ == '__main__': + main() diff --git a/aliasindex/schema.py b/aliasindex/schema.py new file mode 100644 index 0000000..d82b8c3 --- /dev/null +++ b/aliasindex/schema.py @@ -0,0 +1,69 @@ +from typesystem import ( + Schema, SchemaDefinitions, + String, Text, Boolean, Choice, + Array, Reference, +) + +definitions = SchemaDefinitions() + + +class Tag(Schema, definitions=definitions): + name = String(min_length=1) + description = Text(allow_null=True) + + +class Alias(Schema, definitions=definitions): + name = String(min_length=1) + description = Text(allow_null=True) + type = Choice(choices=[ + ('alias', 'A shell alias'), + ('git', 'A Git alias'), + ('function', 'A shell function'), + ], default='alias') + value = Text(min_length=1) + private = Boolean( + default=False, + description='Exclude this alias from public templates.', + ) + hosts = Array( + items=String(min_length=1, pattern=r'^[A-Za-z0-9-_]+$'), + unique_items=True, + default=list, + description='Restrict this alias to a specific list of hosts ' + 'when synchronizing.', + ) + tag = String(allow_null=True) + + +class Document(Schema, definitions=definitions): + tags = Array(items=Reference(to=Tag), default=list) + aliases = Array(items=Reference(to=Alias), min_items=1) + + @classmethod + def validate(cls, value, *, strict=False): + doc = super().validate(value=value, strict=strict) + + tag_names = set() + for tag in doc.tags: + if tag.name in tag_names: + raise ValidationError( + 'Tag name {!r} is defined multiple times'.format(tag.name) + ) + tag_names.add(tag.name) + + alias_names = set() + for alias in doc.aliases: + if alias.name in alias_names: + raise ValidationError( + 'Alias name {!r} ' + 'is defined multiple times'.format(alias.name) + ) + alias_names.add(alias.name) + + if alias.tag and alias.tag not in tag_names: + raise ValidationError( + 'Alias {!r} refers to unknown tag {!r}'.format( + alias.name, alias.tag) + ) + + return doc diff --git a/aliasindex/template.html b/aliasindex/template.html new file mode 100644 index 0000000..8c8d4ec --- /dev/null +++ b/aliasindex/template.html @@ -0,0 +1,112 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title>the shell spellbook + + + + + + + + + + {% macro funchighlight(func) -%} + {% highlight 'zsh',lineno='table' %} +function {{ func.name|quote }} () { +{{ func.value|indent(first=True) }} +} + {% endhighlight %} + {% endmacro %} + {% macro printalias(alias) -%} + {% if alias.type == 'git' %} +

git {{ alias.name }}

+ {% else %} +

{{ alias.name }}

+ {% endif %} + {% if alias.description %} + {% markdown %}{{ alias.description|safe }}{% endmarkdown %} + {% endif %} + {% if alias.type == 'git' %} + {% highlight 'zsh' %}git config --global {{ ('alias.' + alias.name)|quote }} {{ alias.value|quote }}{% endhighlight %} + {% elif alias.type == 'function' %} + {% autoescape false %} + {{ funchighlight(alias)|replace('\n', '
') }} + {% endautoescape %} + {% elif alias.type == 'alias' %} + {% highlight 'zsh' %}alias {{ alias.name|quote }}={{ alias.value|quote }}{% endhighlight %} + {% else %} + {% highlight 'zsh' %}{{ alias.value }}{% endhighlight %} + {% endif %} + {%- endmacro %} + {% macro section(title, slug='', description='', aliases=[]) -%} +
+ back to top +

{{ title }}

+ {% if description %} + {% markdown %}{{ description|safe }}{% endmarkdown %} + {% endif %} + {% for alias in aliases|sort(attribute='name') %} + {{ printalias(alias) }} + {% endfor %} +
+ {%- endmacro %} + +

the shell spellbook

+

+ {{ data.aliases|selectattr('private', 'eq', False)|selectattr('type', 'eq', 'alias')|list|length }} aliases, + {{ data.aliases|selectattr('private', 'eq', False)|selectattr('type', 'eq', 'git')|list|length }} git aliases, + {{ data.aliases|selectattr('private', 'eq', False)|selectattr('type', 'eq', 'function')|list|length }} functions +
+ last updated: {{ timestamp }} +

+
+

This page holds a collection of shell aliases and functions I use regularly. I will soon write a sync script to automatically update my alias collection on every computer I use to turn this into an over-engineered alias management system.

+

This is generated using jinja2 from a YAML file of mine. Note that some aliases might have a strange escaping because I escape them using Python's shlex module.

+

contents

+
    + {% for tag in data.tags|sort(attribute='name') %} +
  • + {{ tag.name }} + {% if tag.description %} +
    + {{ tag.description }} + {% endif %} +
    • + {% endfor %} + {% if data.aliases|selectattr('private', 'eq', False)|selectattr('tag', 'none')|list|length %} +
  • uncategorized
    • + {% endif %} +
+
+ + {% for tag in data.tags|sort(attribute='name') %} + {{ section(tag.name, tag.name|slug, tag.description, data.aliases|selectattr('private', 'eq', False)|selectattr('tag', 'eq', tag.name)|list) }} + {% endfor %} + + {% if data.aliases|selectattr('private', 'eq', False)|selectattr('tag', 'none')|list|length %} + {{ section('uncategorized', '__uncategorized__', '', data.aliases|selectattr('private', 'eq', False)|selectattr('tag', 'none')|list) }} + {% endif %} + + diff --git a/aliasindex/template.sh b/aliasindex/template.sh new file mode 100644 index 0000000..1e90f74 --- /dev/null +++ b/aliasindex/template.sh @@ -0,0 +1 @@ +TODO! diff --git a/highlight.css b/highlight.css new file mode 100644 index 0000000..acb8696 --- /dev/null +++ b/highlight.css @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #ffffff; } +.highlight .c { color: #808080 } /* Comment */ +.highlight .err { color: #F00000; background-color: #F0A0A0 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #303030 } /* Operator */ +.highlight .cm { color: #808080 } /* Comment.Multiline */ +.highlight .cp { color: #507090 } /* Comment.Preproc */ +.highlight .c1 { color: #808080 } /* Comment.Single */ +.highlight .cs { color: #cc0000; font-weight: bold } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #808080 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #003080; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #303090; font-weight: bold } /* Keyword.Type */ +.highlight .m { color: #6000E0; font-weight: bold } /* Literal.Number */ +.highlight .s { color: #D04020 } /* Literal.String */ +.highlight .na { color: #0000C0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #B00060; font-weight: bold } /* Name.Class */ +.highlight .no { color: #003060; font-weight: bold } /* Name.Constant */ +.highlight .nd { color: #505050; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #800000; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #F00000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0060B0; font-weight: bold } /* Name.Function */ +.highlight .nl { color: #907000; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #007000 } /* Name.Tag */ +.highlight .nv { color: #906030 } /* Name.Variable */ +.highlight .ow { color: #000000; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #6000E0; font-weight: bold } /* Literal.Number.Float */ +.highlight .mh { color: #005080; font-weight: bold } /* Literal.Number.Hex */ +.highlight .mi { color: #0000D0; font-weight: bold } /* Literal.Number.Integer */ +.highlight .mo { color: #4000E0; font-weight: bold } /* Literal.Number.Oct */ +.highlight .sb { background-color: #fff0f0 } /* Literal.String.Backtick */ +.highlight .sc { color: #0040D0 } /* Literal.String.Char */ +.highlight .sd { color: #D04020 } /* Literal.String.Doc */ +.highlight .s2 { background-color: #fff0f0 } /* Literal.String.Double */ +.highlight .se { color: #606060; font-weight: bold; background-color: #fff0f0 } /* Literal.String.Escape */ +.highlight .sh { background-color: #fff0f0 } /* Literal.String.Heredoc */ +.highlight .si { background-color: #e0e0e0 } /* Literal.String.Interpol */ +.highlight .sx { color: #D02000; background-color: #fff0f0 } /* Literal.String.Other */ +.highlight .sr { color: #000000; background-color: #fff0ff } /* Literal.String.Regex */ +.highlight .s1 { color: #D04020 } /* Literal.String.Single */ +.highlight .ss { color: #A06000 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #306090 } /* Name.Variable.Class */ +.highlight .vg { color: #d07000; font-weight: bold } /* Name.Variable.Global */ +.highlight .vi { color: #3030B0 } /* Name.Variable.Instance */ +.highlight .il { color: #0000D0; font-weight: bold } /* Literal.Number.Integer.Long */ diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4270a88 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +Jinja2~=2.10 +Pygments~=1.5 +jinja2-highlight~=0.6.1 +PyYAML~=5.1 +typesystem~=0.2.4