diff --git a/.forgejo/workflows/main.yaml b/.forgejo/workflows/main.yaml deleted file mode 100644 index 123fb8c..0000000 --- a/.forgejo/workflows/main.yaml +++ /dev/null @@ -1,19 +0,0 @@ -on: [push] -jobs: - job: - runs-on: ubuntu-latest - container: - image: ${{vars.DOCKER}}debian:bookworm - steps: - - name: spcd - env: - SPCD: ${{vars.SPCD}} - SPCD_SSH_HOSTS: ${{vars.SPCD_SSH_HOSTS}} - SPCD_SSH_KEY: ${{secrets.SPCD_SSH_KEY}} - SPCD_TXT_LOCALE: ${{vars.SPCD_TXT_LOCALE}} - run: ${{vars.SPCD}} - - #- run: spcd-check-project - - run: spcd-build-project - - run: spcd-browse-workspace - - run: spcd-synchronize diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 4909e08..0000000 --- a/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -__pycache__ -/tmp -/.venv -/.vscode -/dist diff --git a/license.md b/license.md deleted file mode 100644 index c6f01c6..0000000 --- a/license.md +++ /dev/null @@ -1,660 +0,0 @@ -# GNU AFFERO GENERAL PUBLIC LICENSE - -Version 3, 19 November 2007 - -Copyright (C) 2007 Free Software Foundation, Inc. - - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - -## Preamble - -The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - -The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains -free software for all its users. - -When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - -Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - -A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - -The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - -An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing -under this license. - -The precise terms and conditions for copying, distribution and -modification follow. - -## TERMS AND CONDITIONS - -### 0. Definitions. - -"This License" refers to version 3 of the GNU Affero General Public -License. - -"Copyright" also means copyright-like laws that apply to other kinds -of works, such as semiconductor masks. - -"The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - -To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of -an exact copy. The resulting work is called a "modified version" of -the earlier work or a work "based on" the earlier work. - -A "covered work" means either the unmodified Program or a work based -on the Program. - -To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - -To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user -through a computer network, with no transfer of a copy, is not -conveying. - -An interactive user interface displays "Appropriate Legal Notices" to -the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -### 1. Source Code. - -The "source code" for a work means the preferred form of the work for -making modifications to it. "Object code" means any non-source form of -a work. - -A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - -The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - -The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - -The Corresponding Source need not include anything that users can -regenerate automatically from other parts of the Corresponding Source. - -The Corresponding Source for a work in source code form is that same -work. - -### 2. Basic Permissions. - -All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - -You may make, run and propagate covered works that you do not convey, -without conditions so long as your license otherwise remains in force. -You may convey covered works to others for the sole purpose of having -them make modifications exclusively for you, or provide you with -facilities for running those works, provided that you comply with the -terms of this License in conveying all material for which you do not -control copyright. Those thus making or running the covered works for -you must do so exclusively on your behalf, under your direction and -control, on terms that prohibit them from making any copies of your -copyrighted material outside their relationship with you. - -Conveying under any other circumstances is permitted solely under the -conditions stated below. Sublicensing is not allowed; section 10 makes -it unnecessary. - -### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - -No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - -When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such -circumvention is effected by exercising rights under this License with -respect to the covered work, and you disclaim any intention to limit -operation or modification of the work as a means of enforcing, against -the work's users, your or third parties' legal rights to forbid -circumvention of technological measures. - -### 4. Conveying Verbatim Copies. - -You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -### 5. Conveying Modified Source Versions. - -You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these -conditions: - -- a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. -- b) The work must carry prominent notices stating that it is - released under this License and any conditions added under - section 7. This requirement modifies the requirement in section 4 - to "keep intact all notices". -- c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. -- d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - -A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -### 6. Conveying Non-Source Forms. - -You may convey a covered work in object code form under the terms of -sections 4 and 5, provided that you also convey the machine-readable -Corresponding Source under the terms of this License, in one of these -ways: - -- a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. -- b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the Corresponding - Source from a network server at no charge. -- c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. -- d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. -- e) Convey the object code using peer-to-peer transmission, - provided you inform other peers where the object code and - Corresponding Source of the work are being offered to the general - public at no charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - -A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, -family, or household purposes, or (2) anything designed or sold for -incorporation into a dwelling. In determining whether a product is a -consumer product, doubtful cases shall be resolved in favor of -coverage. For a particular product received by a particular user, -"normally used" refers to a typical or common use of that class of -product, regardless of the status of the particular user or of the way -in which the particular user actually uses, or expects or is expected -to use, the product. A product is a consumer product regardless of -whether the product has substantial commercial, industrial or -non-consumer uses, unless such uses represent the only significant -mode of use of the product. - -"Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to -install and execute modified versions of a covered work in that User -Product from a modified version of its Corresponding Source. The -information must suffice to ensure that the continued functioning of -the modified object code is in no case prevented or interfered with -solely because modification has been made. - -If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - -The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or -updates for a work that has been modified or installed by the -recipient, or for the User Product in which it has been modified or -installed. Access to a network may be denied when the modification -itself materially and adversely affects the operation of the network -or violates the rules and protocols for communication across the -network. - -Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -### 7. Additional Terms. - -"Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders -of that material) supplement the terms of this License with terms: - -- a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or -- b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or -- c) Prohibiting misrepresentation of the origin of that material, - or requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or -- d) Limiting the use for publicity purposes of names of licensors - or authors of the material; or -- e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or -- f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions - of it) with contractual assumptions of liability to the recipient, - for any liability that these contractual assumptions directly - impose on those licensors and authors. - -All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - -Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; the -above requirements apply either way. - -### 8. Termination. - -You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -### 9. Acceptance Not Required for Having Copies. - -You are not required to accept this License in order to receive or run -a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -### 10. Automatic Licensing of Downstream Recipients. - -Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - -An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - -You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -### 11. Patents. - -A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - -A contributor's "essential patent claims" are all patent claims owned -or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - -Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - -In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - -If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - -A patent license is "discriminatory" if it does not include within the -scope of its coverage, prohibits the exercise of, or is conditioned on -the non-exercise of one or more of the rights that are specifically -granted under this License. You may not convey a covered work if you -are a party to an arrangement with a third party that is in the -business of distributing software, under which you make payment to the -third party based on the extent of your activity of conveying the -work, and under which the third party grants, to any of the parties -who would receive the covered work from you, a discriminatory patent -license (a) in connection with copies of the covered work conveyed by -you (or copies made from those copies), or (b) primarily for and in -connection with specific products or compilations that contain the -covered work, unless you entered into that arrangement, or that patent -license was granted, prior to 28 March 2007. - -Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -### 12. No Surrender of Others' Freedom. - -If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under -this License and any other pertinent obligations, then as a -consequence you may not convey it at all. For example, if you agree to -terms that obligate you to collect a royalty for further conveying -from those to whom you convey the Program, the only way you could -satisfy both those terms and this License would be to refrain entirely -from conveying the Program. - -### 13. Remote Network Interaction; Use with the GNU General Public License. - -Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your -version supports such interaction) an opportunity to receive the -Corresponding Source of your version by providing access to the -Corresponding Source from a network server at no charge, through some -standard or customary means of facilitating copying of software. This -Corresponding Source shall include the Corresponding Source for any -work covered by version 3 of the GNU General Public License that is -incorporated pursuant to the following paragraph. - -Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - -### 14. Revised Versions of this License. - -The Free Software Foundation may publish revised and/or new versions -of the GNU Affero General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever -published by the Free Software Foundation. - -If the Program specifies that a proxy can decide which future versions -of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - -Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -### 15. Disclaimer of Warranty. - -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT -WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND -PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE -DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR -CORRECTION. - -### 16. Limitation of Liability. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR -CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES -ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT -NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR -LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM -TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER -PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -### 17. Interpretation of Sections 15 and 16. - -If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - -END OF TERMS AND CONDITIONS - -## How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these -terms. - -To do so, attach the following notices to the program. It is safest to -attach them to the start of each source file to most effectively state -the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as - published by the Free Software Foundation, either version 3 of the - License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper -mail. - -If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for -the specific requirements. - -You should also get your employer (if you work as a programmer) or -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. For more information on this, and how to apply and follow -the GNU AGPL, see . diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 7a3d9c9..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,32 +0,0 @@ -[build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" - -[project] -authors = [ - { name = "Marc Beninca", email = "git@marc.beninca.link" }, -] -maintainers = [ - { name = "Marc Beninca", email = "git@marc.beninca.link" }, -] -classifiers = [ - "Programming Language :: Python :: 3", - "License :: OSI Approved :: GNU Affero General Public License v3", - "Operating System :: OS Independent", -] -dependencies = [] -description = "Read Write eXecute" -dynamic = ["version"] -keywords = [] -license-files = ["license.md"] -name = "rwx" -readme = "readme.md" -requires-python = ">= 3.11" - -[project.scripts] -# command = "package.module:function" - -[project.urls] - -[tool.hatch.version] -path = "rwx/__init__.py" diff --git a/readme.md b/readme.md deleted file mode 100644 index 532211c..0000000 --- a/readme.md +++ /dev/null @@ -1,121 +0,0 @@ -# Read Write eXecute - -One project to rule them all. - ---- - -## Table Of Contents {#toc} - -* 1 [Why](#why) -* 2 [How](#how) - * 2.1 [Shell](#how-shell) - * 2.2 [Python](#how-python) -* 3 [What](#what) - * 3.1 [Features](#what-features) - * 3.2 [Environment variables](#what-variables) -* 4 [Who](#who) -* 5 [Where](#where) - * 5.1 [Chat](#where-chat) - * 5.2 [Repo](#where-repo) - * 5.3 [Site](#where-site) -* 6 [When](#when) - * 6.1 [Release tasks](#when-release) - * 6.2 [Further tasks](#when-further) - ---- - -## 1 [Why](#toc) {#why} - ---- - -## 2 [How](#toc) {#how} - -Two interpreted languages for flexibility. - -### 2.1 [Shell](#how) {#how-shell} - -* [X] functions to - * [X] alias - * [X] lint - * [X] Git - * [X] Python - * [X] Shell - * [X] log - * [X] rescue - * [X] Hetzner - * [X] OVH -* [X] profiles - * [X] ffmpeg - * [X] tmux - -### 2.2 [Python](#how) {#how-python} - ---- - -## 3 [What](#toc) {#what} - -### 3.1 [Features](#what) {#what-features} - -* [ ] self - * [ ] install modules - -### 3.2 [Environment variables](#what) {#what-variables} - ---- - -## 4 [Who](#toc) {#who} - -* Author: [Marc Beninca](https://forge.rwx.work/marc.beninca) - ---- - -## 5 [Where](#toc) {#where} - -### 5.1 [Chat](#where) {#where-chat} - -* [Discord](https://discord.com/channels/983145051985154108/1255894474895134761) -* [IRC](ircs://irc.libera.chat/##rwx) - -### 5.2 [Repo](#where) {#where-repo} - -* [Code](https://forge.rwx.work/rwx.work/rwx) -* [Feed](https://forge.rwx.work/rwx.work/rwx.rss) -* [Actions](https://forge.rwx.work/rwx.work/rwx/actions) - -### 5.3 [Site](#where) {#where-site} - -* [Web](https://rwx.rwx.work) - ---- - -## 6 [When](#toc) {#when} - -### 6.1 [Release tasks](#when) {#when-release} - -#### Python - -* character constants for box drawing -* common __str__ function -* parse pyproject.toml to write commands -* write classes for - * steps bars to log - * system commands to run - * with single call of subprocess.run - * or alternate subprocess method? - -#### Shell - -* git switch signing commits & tags -* shellcheck & shfmt -* python tools -* log -* hetzner -* apt - * apt-file search | grep -* ffmpeg -* tmux - * get unresolved path for new panes & windows -* fully working doc function algorithm -* self install aliases - -### 6.2 [Further tasks](#when) {#when-further} diff --git a/render.py b/render.py deleted file mode 100755 index 3a0a957..0000000 --- a/render.py +++ /dev/null @@ -1,11 +0,0 @@ -#! /usr/bin/env python3 -"""Dummy build.""" - -from pathlib import Path - -from rwx.fs import make_directory, write - -if __name__ == "__main__": - out = Path(__file__).parent / "out" / "web" - make_directory(out) - write(out / "index.html", "rwx.rwx.work") diff --git a/rwx/__init__.py b/rwx/__init__.py deleted file mode 100644 index 3dbfd68..0000000 --- a/rwx/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -"""Read Write eXecute.""" - -__version__ = "0.0.1" - -from os import linesep - - -class Object: - """Root object.""" - - def __repr__(self) -> str: - """Return machine-readable state. - - :return: state - :rtype: str - """ - name = self.__class__.__name__ - attributes = [ - f"{k}={v!r}" for k, v in vars(self).items() if not k.startswith("_") - ] - arguments = ", ".join(attributes) - return f"{name}({arguments})" - - def __str__(self) -> str: - """Return human-readable state. - - :return: state - :rtype: str - """ - attributes = [ - f"{k} = {v}" for k, v in vars(self).items() if not k.startswith("_") - ] - return linesep.join(attributes) diff --git a/rwx/__main__.py b/rwx/__main__.py deleted file mode 100755 index e19dea1..0000000 --- a/rwx/__main__.py +++ /dev/null @@ -1,19 +0,0 @@ -#! /usr/bin/env python3 - -"""Entry point.""" - -from pathlib import Path - -from rwx import fs - -if __name__ == "__main__": - file_path: Path = Path(__file__).resolve() - root_path: Path = file_path.parent - directory_path: Path = root_path / "tmp" - file_path = directory_path / "file" - - fs.wipe(directory_path) - fs.make_directory(directory_path) - fs.write(file_path, "Martine écrit beaucoup.") - fs.empty_file(file_path) - fs.write(file_path, "Martine écrit moins.") diff --git a/rwx/arg/__init__.py b/rwx/arg/__init__.py deleted file mode 100644 index a35dd4f..0000000 --- a/rwx/arg/__init__.py +++ /dev/null @@ -1,13 +0,0 @@ -"""Handle system arguments.""" - -import sys - - -def split() -> tuple[str, list[str]]: - """Split command & actual arguments. - - :return: both - :rtype: tuple[str, list[str]] - """ - command, *arguments = sys.argv - return command, arguments diff --git a/rwx/cmd/__init__.py b/rwx/cmd/__init__.py deleted file mode 100644 index be9e540..0000000 --- a/rwx/cmd/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -"""Handle system commands & packages.""" - -commands: list[str] = [] -packages: list[str] = [] - - -def need(command: str) -> None: - """Assert package dependency for a command. - - :param command: name of the requested command - :type command: str - """ - package: str | None - match command: - case "debootstrap": - package = "debootstrap" - case "mksquashfs" | "unsquashfs": - package = "squashfs-tools" - case _: - package = None - if package and package not in packages: - packages.append(package) diff --git a/rwx/cmd/squashfs/__init__.py b/rwx/cmd/squashfs/__init__.py deleted file mode 100644 index b3ec864..0000000 --- a/rwx/cmd/squashfs/__init__.py +++ /dev/null @@ -1,26 +0,0 @@ -"""Wrap SquashFS commands.""" - -from pathlib import Path - -from rwx import cmd, ps - -cmd.need("mksquashfs") - - -def mksquashfs(input_root: Path, output_file: Path) -> None: - """Make a SquashFS bootable image file. - - :param input_root: ? - :type input_root: Path - :param output_file: ? - :type output_file: Path - """ - ps.run( - "mksquashfs", - str(input_root), - str(output_file), - "-comp", - "zstd", - "-Xcompression-level", - str(18), - ) diff --git a/rwx/deb/__init__.py b/rwx/deb/__init__.py deleted file mode 100644 index 2537321..0000000 --- a/rwx/deb/__init__.py +++ /dev/null @@ -1,31 +0,0 @@ -"""Wrap Debian commands.""" - -from pathlib import Path - -from rwx import cmd, ps - -cmd.need("debootstrap") - -BOOTSTRAP_ARCHITECTURE = "amd64" -BOOTSTRAP_VARIANT = "minbase" - - -def bootstrap(root_path: Path, suite: str, mirror_location: str) -> None: - """Boostrap a base operating filesystem. - - :param root_path: target output path - :type root_path: Path - :param suite: target distribution name - :type suite: str - :param mirror_location: source input repository - :type mirror_location: str - """ - command = ( - "debootstrap", - ("--arch", BOOTSTRAP_ARCHITECTURE), - ("--variant", BOOTSTRAP_VARIANT), - suite, - str(root_path), - mirror_location, - ) - ps.run(*command) diff --git a/rwx/err/__init__.py b/rwx/err/__init__.py deleted file mode 100644 index 6c473e0..0000000 --- a/rwx/err/__init__.py +++ /dev/null @@ -1,7 +0,0 @@ -"""Handle errors.""" - -from rwx import Object - - -class Error(Object, Exception): - """Parent class for all errors.""" diff --git a/rwx/fs/__init__.py b/rwx/fs/__init__.py deleted file mode 100644 index b55713a..0000000 --- a/rwx/fs/__init__.py +++ /dev/null @@ -1,172 +0,0 @@ -"""Operations involving FileSystems.""" - -import os -import shutil -import tomllib -import yaml -from pathlib import Path - -from rwx import ps - -CHARSET = "UTF-8" - - -def create_image(file_path: Path, size_bytes: int) -> None: - """Create a virtual device image file. - - :param file_path: target image file - :type file_path: Path - :param size_bytes: virtual volume - :type size_bytes: int - """ - ps.run( - ("qemu-img", "create"), - ("-f", "qcow2"), - (str(file_path), str(size_bytes)), - ) - - -def empty_file(path: Path) -> None: - """Empty the file at provided path. - - :param path: target file to empty - :type path: Path - """ - write(path, "") - - -def get_mount_uuid(path: Path) -> str: - """Return the filesystem UUID of a mountpoint path. - - :param path: mountpoint path - :type path: Path - :rtype: str - """ - return ps.run_line( - "findmnt", - "--noheadings", - ("--output", "UUID"), - str(path), - ) - - -def get_path_mount(path: Path) -> Path: - """Return the mountpoint path of an arbitrary path. - - :param path: arbitrary path - :type path: Path - :rtype: Path - """ - return Path( - ps.run_line( - "stat", - ("--format", "%m"), - str(path), - ), - ) - - -def get_path_uuid(path: Path) -> str: - """Return the filesystem UUID of an arbitrary path. - - :param path: arbitrary path - :type path: Path - :rtype: str - """ - return get_mount_uuid(get_path_mount(path)) - - -def make_directory(path: Path) -> None: - """Make a directory (and its parents) from a path. - - :param path: directory to create - :type path: Path - """ - path.mkdir(exist_ok=True, parents=True) - - -def read_file_bytes(file_path: Path) -> bytes: - """Read whole file bytes. - - :param file_path: source input file - :type file_path: Path - :rtype: bytes - """ - with file_path.open("br") as file_object: - return file_object.read() - - -def read_file_dict(file_path: Path, charset: str = CHARSET) -> dict: - """Read whole file as toml object. - - :param file_path: source input file - :type file_path: Path - :param charset: charset to use for decoding input - :type charset: str - :rtype: dict - """ - text = read_file_text(file_path, charset) - return tomllib.loads(text) - - -def read_file_lines(file_path: Path, charset: str = CHARSET) -> list[str]: - """Read whole file lines. - - :param file_path: source input file - :type file_path: Path - :param charset: charset to use for decoding input - :type charset: str - :rtype: list[str] - """ - return read_file_text(file_path, charset).split(os.linesep) - - -def read_file_text(file_path: Path, charset: str = CHARSET) -> str: - """Read whole file text. - - :param file_path: source input file - :type file_path: Path - :param charset: charset to use for decoding input - :type charset: str - :rtype: str - """ - return read_file_bytes(file_path).decode(charset) - - -def read_file_yaml(file_path: Path, charset: str = CHARSET) -> dict | list: - """Read whole file as yaml object. - - :param file_path: source input file - :type file_path: Path - :param charset: charset to use for decoding input - :type charset: str - :rtype: dict - """ - text = read_file_text(file_path, charset) - return yaml.safe_load(text) - - -def wipe(path: Path) -> None: - """Wipe provided path, whether directory or file. - - :param path: target path - :type path: Path - """ - try: - path.unlink(missing_ok=True) - except IsADirectoryError: - shutil.rmtree(path) - - -def write(file_path: Path, text: str, charset: str = CHARSET) -> None: - """Write text into a file. - - :param file_path: target file path - :type file_path: Path - :param text: content to write - :type text: str - :param charset: charset to use for encoding ouput - :type charset: str - """ - with file_path.open(encoding=charset, mode="w") as file_object: - file_object.write(text) diff --git a/rwx/grub/__init__.py b/rwx/grub/__init__.py deleted file mode 100644 index aa208c3..0000000 --- a/rwx/grub/__init__.py +++ /dev/null @@ -1,54 +0,0 @@ -"""Wrap GRUB commands.""" - -from __future__ import annotations - -from rwx import cmd, ps - -cmd.need("grub-mkimage") - -COMPRESSION = "xz" -ENV_BYTES = 1024 -ENV_COMMENT = "#" -ENV_HEADER = f"""{ENV_COMMENT} GRUB Environment Block -""" -MODULES = { - "i386-pc": [ - ("biosdisk",), - ("ntldr",), - ], -} - - -def make_image( - image_format: str, - image_path: str, - modules: list[str], - memdisk_path: str, - pubkey_path: str | None = None, -) -> None: - """Make a binary bootable image. - - :param image_format: output format (x86_64-efi, i386-pc, arm64-efi) - :type image_format: str - :param image_path: output file - :type image_path: str - :param modules: modules to embed - :type modules: list[str] - :param memdisk_path: archive to include - :type memdisk_path: str - :param pubkey_path: extra public key to add - :type pubkey_path: str | None - """ - args: list[str | tuple[str, ...]] = [ - "grub-mkimage", - ("--compress", COMPRESSION), - ("--format", image_format), - ("--output", image_path), - ("--memdisk", memdisk_path), - ] - if pubkey_path: - args.append(("--pubkey", pubkey_path)) - args.extend(modules) - if extra_modules := MODULES.get(image_format): - args.extend(extra_modules) - ps.run(*args) diff --git a/rwx/log/__init__.py b/rwx/log/__init__.py deleted file mode 100644 index 53cfebc..0000000 --- a/rwx/log/__init__.py +++ /dev/null @@ -1,51 +0,0 @@ -"""Handle logging.""" - -import logging -import sys - - -def get_file_logger(name: str) -> logging.Logger: - """Return a file logger. - - :param name: arbitrary name - :type name: str - :rtype: logging.Logger - """ - # formatter - items = [ - "%(name)s: %(asctime)s", - "%(levelname)s", - "%(filename)s:%(lineno)s", - "%(process)d >>> %(message)s", - ] - template = " | ".join(items) - formatter = logging.Formatter(template) - # handler - out_handler = logging.StreamHandler(stream=sys.stdout) - out_handler.setFormatter(formatter) - out_handler.setLevel(logging.INFO) - # logger - logger = logging.getLogger(name) - logger.addHandler(out_handler) - logger.setLevel(logging.INFO) - return logger - - -def get_stream_logger(level: int) -> logging.Logger: - """Return a stream logger. - - :param level: filtering level - :type level: int - :rtype: logging.Logger - """ - # handler - out_handler = logging.StreamHandler(stream=sys.stdout) - out_handler.setLevel(level) - # logger - logger = logging.getLogger() - logger.addHandler(out_handler) - logger.setLevel(level) - return logger - - -stream = get_stream_logger(logging.INFO) diff --git a/rwx/os/__init__.py b/rwx/os/__init__.py deleted file mode 100644 index 27c1748..0000000 --- a/rwx/os/__init__.py +++ /dev/null @@ -1,20 +0,0 @@ -"""Control Operating Systems.""" - -from os import sep -from pathlib import Path - -from .abstract import OS -from .debian import Debian - - -def from_path(path: Path) -> OS: - """Initialize from an already existing path. - - :param path: source root directory - :type path: Path - :rtype: OS - """ - return Debian(path) - - -up = from_path(Path(sep)) diff --git a/rwx/os/abstract.py b/rwx/os/abstract.py deleted file mode 100644 index 98f3f0d..0000000 --- a/rwx/os/abstract.py +++ /dev/null @@ -1,26 +0,0 @@ -"""Abstract Operating System.""" - -from abc import ABC, abstractmethod -from pathlib import Path - -from rwx import Object - - -class OS(Object, ABC): - """Operating System.""" - - def __init__(self, path: Path) -> None: - """Set root. - - :param path: root directory - :type path: Path - """ - self.root = path - self.name = self.get_name() - - @abstractmethod - def get_name(self) -> str: - """Return mandatory name. - - :rtype: str - """ diff --git a/rwx/os/debian.py b/rwx/os/debian.py deleted file mode 100644 index 5cefdaa..0000000 --- a/rwx/os/debian.py +++ /dev/null @@ -1,14 +0,0 @@ -"""Debian operating system.""" - -from .abstract import OS - - -class Debian(OS): - """Debian operating system.""" - - def get_name(self) -> str: - """Return name. - - :rtype: str - """ - return "Debian" diff --git a/rwx/os/pm/__init__.py b/rwx/os/pm/__init__.py deleted file mode 100644 index 785ce74..0000000 --- a/rwx/os/pm/__init__.py +++ /dev/null @@ -1,29 +0,0 @@ -"""Package Manager.""" - -from abc import ABC, abstractmethod - -from rwx import Object -from rwx.ps import Command - - -class PM(Object, ABC): - """Package Manager.""" - - def __init__(self) -> None: - """Set commands.""" - self.clean = self.get_clean_command() - self.install = self.get_install_command() - - @abstractmethod - def get_clean_command(self) -> Command: - """Command to clean packages cache. - - :rtype: Command - """ - - @abstractmethod - def get_install_command(self) -> Command: - """Command to install package(s). - - :rtype: Command - """ diff --git a/rwx/os/pm/apt.py b/rwx/os/pm/apt.py deleted file mode 100644 index 3e3cb81..0000000 --- a/rwx/os/pm/apt.py +++ /dev/null @@ -1,22 +0,0 @@ -"""Advanced Package Tool.""" - -from rwx.os.pm import PM -from rwx.ps import Command - - -class APT(PM): - """Advanced Package Tool.""" - - def get_clean_command(self) -> Command: - """Return clean command. - - :rtype: Command - """ - return Command() - - def get_install_command(self) -> Command: - """Return install command. - - :rtype: Command - """ - return Command() diff --git a/rwx/prj/__init__.py b/rwx/prj/__init__.py deleted file mode 100644 index 1fb6fc9..0000000 --- a/rwx/prj/__init__.py +++ /dev/null @@ -1,25 +0,0 @@ -"""Handle projects.""" - -from pathlib import Path - -from rwx import Object -from rwx.ps import run - - -class Project(Object): - """Parent class for any type of project.""" - - def __init__(self, file: Path) -> None: - """Set file, root & name. - - :param file: root reference file - :type file: Path - """ - self.raw = file - self.file = self.raw.resolve() - self.root: Path = self.file.parent - self.name: str = self.root.name - - def render(self) -> None: - """Build the project.""" - run(str(self.root / "render.py")) diff --git a/rwx/prj/sphinx.py b/rwx/prj/sphinx.py deleted file mode 100644 index 592e6dd..0000000 --- a/rwx/prj/sphinx.py +++ /dev/null @@ -1,39 +0,0 @@ -"""Project consisting only of a Sphinx documentation.""" - -from typing import TYPE_CHECKING - -from sphinx.cmd.build import build_main - -from rwx.fs import wipe -from rwx.prj import Project - -if TYPE_CHECKING: - from pathlib import Path - - -class SphinxProject(Project): - """Child class for a project based on Sphinx.""" - - def build(self) -> None: - """Build the project.""" - output_root: Path = self.root / "out" - wipe(output_root) - arguments: list[str] = [ - "-E", - "-j", - "2", - "-b", - "html", - "-D", - f"project={self.name}", - "-D", - "master_doc=index", - "-D", - "html_theme=sphinx_rtd_theme", - "-c", - str(self.root), - # "-C", - str(self.root / self.name), - str(output_root / "web"), - ] - build_main(arguments) diff --git a/rwx/ps/__init__.py b/rwx/ps/__init__.py deleted file mode 100644 index 3bef50d..0000000 --- a/rwx/ps/__init__.py +++ /dev/null @@ -1,85 +0,0 @@ -"""Handle processes.""" - -from __future__ import annotations - -import subprocess - -from rwx import Object, txt - - -class Command(Object): - """Command to run.""" - - def __init__(self, *arguments: str | tuple[str, ...]) -> None: - """Set raw & flat arguments. - - :param *arguments: single argument or grouped ones - :type *arguments: str | tuple[str, ...] - """ - self.raw = arguments - self.flat: list[str] = [] - - -def get_tuples_args(*items: str | tuple[str, ...]) -> list[str]: - """Turn arguments tuples into an arguments list. - - :param *items: single item or grouped ones - :type *items: str | tuple[str, ...] - :rtype: list[str] - """ - args: list[str] = [] - for item in items: - match item: - case str(): - args.append(item) - case tuple(): - args.extend(item) - return args - - -def run(*items: str | tuple[str, ...]) -> subprocess.CompletedProcess: - """Run from a list of arguments tuples. - - :param *items: single item or grouped ones - :type *items: str | tuple[str, ...] - :rtype: subprocess.CompletedProcess - """ - return subprocess.run( - get_tuples_args(*items), - capture_output=False, - check=True, - ) - - -def run_line(*items: str | tuple[str, ...], charset: str = txt.CHARSET) -> str: - """Run and return output line. - - :param *items: single item or grouped ones - :type *items: str | tuple[str, ...] - :param charset: charset to use for decoding binary output - :type charset: str - :rtype: str - """ - line, *_ = run_lines(*items, charset=charset) - return line - - -def run_lines( - *items: str | tuple[str, ...], - charset: str = txt.CHARSET, -) -> list[str]: - """Run and return output lines. - - :param *items: single item or grouped ones - :type *items: str | tuple[str, ...] - :param charset: charset to use for decoding binary output - :type charset: str - :rtype: list[str] - """ - process = subprocess.run( - get_tuples_args(*items), - capture_output=True, - check=True, - ) - string = process.stdout.decode(charset) - return string.rstrip().splitlines() diff --git a/rwx/py.typed b/rwx/py.typed deleted file mode 100644 index e69de29..0000000 diff --git a/rwx/sw/freetube/__init__.py b/rwx/sw/freetube/__init__.py deleted file mode 100644 index 250b9c3..0000000 --- a/rwx/sw/freetube/__init__.py +++ /dev/null @@ -1 +0,0 @@ -"""Configure FreeTube.""" diff --git a/rwx/sw/freetube/authors.py b/rwx/sw/freetube/authors.py deleted file mode 100644 index e7cb913..0000000 --- a/rwx/sw/freetube/authors.py +++ /dev/null @@ -1,31 +0,0 @@ -"""FreeTube authors.""" - -from typing import TYPE_CHECKING - -from rwx import Object - -if TYPE_CHECKING: - from .playlists import Playlist - - -class Author(Object): - """FreeTube author.""" - - def __init__(self, uid: str, name: str) -> None: - """Set uid & name. - - :param uid: identifier - :type uid: str - :param name: label - :type name: str - """ - self.uid = uid - self.name = name - self.playlist: Playlist - - def to_db(self) -> str: - """Return non-breakable name. - - :rtype: str - """ - return self.name.replace(" ", chr(0xA0)) diff --git a/rwx/sw/freetube/channels.py b/rwx/sw/freetube/channels.py deleted file mode 100644 index 556dea7..0000000 --- a/rwx/sw/freetube/channels.py +++ /dev/null @@ -1,29 +0,0 @@ -"""FreeTube channels.""" - -from rwx import Object - - -class Channel(Object): - """FreeTube channel.""" - - def __init__(self, uid: str, name: str) -> None: - """Set uid & name. - - :param uid: unique identifier - :type uid: str - :param name: label - :type name: str - """ - self.uid = uid - self.name = name - - def to_db(self) -> str: - """Return identifier as db. - - :rtype: str - """ - return f"""\ -{{\ -"id":"{self.uid}"\ -}}\ -""" diff --git a/rwx/sw/freetube/db.py b/rwx/sw/freetube/db.py deleted file mode 100644 index e3eb31e..0000000 --- a/rwx/sw/freetube/db.py +++ /dev/null @@ -1,21 +0,0 @@ -"""Output FreeTube db.""" - - -def to_db(value: object) -> str: - """Render value as string. - - :param value: value to render - :type value: object - :rtype: str - """ - match value: - case bool(): - text = str(value).lower() - case dict(): - sub = ",".join([f'"{i}":{to_db(v)}' for i, v in value.items()]) - text = f"{{{sub}}}" - case float() | str(): - text = f'"{value}"' - case _: - text = str(value) - return text diff --git a/rwx/sw/freetube/languages.py b/rwx/sw/freetube/languages.py deleted file mode 100644 index beeb173..0000000 --- a/rwx/sw/freetube/languages.py +++ /dev/null @@ -1,24 +0,0 @@ -"""FreeTube languages.""" - -from typing import TYPE_CHECKING - -from rwx import Object - -if TYPE_CHECKING: - from .playlists import Playlist - - -class Language(Object): - """FreeTube language.""" - - def __init__(self, uid: str, name: str) -> None: - """Set uid & name. - - :param uid: identifier - :type uid: str - :param name: label - :type name: str - """ - self.uid = uid - self.name = name - self.playlist: Playlist diff --git a/rwx/sw/freetube/playlists.py b/rwx/sw/freetube/playlists.py deleted file mode 100644 index f4b17de..0000000 --- a/rwx/sw/freetube/playlists.py +++ /dev/null @@ -1,47 +0,0 @@ -"""FreeTube playlists.""" - -from rwx import Object - -from .videos import Video - - -class Playlist(Object): - """FreeTube playlist.""" - - def __init__(self, uid: str, name: str) -> None: - """Set uid & name. - - :param uid: identifier - :type uid: str - :param name: label - :type name: str - """ - self.uid = uid - self.name = name - self.videos: list[Video] = [] - - def add(self, video: Video) -> None: - """Add video. - - :param video: video to add - :type video: Video - """ - self.videos.append(video) - - def to_db(self) -> str: - """Return identifier, name & videos. - - :rtype: str - """ - videos = ",".join([video.to_db() for video in self.videos]) - return f"""\ -{{\ -"_id":"{self.uid}"\ -,\ -"playlistName":"{self.name}"\ -,\ -"protected":true\ -,\ -"videos":[{videos}]\ -}}\ -""" diff --git a/rwx/sw/freetube/profiles.py b/rwx/sw/freetube/profiles.py deleted file mode 100644 index e164296..0000000 --- a/rwx/sw/freetube/profiles.py +++ /dev/null @@ -1,45 +0,0 @@ -"""FreeTube profiles.""" - -from rwx import Object - -from .channels import Channel - - -class Profile(Object): - """FreeTube profile.""" - - def __init__(self, uid: str, name: str) -> None: - """Set uid & name. - - :param uid: unique identifier - :type uid: str - :param name: label - :type name: str - """ - self.id = uid - self.name = name - self.channels: list[Channel] = [] - - def add(self, channel: Channel) -> None: - """Add channel. - - :param channel: channel to add - :type channel: Channel - """ - self.channels.append(channel) - - def to_db(self) -> str: - """Return identifier, name & channels. - - :rtype: str - """ - channels = ",".join([channel.to_db() for channel in self.channels]) - return f"""\ -{{\ -"_id":"{self.id}"\ -,\ -"name":"{self.name}"\ -,\ -"subscriptions":[{channels}]\ -}}\ -""" diff --git a/rwx/sw/freetube/settings.py b/rwx/sw/freetube/settings.py deleted file mode 100644 index 621454b..0000000 --- a/rwx/sw/freetube/settings.py +++ /dev/null @@ -1,33 +0,0 @@ -"""FreeTube settings.""" - -from rwx import Object - -from .db import to_db - - -class Setting(Object): - """FreeTube setting.""" - - def __init__(self, uid: str, value: object) -> None: - """Set uid & value. - - :param uid: unique identifier - :type uid: str - :param value: value - :type value: object - """ - self.uid = uid - self.value = value - - def to_db(self) -> str: - """Return uid & value as db string. - - :rtype: str - """ - return f"""\ -{{\ -"_id":"{self.uid}"\ -,\ -"value":{to_db(self.value)}\ -}}\ -""" diff --git a/rwx/sw/freetube/videos.py b/rwx/sw/freetube/videos.py deleted file mode 100644 index 6003c75..0000000 --- a/rwx/sw/freetube/videos.py +++ /dev/null @@ -1,33 +0,0 @@ -"""FreeTube videos.""" - -from rwx import Object - - -class Video(Object): - """FreeTube video.""" - - def __init__(self, uid: str, name: str) -> None: - """Set id & name. - - :param uid: identifier - :type uid: str - :param name: label - :type name: str - """ - self.uid = uid - self.name = name - - def to_db(self) -> str: - """Return identifier, zero length & title. - - :rtype: str - """ - return f"""\ -{{\ -"videoId":"{self.uid}"\ -,\ -"lengthSeconds":0\ -,\ -"title":"{self.name}"\ -}}\ -""" diff --git a/rwx/sw/ytdlp/__init__.py b/rwx/sw/ytdlp/__init__.py deleted file mode 100644 index 9045781..0000000 --- a/rwx/sw/ytdlp/__init__.py +++ /dev/null @@ -1,379 +0,0 @@ -"""YouTube DownLoad.""" - -from datetime import datetime -from pathlib import Path -from typing import Any - -from yt_dlp import YoutubeDL - -from rwx import Object -from rwx.fs import read_file_yaml -from rwx.log import stream as log - -SUBTITLES_EXTENSIONS = ["vtt"] -TIMESTAMP = "%Y%m%d%H%M%S" -URL = "https://youtube.com" - - -# ╭─────────╮ -# │ classes │ -# ╰─────────╯ - - -class Cache(Object): - """YouTube local cache.""" - - def __init__(self, root_file: Path) -> None: - self.root_file = root_file.resolve() - self.root_directory = self.root_file.parent - self.load() - - def load(self) -> None: - d = read_file_yaml(self.root_file) - log.info(d) - - -class Channel(Object): - """YouTube channel.""" - - def __init__(self, channel_id: str) -> None: - """Set objects tree. - - :param channel_id: channel identifier - :type channel_id: str - """ - d = extract_videos(channel_id) - # channel - self.uid = d["channel_id"] - self.title = d["channel"] - self.followers = int(d["channel_follower_count"]) - self.description = d["description"] - self.tags = d["tags"] - self.thumbnails = [thumbnail["url"] for thumbnail in d["thumbnails"]] - self.thumbnail = self.thumbnails[-1] - self.uploader_id = d["uploader_id"] - self.uploader = d["uploader"] - # videos - self.videos = [ - Video(entry) - for entry in reversed(d["entries"]) - if entry["availability"] != "subscriber_only" - ] - # playlists - d = extract_playlists(channel_id) - self.playlists = [Playlist(entry) for entry in reversed(d["entries"])] - - -# TODO Format -class Format(Object): - """YouTube format.""" - - @staticmethod - def get(d: dict, key: str) -> str | None: - value = d.get(key) - match value: - case "none": - return None - case _: - return value - - def __init__(self, d: dict) -> None: - """Set format info. - - :param d: format info - :type d: dict - """ - self.uid = d["format_id"] - self.extension = d["ext"] - self.filesize = d.get("filesize") - self.filesize_approx = d.get("filesize_approx") - self.language = d.get("language") - self.quality = d.get("quality") - # video - self.video_codec = Format.get(d, "vcodec") - if self.video_codec: - self.video_bit_rate = d["vbr"] - self.video_dynamic_range = d["dynamic_range"] - self.video_extension = d["video_ext"] - self.video_fps = d["fps"] - self.video_height = int(d["height"]) - self.video_width = int(d["width"]) - else: - del self.video_codec - # audio - self.audio_codec = Format.get(d, "acodec") - if self.audio_codec: - self.audio_bit_rate = d["abr"] - self.audio_channels = int(d["audio_channels"]) - self.audio_extension = d["audio_ext"] - self.audio_sampling_rate = d["asr"] - else: - del self.audio_codec - - def audio(self) -> str: - return f"{self.uid} \ -→ {self.audio_sampling_rate} × {self.audio_channels} \ -@ {self.audio_bit_rate} × {self.audio_codec}" - - def video(self) -> str: - return f"{self.uid} \ -→ {self.video_width} × {self.video_height} × {self.video_fps} \ -@ {self.video_bit_rate} × {self.video_codec}" - - -# TODO Playlist/extra -class Playlist(Object): - """YouTube playlist.""" - - def __init__(self, d: dict) -> None: - """Set playlist info. - - :param d: playlist info - :type d: dict - """ - self.uid = d["id"] - self.title = d["title"] - - -class Subtitles(Object): - """YouTube subtitles.""" - - def __init__(self, uid: str, d: dict) -> None: - """Set subtitles info. - - :param d: subtitles info - :type d: dict - """ - self.uid = uid - self.extension = d["ext"] - self.name = d["name"] - self.url = d["url"] - - -# TODO Thumbnail - - -class Video(Object): - """YouTube video.""" - - def __init__(self, d: dict) -> None: - """Set video info. - - :param d: video info - :type d: dict - """ - self.description_cut = d["description"] - self.uid = d["id"] - self.title = d["title"] - self.duration = int(d["duration"]) - self.thumbnail = d["thumbnails"][-1]["url"] - - def load_extra(self): - self.at = datetime.now().strftime(TIMESTAMP) - d = extract_video(self.uid) - self.audio_formats = [] - self.video_formats = [] - for entry in d["formats"]: - f = Format(entry) - if hasattr(f, "video_codec"): - self.video_format = f - self.video_formats.append(f) - elif hasattr(f, "audio_codec"): - self.audio_format = f - self.audio_formats.append(f) - thumbnail = d["thumbnails"][-1]["url"] - # TODO compare existing thumbnail - self.description = d["description"] - self.channel_id = d["channel_id"] - self.duration = int(d["duration"]) - self.views = int(d["view_count"]) - self.categories = d["categories"] - self.tags = d["tags"] - self.automatic_captions = [] - for uid, entries in d["automatic_captions"].items(): - for entry in entries: - subtitles = Subtitles(uid, entry) - if subtitles.extension in SUBTITLES_EXTENSIONS: - self.automatic_captions.append(subtitles) - self.subtitles = [] - for uid, entries in d["subtitles"].items(): - for entry in entries: - subtitles = Subtitles(uid, entry) - if subtitles.extension in SUBTITLES_EXTENSIONS: - self.subtitles.append(subtitles) - self.chapters = d["chapters"] - self.likes = d["like_count"] - self.timestamp = datetime.fromtimestamp(d["timestamp"]).strftime( - TIMESTAMP - ) - self.fulltitle = d["fulltitle"] - - -# ╭──────────╮ -# │ download │ -# ╰──────────╯ - - -def download_video(video_id: str | None) -> None: - if video_id: - ytdl( - { - "format": "bestvideo[ext=webm]+bestaudio[ext=webm]", - "outtmpl": "%(id)s.%(ext)s", - "postprocessors": [ - { - "key": "SponsorBlock", - "categories": ["sponsor"], - }, - { - "key": "ModifyChapters", - "remove_sponsor_segments": ["sponsor"], - }, - ], - "writesubtitles": True, - "writethumbnail": True, - }, - ).download([url_video(video_id)]) - - -# ╭─────────╮ -# │ extract │ -# ╰─────────╯ - - -def extract(url: str) -> dict[str, Any]: - """Return extracted dict. - - :rtype: dict - """ - d = ytdl( - { - "extract_flat": True, - "skip_download": True, - }, - ).extract_info(url, download=False) - log.debug(d) - return d - - -def extract_playlist(playlist_id: str) -> dict: - """Return extracted playlist dict. - - :param playlist_id: playlist identifier - :type playlist_id: str - :rtype: dict - """ - return extract(url_playlist(playlist_id)) - - -def extract_playlists(channel_id: str) -> dict: - """Return extracted playlists dict. - - :param channel_id: channel identifier - :type channel_id: str - :rtype: dict - """ - return extract(url_playlists(channel_id)) - - -def extract_video(video_id: str) -> dict: - """Return extracted video dict. - - :param video_id: video identifier - :type video_id: str - :rtype: dict - """ - return extract(url_video(video_id)) - - -def extract_videos(channel_id: str) -> dict: - """Return extracted videos dict. - - :param channel_id: channel identifier - :type channel_id: str - :rtype: dict - """ - return extract(url_videos(channel_id)) - - -# ╭──────╮ -# │ next │ -# ╰──────╯ - - -def next_download(videos: list[str]) -> str | None: - for index, video_id in enumerate(videos): - if not Path(f"{video_id}.mp4").exists(): - log.info(f"{index} ∕ {len(videos)}") - return video_id - return None - - -# ╭─────╮ -# │ url │ -# ╰─────╯ - - -def url_channel(channel_id: str) -> str: - """Return channel URL. - - :param channel_id: channel identifier - :type channel_id: str - :rtype: str - """ - return f"{URL}/channel/{channel_id}" - - -def url_playlist(playlist_id: str) -> str: - """Return playlist URL. - - :param playlist_id: playlist identifier - :type playlist_id: str - :rtype: str - """ - return f"{URL}/playlist?list={playlist_id}" - - -def url_playlists(channel_id: str) -> str: - """Return playlists URL. - - :param channel_id: channel identifier - :type channel_id: str - :rtype: str - """ - return f"{url_channel(channel_id)}/playlists" - - -def url_video(video_id: str) -> str: - """Return video URL. - - :param video_id: video identifier - :type video_id: str - :rtype: str - """ - return f"{URL}/watch?v={video_id}" - - -def url_videos(channel_id: str) -> str: - """Return videos URL. - - :param channel_id: channel identifier - :type channel_id: str - :rtype: str - """ - return f"{url_channel(channel_id)}/videos" - - -# ╭──────╮ -# │ ytdl │ -# ╰──────╯ - - -def ytdl(opt: dict) -> YoutubeDL: - options = { - **opt, - "ignoreerrors": False, - "quiet": False, - } - log.info(options) - return YoutubeDL(options) diff --git a/rwx/sw/ytdlp/video.py b/rwx/sw/ytdlp/video.py deleted file mode 100644 index e69de29..0000000 diff --git a/rwx/txt/__init__.py b/rwx/txt/__init__.py deleted file mode 100644 index be2f273..0000000 --- a/rwx/txt/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -"""Handle text.""" - -CHARSET = "UTF-8" diff --git a/rwx/web/__init__.py b/rwx/web/__init__.py deleted file mode 100644 index e746872..0000000 --- a/rwx/web/__init__.py +++ /dev/null @@ -1,32 +0,0 @@ -import requests - -from rwx import Object, txt -from rwx.txt import CHARSET - - -def fetch(url: str) -> str: - response = requests.get(url) - response.raise_for_status() - return response.text - - -class Page(Object): - def __init__(self): - self.charset = CHARSET - self.description = "" - self.title = "" - - def render(self) -> str: - return f"""\ - - - - - - -{self.title} - - - - -""" diff --git a/.shellcheckrc b/sh/.shellcheckrc similarity index 100% rename from .shellcheckrc rename to sh/.shellcheckrc diff --git a/sh/alias/apt.sh b/sh/alias/apt.sh index 75723c8..0f3294e 100644 --- a/sh/alias/apt.sh +++ b/sh/alias/apt.sh @@ -1,7 +1,5 @@ -# functions handling apt - # show package information -#= acl +acl() { a__apt_cache_list "${@}"; } a__apt_cache_list() { apt-cache \ show \ @@ -9,7 +7,7 @@ a__apt_cache_list() { } # package versions policy -#= acp +acp() { a__apt_cache_policy "${@}"; } a__apt_cache_policy() { apt-cache \ policy \ @@ -17,21 +15,23 @@ a__apt_cache_policy() { } # search package -#= acs +acs() { a__apt_cache_search "${@}"; } a__apt_cache_search() { apt-cache \ search \ "${@}" } -#= agap +# +agap() { a__apt_get_auto_purge "${@}"; } a__apt_get_auto_purge() { apt-get \ autopurge \ "${@}" } -#= agar +# +agar() { a__apt_get_auto_remove "${@}"; } a__apt_get_auto_remove() { apt-get \ autoremove \ @@ -39,7 +39,7 @@ a__apt_get_auto_remove() { } # clean packages cache -#= agc +agc() { a__apt_get_clean "${@}"; } a__apt_get_clean() { apt-get \ clean \ @@ -47,7 +47,7 @@ a__apt_get_clean() { } # upgrade allowing package installation or removal -#= agfu +agfu() { a__apt_get_full_upgrade "${@}"; } a__apt_get_full_upgrade() { apt-get \ full-upgrade \ @@ -55,21 +55,23 @@ a__apt_get_full_upgrade() { } # install packages -#= agi +agi() { a__apt_get_install "${@}"; } a__apt_get_install() { apt-get \ install \ "${@}" } -#= agp +# +agp() { a__apt_get_purge "${@}"; } a__apt_get_purge() { apt-get \ purge \ "${@}" } -#= agr +# +agr() { a__apt_get_remove "${@}"; } a__apt_get_remove() { apt-get \ remove \ @@ -77,7 +79,7 @@ a__apt_get_remove() { } # update packages catalog -#= agud +agud() { a__apt_get_up_date "${@}"; } a__apt_get_up_date() { apt-get \ update \ @@ -85,7 +87,7 @@ a__apt_get_up_date() { } # upgrade forbidding package installation or removal -#= agug +agug() { a__apt_get_up_grade "${@}"; } a__apt_get_up_grade() { apt-get \ upgrade \ diff --git a/sh/alias/batcat.sh b/sh/alias/batcat.sh index c573adb..99d8373 100644 --- a/sh/alias/batcat.sh +++ b/sh/alias/batcat.sh @@ -1,4 +1,4 @@ -#= b +b() { a__bat "${@}"; } a__bat() { batcat \ "${@}" diff --git a/sh/alias/btrfs.sh b/sh/alias/btrfs.sh index b70f8aa..0e4ba62 100644 --- a/sh/alias/btrfs.sh +++ b/sh/alias/btrfs.sh @@ -1,6 +1,4 @@ -# functions to handle btrfs volumes - -#= bfdf +bfdf() { a__btrfs_filesystem_d_f "${@}"; } a__btrfs_filesystem_d_f() { btrfs \ filesystem \ @@ -8,7 +6,7 @@ a__btrfs_filesystem_d_f() { "${@}" } -#= bfdu +bfdu() { a__btrfs_filesystem_d_u "${@}"; } a__btrfs_filesystem_d_u() { btrfs \ filesystem \ @@ -17,7 +15,7 @@ a__btrfs_filesystem_d_u() { "${@}" } -#= bfu +bfu() { a__btrfs_filesystem_usage "${@}"; } a__btrfs_filesystem_usage() { btrfs \ filesystem \ @@ -25,7 +23,7 @@ a__btrfs_filesystem_usage() { "${@}" } -#= bpg +bpg() { a__btrfs_property_get "${@}"; } a__btrfs_property_get() { btrfs \ property \ @@ -33,7 +31,7 @@ a__btrfs_property_get() { "${@}" } -#= bsc +bsc() { a__btrfs_subvolume_create "${@}"; } a__btrfs_subvolume_create() { btrfs \ subvolume \ @@ -41,7 +39,7 @@ a__btrfs_subvolume_create() { "${@}" } -#= bsd +bsd() { a__btrfs_subvolume_delete "${@}"; } a__btrfs_subvolume_delete() { btrfs \ subvolume \ @@ -49,7 +47,7 @@ a__btrfs_subvolume_delete() { "${@}" } -#= bsl +bsl() { a__btrfs_subvolume_list "${@}"; } a__btrfs_subvolume_list() { if [ -n "${1}" ]; then btrfs subvolume list "${1}" | @@ -58,7 +56,7 @@ a__btrfs_subvolume_list() { fi } -#= bss +bss() { a__btrfs_subvolume_snapshot "${@}"; } a__btrfs_subvolume_snapshot() { btrfs \ subvolume \ @@ -66,7 +64,7 @@ a__btrfs_subvolume_snapshot() { "${@}" } -#= bssr +bssr() { a__btrfs_subvolume_snapshot_r "${@}"; } a__btrfs_subvolume_snapshot_r() { btrfs \ subvolume \ diff --git a/sh/alias/byobu.sh b/sh/alias/byobu.sh new file mode 100644 index 0000000..0f5336e --- /dev/null +++ b/sh/alias/byobu.sh @@ -0,0 +1,27 @@ +bb() { a__byo_bu "${@}"; } +a__byo_bu() { + byobu \ + "${@}" +} + +bba() { a__byo_bu_attach "${@}"; } +a__byo_bu_attach() { + byobu \ + attach-session \ + "${@}" +} + +bbl() { a__byo_bu_ls "${@}"; } +a__byo_bu_ls() { + byobu \ + ls \ + "${@}" +} + +bbnd() { a__byo_bu_new_detach "${@}"; } +a__byo_bu_new_detach() { + byobu \ + new-session \ + -d \ + "${@}" +} diff --git a/sh/alias/chmod.sh b/sh/alias/chmod.sh index 611f768..57ec74e 100644 --- a/sh/alias/chmod.sh +++ b/sh/alias/chmod.sh @@ -1,5 +1,5 @@ # change mode to directory -#= cmd +cmd() { a__change_mode_directory "${@}"; } a__change_mode_directory() { chmod \ "755" \ @@ -7,7 +7,7 @@ a__change_mode_directory() { } # change mode to file -#= cmf +cmf() { a__change_mode_file "${@}"; } a__change_mode_file() { chmod \ "644" \ diff --git a/sh/alias/chown.sh b/sh/alias/chown.sh index df230fc..f4fa865 100644 --- a/sh/alias/chown.sh +++ b/sh/alias/chown.sh @@ -1,5 +1,5 @@ # change owner to root -#= cor +cor() { a__change_owner_root "${@}"; } a__change_owner_root() { chown \ "0:0" \ @@ -7,7 +7,7 @@ a__change_owner_root() { } # change owner to user -#= cou +cou() { a__change_owner_user "${@}"; } a__change_owner_user() { chown \ "1000:1000" \ diff --git a/sh/alias/clear.sh b/sh/alias/clear.sh index 3424e6e..ae32b30 100644 --- a/sh/alias/clear.sh +++ b/sh/alias/clear.sh @@ -1,5 +1,5 @@ # clear terminal -#= c +c() { a__clear "${@}"; } a__clear() { clear \ "${@}" diff --git a/sh/alias/cp.sh b/sh/alias/cp.sh index caee098..c9e7d6b 100644 --- a/sh/alias/cp.sh +++ b/sh/alias/cp.sh @@ -1,5 +1,5 @@ # copy interactively -#= cpi +cpi() { a__co_py_interactive "${@}"; } a__co_py_interactive() { cp \ --interactive \ diff --git a/sh/alias/emacs.sh b/sh/alias/emacs.sh index ff6cc65..8e26878 100644 --- a/sh/alias/emacs.sh +++ b/sh/alias/emacs.sh @@ -1,4 +1,4 @@ -#= em +em() { a__e_macs "${@}"; } a__e_macs() { emacs \ "${@}" diff --git a/sh/alias/evince.sh b/sh/alias/evince.sh index 80fc647..25ac069 100644 --- a/sh/alias/evince.sh +++ b/sh/alias/evince.sh @@ -1,4 +1,4 @@ -#= ev +ev() { a__e_vince "${@}"; } a__e_vince() { evince \ "${@}" diff --git a/sh/alias/git.sh b/sh/alias/git.sh index 9875f68..6400092 100644 --- a/sh/alias/git.sh +++ b/sh/alias/git.sh @@ -1,14 +1,14 @@ -# large set of aliases for git commands - -RWX_GIT_LOG_FORMAT="\ +SH_GIT_LOG_FORMAT="\ %C(auto)%h%d S %C(red)%GS -A %C(green)%ai %an %ae -C %C(blue)%ci %cn %ce +A %C(green)%an %ae + %C(green)%ai +C %C(blue)%cn %ce + %C(blue)%ci %B" # add to index -#= ga +ga() { a__git_add "${@}"; } a__git_add() { git \ add \ @@ -16,7 +16,7 @@ a__git_add() { } # add all to index -#= gaa +gaa() { a__git_add_all "${@}"; } a__git_add_all() { git \ add \ @@ -25,7 +25,7 @@ a__git_add_all() { } # add parts of all to index -#= gaap +gaap() { a__git_add_all_patch "${@}"; } a__git_add_all_patch() { git \ add \ @@ -35,7 +35,7 @@ a__git_add_all_patch() { } # add parts to index -#= gap +gap() { a__git_add_patch "${@}"; } a__git_add_patch() { git \ add \ @@ -44,7 +44,7 @@ a__git_add_patch() { } # create a branch -#= gb +gb() { a__git_branch "${@}"; } a__git_branch() { git \ branch \ @@ -52,7 +52,7 @@ a__git_branch() { } # delete a branch -#= gbd +gbd() { a__git_branch_delete "${@}"; } a__git_branch_delete() { git \ branch \ @@ -61,7 +61,7 @@ a__git_branch_delete() { } # force a branch deletion -#= gbdf +gbdf() { a__git_branch_delete_force "${@}"; } a__git_branch_delete_force() { git \ branch \ @@ -71,7 +71,7 @@ a__git_branch_delete_force() { } # list branches -#= gbl +gbl() { a__git_branch_list "${@}"; } a__git_branch_list() { git \ branch \ @@ -83,7 +83,7 @@ a__git_branch_list() { } # set the link to a remote branch from a local branch -#= gbsu +gbsu() { a__git_branch_set_upstream "${@}"; } a__git_branch_set_upstream() { git \ branch \ @@ -92,7 +92,7 @@ a__git_branch_set_upstream() { } # switch to a branch or checkout file(s) from a commit -#= gc +gc() { a__git_checkout "${@}"; } a__git_checkout() { git \ checkout \ @@ -100,7 +100,7 @@ a__git_checkout() { } # checkout an orphan branch -#= gco +gco() { a__git_checkout_orphan "${@}"; } a__git_checkout_orphan() { git \ checkout \ @@ -109,7 +109,7 @@ a__git_checkout_orphan() { } # pick a commit -#= gcp +gcp() { a__git_cherry_pick "${@}"; } a__git_cherry_pick() { git \ cherry-pick \ @@ -117,7 +117,7 @@ a__git_cherry_pick() { } # abort the commit pick -#= gcpa +gcpa() { a__git_cherry_pick_abort "${@}"; } a__git_cherry_pick_abort() { git \ cherry-pick \ @@ -126,7 +126,7 @@ a__git_cherry_pick_abort() { } # continue the commit pick -#= gcpc +gcpc() { a__git_cherry_pick_continue "${@}"; } a__git_cherry_pick_continue() { git \ cherry-pick \ @@ -135,7 +135,7 @@ a__git_cherry_pick_continue() { } # clean untracked files -#= gcf +gcf() { a__git_clean_force "${@}"; } a__git_clean_force() { git \ clean \ @@ -145,7 +145,7 @@ a__git_clean_force() { } # redo the last commit with a different message -#= gcam +gcam() { a__git_commit_amend_message "${@}"; } a__git_commit_amend_message() { git \ commit \ @@ -155,7 +155,7 @@ a__git_commit_amend_message() { } # make a root commit -#= gcem +gcem() { a__git_commit_empty_message "${@}"; } a__git_commit_empty_message() { git \ commit \ @@ -166,7 +166,7 @@ a__git_commit_empty_message() { } # commit the index -#= gcm +gcm() { a__git_commit_message "${@}"; } a__git_commit_message() { git \ commit \ @@ -175,7 +175,7 @@ a__git_commit_message() { } # configure the user email -#= gcue +gcue() { a__git_config_user_email "${@}"; } a__git_config_user_email() { git \ config \ @@ -184,7 +184,7 @@ a__git_config_user_email() { } # configure the user name -#= gcun +gcun() { a__git_config_user_name "${@}"; } a__git_config_user_name() { git \ config \ @@ -193,7 +193,7 @@ a__git_config_user_name() { } # differences from last or between commits -#= gd +gd() { a__git_diff "${@}"; } a__git_diff() { git \ diff \ @@ -201,7 +201,7 @@ a__git_diff() { } # display what is indexed in cache -#= gdc +gdc() { a__git_diff_cached "${@}"; } a__git_diff_cached() { git \ diff \ @@ -210,7 +210,7 @@ a__git_diff_cached() { } # indexed character-level differences -#= gdcw +gdcw() { a__git_diff_cached_word "${@}"; } a__git_diff_cached_word() { git \ diff \ @@ -220,7 +220,7 @@ a__git_diff_cached_word() { } # differences via external tool -#= gdt +gdt() { a__git_diff_tool "${@}"; } a__git_diff_tool() { git \ difftool \ @@ -229,7 +229,7 @@ a__git_diff_tool() { } # character-level differences -#= gdw +gdw() { a__git_diff_word "${@}"; } a__git_diff_word() { git \ diff \ @@ -238,18 +238,17 @@ a__git_diff_word() { } # fetch from the remote repository -#= gf +gf() { a__git_fetch "${@}"; } a__git_fetch() { - rwx_gpg_agent_update && - git \ - fetch \ - --tags \ - --verbose \ - "${@}" + git \ + fetch \ + --tags \ + --verbose \ + "${@}" } # fetch from remote repository and prune local orphan branches -#= gfp +gfp() { a__git_fetch_prune "${@}"; } a__git_fetch_prune() { a__git_fetch \ --prune \ @@ -257,7 +256,7 @@ a__git_fetch_prune() { } # garbage collect all orphan commits -#= ggc +ggc() { a__git_garbage_collect "${@}"; } a__git_garbage_collect() { git \ reflog \ @@ -271,7 +270,7 @@ a__git_garbage_collect() { } # initialize a new repository -#= gi +gi() { a__git_init "${@}"; } a__git_init() { git \ init \ @@ -279,7 +278,7 @@ a__git_init() { } # initialize a new bare repository -#= gib +gib() { a__git_init_bare "${@}"; } a__git_init_bare() { git \ init \ @@ -288,35 +287,27 @@ a__git_init_bare() { } # log history -#= gl +gl() { a__git_log "${@}"; } a__git_log() { git \ log \ --abbrev=8 \ --abbrev-commit \ - --format="${RWX_GIT_LOG_FORMAT}" \ + --format="${SH_GIT_LOG_FORMAT}" \ --graph \ "${@}" } # log all history -#= gla +gla() { a__git_log_all "${@}"; } a__git_log_all() { a__git_log \ --all \ "${@}" } -# log all history as oneline -#= glao -a__git_log_all_oneline() { - a__git_log_all \ - --oneline \ - "${@}" -} - # log all history with patches -#= glap +glap() { a__git_log_all_patch "${@}"; } a__git_log_all_patch() { a__git_log \ --all \ @@ -324,16 +315,8 @@ a__git_log_all_patch() { "${@}" } -# log history as oneline -#= glo -a__git_log_oneline() { - a__git_log \ - --oneline \ - "${@}" -} - # log history with patches -#= glp +glp() { a__git_log_patch "${@}"; } a__git_log_patch() { a__git_log \ --patch \ @@ -341,7 +324,7 @@ a__git_log_patch() { } # fast-forward merge to remote branch -#= gm +gm() { a__git_merge "${@}"; } a__git_merge() { git \ merge \ @@ -350,7 +333,7 @@ a__git_merge() { } # abort the current merge commit -#= gma +gma() { a__git_merge_abort "${@}"; } a__git_merge_abort() { git \ merge \ @@ -359,7 +342,7 @@ a__git_merge_abort() { } # do a merge commit -#= gmc +gmc() { a__git_merge_commit "${@}"; } a__git_merge_commit() { git \ merge \ @@ -369,7 +352,7 @@ a__git_merge_commit() { } # squash a branch and index its modifications -#= gms +gms() { a__git_merge_squash "${@}"; } a__git_merge_squash() { git \ merge \ @@ -378,7 +361,7 @@ a__git_merge_squash() { } # merge via external tool -#= gmt +gmt() { a__git_merge_tool "${@}"; } a__git_merge_tool() { git \ mergetool \ @@ -386,18 +369,17 @@ a__git_merge_tool() { } # push to the remote repository -#= gp +gp() { a__git_push "${@}"; } a__git_push() { - rwx_gpg_agent_update && - git \ - push \ - --tags \ - --verbose \ - "${@}" + git \ + push \ + --tags \ + --verbose \ + "${@}" } # delete from the remote repository -#= gpd +gpd() { a__git_push_delete "${@}"; } a__git_push_delete() { git \ push \ @@ -406,7 +388,7 @@ a__git_push_delete() { } # force the push to the remote repository -#= gpf +gpf() { a__git_push_force "${@}"; } a__git_push_force() { a__git_push \ --force \ @@ -414,7 +396,7 @@ a__git_push_force() { } # rebase current branch onto another -#= grb +grb() { a__git_re_base "${@}"; } a__git_re_base() { git \ rebase \ @@ -422,7 +404,7 @@ a__git_re_base() { } # abort current rebase -#= grba +grba() { a__git_re_base_abort "${@}"; } a__git_re_base_abort() { git \ rebase \ @@ -431,7 +413,7 @@ a__git_re_base_abort() { } # continue current rebase -#= grbc +grbc() { a__git_re_base_continue "${@}"; } a__git_re_base_continue() { git \ rebase \ @@ -440,7 +422,7 @@ a__git_re_base_continue() { } # force rebase without fast-forward -#= grbf +grbf() { a__git_re_base_force "${@}"; } a__git_re_base_force() { git \ rebase \ @@ -449,7 +431,7 @@ a__git_re_base_force() { } # rebase interactively -#= grbi +grbi() { a__git_re_base_interactive "${@}"; } a__git_re_base_interactive() { git \ rebase \ @@ -458,7 +440,7 @@ a__git_re_base_interactive() { } # add a new remote repository -#= grma +grma() { a__git_re_mote_add "${@}"; } a__git_re_mote_add() { git \ remote \ @@ -467,7 +449,7 @@ a__git_re_mote_add() { } # list remote repositories -#= grml +grml() { a__git_re_mote_list "${@}"; } a__git_re_mote_list() { git \ remote \ @@ -476,7 +458,7 @@ a__git_re_mote_list() { } # set the location of a remote repository -#= grmsu +grmsu() { a__git_re_mote_set_upstream "${@}"; } a__git_re_mote_set_upstream() { git \ remote \ @@ -485,7 +467,7 @@ a__git_re_mote_set_upstream() { } # show connection to a remote repository -#= grms +grms() { a__git_re_mote_show "${@}"; } a__git_re_mote_show() { git \ remote \ @@ -494,7 +476,7 @@ a__git_re_mote_show() { } # remove and add removal to index -#= grm +grm() { a__git_re_move "${@}"; } a__git_re_move() { git \ rm \ @@ -502,7 +484,7 @@ a__git_re_move() { } # remove file(s) from index or move current branch pointer -#= grs +grs() { a__git_re_set "${@}"; } a__git_re_set() { git \ reset \ @@ -510,7 +492,7 @@ a__git_re_set() { } # wipe modifications or reset current branch to another commit -#= grsh +grsh() { a__git_re_set_hard "${@}"; } a__git_re_set_hard() { git \ reset \ @@ -518,8 +500,16 @@ a__git_re_set_hard() { "${@}" } +# show a commit +gsc() { a__git_show_commit "${@}"; } +a__git_show_commit() { + git \ + show \ + "${@}" +} + # current state of repository -#= gs +gs() { a__git_status "${@}"; } a__git_status() { git \ status \ @@ -527,16 +517,8 @@ a__git_status() { "${@}" } -# show a commit -#= gsc -a__git_show_commit() { - git \ - show \ - "${@}" -} - # tag a commit -#= gt +gt() { a__git_tag "${@}"; } a__git_tag() { git \ tag \ @@ -544,21 +526,10 @@ a__git_tag() { } # delete a tag -#= gtd +gtd() { a__git_tag_delete "${@}"; } a__git_tag_delete() { git \ tag \ --delete \ "${@}" } - -# update head ref -#= gurh -a__git_update_ref_head() { - if [ -n "${2}" ]; then - git \ - update-ref \ - "refs/heads/${1}" \ - "${2}" - fi -} diff --git a/sh/alias/gpg.sh b/sh/alias/gpg.sh new file mode 100644 index 0000000..496b05e --- /dev/null +++ b/sh/alias/gpg.sh @@ -0,0 +1,14 @@ +# turn gpg agent off +gak() { a__gpg_agent_kill "${@}"; } +a__gpg_agent_kill() { + gpgconf \ + --kill "gpg-agent" +} + +# bind gpg agent to current tty +gau() { a__gpg_agent_update "${@}"; } +a__gpg_agent_update() { + gpg-connect-agent \ + updatestartuptty \ + /bye +} diff --git a/sh/alias/grep.sh b/sh/alias/grep.sh index 142b3d0..5b00ed7 100644 --- a/sh/alias/grep.sh +++ b/sh/alias/grep.sh @@ -1,5 +1,5 @@ # grep from current directory with regex -#= g +g() { a__grep "${@}"; } a__grep() { grep \ --directories "recurse" \ diff --git a/sh/alias/kill.sh b/sh/alias/kill.sh index 6abc003..718a307 100644 --- a/sh/alias/kill.sh +++ b/sh/alias/kill.sh @@ -1,12 +1,12 @@ # kill a process by id -#= k +k() { a__kill "${@}"; } a__kill() { kill \ "${@}" } # force kill a process by id -#= kf +kf() { a__kill_force "${@}"; } a__kill_force() { kill \ -9 \ diff --git a/sh/alias/killall.sh b/sh/alias/killall.sh index 259cb40..6658065 100644 --- a/sh/alias/killall.sh +++ b/sh/alias/killall.sh @@ -1,12 +1,12 @@ # kill all instances of a process by name -#= ka +ka() { a__kill_all "${@}"; } a__kill_all() { killall \ "${@}" } # force kill all instances of a process by name -#= kaf +kaf() { a__kill_all_force "${@}"; } a__kill_all_force() { killall \ -9 \ diff --git a/sh/alias/ls.sh b/sh/alias/ls.sh index 13f3663..ad5a809 100644 --- a/sh/alias/ls.sh +++ b/sh/alias/ls.sh @@ -1,13 +1,9 @@ -# list files - -# list colors -# * lighter blue for directories export LS_COLORS="\ di=0;94\ " # list current directory’s entries -#= l +l() { a__ls "${@}"; } a__ls() { ls \ --all \ @@ -19,7 +15,7 @@ a__ls() { } # list timestamps -#= lt +lt() { a__ls_time "${@}"; } a__ls_time() { a__ls \ --time-style "+%Y%m%d-%H%M%S%-:::z" \ @@ -27,7 +23,7 @@ a__ls_time() { } # list timestamps recent last -#= ltr +ltr() { a__ls_time_reverse "${@}"; } a__ls_time_reverse() { a__ls_time \ --reverse \ diff --git a/sh/alias/lsblk.sh b/sh/alias/lsblk.sh index 35e0c73..43dffc6 100644 --- a/sh/alias/lsblk.sh +++ b/sh/alias/lsblk.sh @@ -1,7 +1,5 @@ -# handle block devices - # list block devices -#= lb +lb() { a__list_block "${@}"; } a__list_block() { a__list_block_output \ "SIZE" \ @@ -13,7 +11,7 @@ a__list_block() { } # base arguments -#= lbne +lbne() { a__list_block_no_empty "${@}"; } a__list_block_no_empty() { lsblk \ --noempty \ @@ -21,7 +19,7 @@ a__list_block_no_empty() { } # output arguments -#= lbo +lbo() { a__list_block_output "${@}"; } a__list_block_output() { local argument local arguments="NAME" diff --git a/sh/alias/mkdir.sh b/sh/alias/mkdir.sh index fcedee1..bebc665 100644 --- a/sh/alias/mkdir.sh +++ b/sh/alias/mkdir.sh @@ -1,12 +1,12 @@ # make a directory -#= md +md() { a__make_directory "${@}"; } a__make_directory() { mkdir \ "${@}" } # make a directory after making its parents -#= mdp +mdp() { a__make_directory_parents "${@}"; } a__make_directory_parents() { mkdir \ --parents \ diff --git a/sh/alias/mount.sh b/sh/alias/mount.sh index 8741ab9..535910e 100644 --- a/sh/alias/mount.sh +++ b/sh/alias/mount.sh @@ -1,4 +1,4 @@ -#= m +m() { a__mount "${@}"; } a__mount() { mount \ "${@}" diff --git a/sh/alias/mv.sh b/sh/alias/mv.sh index 526cb78..0630042 100644 --- a/sh/alias/mv.sh +++ b/sh/alias/mv.sh @@ -1,5 +1,5 @@ # move interactively -#= mvi +mvi() { a__mo_ve_interactive "${@}"; } a__mo_ve_interactive() { mv \ --interactive \ diff --git a/sh/alias/nano.sh b/sh/alias/nano.sh index 586465f..7570cda 100644 --- a/sh/alias/nano.sh +++ b/sh/alias/nano.sh @@ -1,4 +1,4 @@ -#= nn +nn() { a__na_no "${@}"; } a__na_no() { nano \ "${@}" diff --git a/sh/alias/newsboat.sh b/sh/alias/newsboat.sh index 0c89178..6c08c90 100644 --- a/sh/alias/newsboat.sh +++ b/sh/alias/newsboat.sh @@ -1,4 +1,4 @@ -#= nb +nb() { a__news_boat "${@}"; } a__news_boat() { newsboat \ "${@}" diff --git a/sh/alias/overlay.sh b/sh/alias/overlay.sh index cfba5dd..6357655 100644 --- a/sh/alias/overlay.sh +++ b/sh/alias/overlay.sh @@ -1,6 +1,4 @@ -# overlay functions to manipulate squashfs manually - -#= obm +obm() { a__overlay_bind_mount "${@}"; } a__overlay_bind_mount() { local directory for directory in "dev" "dev/pts" "proc" "sys"; do @@ -11,7 +9,7 @@ a__overlay_bind_mount() { done } -#= obu +obu() { a__overlay_bind_unmount "${@}"; } a__overlay_bind_unmount() { local directory for directory in "sys" "proc" "dev/pts" "dev"; do @@ -22,30 +20,30 @@ a__overlay_bind_unmount() { done } -#= ocr +ocr() { a__overlay_command_root "${@}"; } a__overlay_command_root() { chroot \ "overlay/mount" "${@}" } -#= ocu +ocu() { a__overlay_command_user "${@}"; } a__overlay_command_user() { chroot \ --userspec "1000:1000" \ "overlay/mount" "${@}" } -#= omm +omm() { a__overlay_mirror_mount "${@}"; } a__overlay_mirror_mount() { mount --make-rslave --rbind "/deb" "overlay/mount/deb" } -#= omu +omu() { a__overlay_mirror_unmount "${@}"; } a__overlay_mirror_unmount() { umount --recursive "overlay/mount/deb" } -#= orm +orm() { a__overlay_root_mount "${@}"; } a__overlay_root_mount() { local root="${1}" if [ -z "${root}" ]; then @@ -84,7 +82,7 @@ a__overlay_root_mount() { ) } -#= ors +ors() { a__overlay_root_squash "${@}"; } a__overlay_root_squash() { local directory="${1}" local file @@ -104,7 +102,7 @@ a__overlay_root_squash() { fi } -#= oru +oru() { a__overlay_root_unmount "${@}"; } a__overlay_root_unmount() { ( if ! cd "overlay"; then diff --git a/sh/alias/pass.sh b/sh/alias/pass.sh index b71209e..66cad55 100644 --- a/sh/alias/pass.sh +++ b/sh/alias/pass.sh @@ -1,12 +1,12 @@ # display pass entry’s content -#= p +p() { a__pass "${@}"; } a__pass() { pass \ "${@}" } # copy passphrase into clipboard -#= pc +pc() { a__pass_clip "${@}"; } a__pass_clip() { pass \ --clip \ diff --git a/sh/alias/pgrep.sh b/sh/alias/pgrep.sh index 9f04267..72de025 100644 --- a/sh/alias/pgrep.sh +++ b/sh/alias/pgrep.sh @@ -1,5 +1,5 @@ # look for a string in processes names -#= pg +pg() { a__proc_grep "${@}"; } a__proc_grep() { pgrep \ --list-full \ diff --git a/sh/alias/pwgen.sh b/sh/alias/pwgen.sh index bbaa707..3b3dc83 100644 --- a/sh/alias/pwgen.sh +++ b/sh/alias/pwgen.sh @@ -1,5 +1,5 @@ # generate passwords -#= pwg +pwg() { a__pass_word_gen "${@}"; } a__pass_word_gen() { pwgen \ -1 \ @@ -9,7 +9,7 @@ a__pass_word_gen() { } # generate passwords with symbols -#= pwgs +pwgs() { a__pass_word_gen_symbols "${@}"; } a__pass_word_gen_symbols() { a__pass_word_gen \ --symbols \ diff --git a/sh/alias/rm.sh b/sh/alias/rm.sh index 350f8ce..9634c1b 100644 --- a/sh/alias/rm.sh +++ b/sh/alias/rm.sh @@ -1,5 +1,5 @@ # remove interactively -#= rmi +rmi() { a__re_move_interactive "${@}"; } a__re_move_interactive() { rm \ --interactive \ diff --git a/sh/alias/rsync.sh b/sh/alias/rsync.sh index 49ad728..bdbe4ed 100644 --- a/sh/alias/rsync.sh +++ b/sh/alias/rsync.sh @@ -1,7 +1,5 @@ -# shortcuts for rsync - # synchronize -#= rs +rs() { a__r_sync "${@}"; } a__r_sync() { rsync \ --archive \ @@ -13,7 +11,7 @@ a__r_sync() { } # synchronize and delete after -#= rsda +rsda() { a__r_sync_delete_after "${@}"; } a__r_sync_delete_after() { a__r_sync \ --delete-after \ @@ -21,7 +19,7 @@ a__r_sync_delete_after() { } # synchronize and delete before -#= rsdb +rsdb() { a__r_sync_delete_before "${@}"; } a__r_sync_delete_before() { a__r_sync \ --delete-before \ diff --git a/sh/alias/shell.sh b/sh/alias/shell.sh index d6f5801..daadbce 100644 --- a/sh/alias/shell.sh +++ b/sh/alias/shell.sh @@ -17,7 +17,7 @@ x() { "${@}" } -[ "${RWX_SHELL}" = "bash" ] || return +[ "${SH_SHELL}" = "bash" ] || return # shellcheck disable=SC3033 ..() { diff --git a/sh/alias/tar.sh b/sh/alias/tar.sh index bf8e8be..92b8fbf 100644 --- a/sh/alias/tar.sh +++ b/sh/alias/tar.sh @@ -1,6 +1,4 @@ -# functions to handle tar - -#= tc +tc() { a__tar_create "${@}"; } a__tar_create() { a__tar_verbose \ --create \ @@ -9,7 +7,7 @@ a__tar_create() { "${@}" } -#= tl +tl() { a__tar_list "${@}"; } a__tar_list() { a__tar_verbose \ --list \ @@ -17,14 +15,14 @@ a__tar_list() { "${@}" } -#= tv +tv() { a__tar_verbose "${@}"; } a__tar_verbose() { tar \ --verbose \ "${@}" } -#= tx +tx() { a__tar_xtract "${@}"; } a__tar_xtract() { a__tar_verbose \ --extract \ diff --git a/sh/alias/tmux.sh b/sh/alias/tmux.sh index bac6cee..b30dc79 100644 --- a/sh/alias/tmux.sh +++ b/sh/alias/tmux.sh @@ -1,6 +1,4 @@ -# handle tmux - -#= tm +tm() { a__t_mux "${@}"; } a__t_mux() { tmux \ "${@}" diff --git a/sh/alias/tree.sh b/sh/alias/tree.sh index 745d9e3..03be3de 100644 --- a/sh/alias/tree.sh +++ b/sh/alias/tree.sh @@ -1,10 +1,10 @@ -#= t +t() { a__tree "${@}"; } a__tree() { tree \ "${@}" } -#= ta +ta() { a__tree_all "${@}"; } a__tree_all() { tree \ -a \ diff --git a/sh/cryptsetup.sh b/sh/cryptsetup.sh deleted file mode 100644 index fd20a64..0000000 --- a/sh/cryptsetup.sh +++ /dev/null @@ -1,127 +0,0 @@ -_rwx_cmd_cs() { rwx_crypt "${@}"; } - -RWX_CRYPT_ROOT="/data/home/user/crypt" -RWX_CRYPT_VAR="/var/lib/crypt" - -rwx_crypt_device() { - local device size - local index=0 - while [ -z "${device}" ]; do - device="/dev/nbd${index}" - if [ -b "${device}" ]; then - size="$(cat /sys/block/nbd"${index}/size")" - [ "${size}" -eq 0 ] || - device="" - else - device="" - break - fi - index=$((index + 1)) - done - if [ -n "${device}" ]; then - echo "${device}" - else - rwx_log_error 1 "No device available" - fi -} - -rwx_crypt() { - local action="${1}" - local action_close="close" - local action_open="open" - local mapper="/dev/mapper" - local mount_root="/media" - local crypt_arg crypt_file crypt_map crypt_mount pass_phrase - case "${action}" in - "${action_close}" | "${action_open}") - shift - local user_id - user_id="$(id --user)" - [ "${user_id}" -eq 0 ] || - rwx_log_error 1 "Not root" - [ -n "${1}" ] || - rwx_log_error 2 "No files" - [ "${action}" = "${action_open}" ] && - pass_phrase="$(rwx_read_passphrase)" - for crypt_arg in "${@}"; do - rwx_log_info - crypt_file="${RWX_CRYPT_ROOT}/${crypt_arg}.qcow2" - if [ -f "${crypt_file}" ]; then - crypt_map="${mapper}/${crypt_arg}" - crypt_mount="${mount_root}/${crypt_arg}" - local device - case "${action}" in - "${action_open}") - # find device - if ! device="$(rwx_crypt_device)"; then - rwx_log_error 4 "No device available" - fi - # make directory - if ! mkdir --parents "${RWX_CRYPT_VAR}"; then - rwx_log_error 5 "Making failure: ${RWX_CRYPT_VAR}" - fi - # record device - if ! rwx_file_write \ - "${RWX_CRYPT_VAR}/${crypt_arg}" "${device}"; then - rwx_log_error 6 "Writing failure: ${device}" - fi - # connect device - if ! qemu-nbd --connect "${device}" "${crypt_file}"; then - rwx_log_error 7 "Connection failure: ${device}" - fi - # open device - if ! echo "${pass_phrase}" | - cryptsetup luksOpen "${device}" "${crypt_arg}"; then - rwx_log_error 8 "Opening failure: ${device}" - fi - # make mount directory - if ! mkdir --parents "${crypt_mount}"; then - rwx_log_error 9 "Making failure: ${crypt_mount}" - fi - # mount file system - if ! mount \ - --options "autodefrag,compress-force=zstd" \ - "${crypt_map}" "${crypt_mount}"; then - rwx_log_error 10 "Mounting failure: ${crypt_map}" - fi - ;; - "${action_close}") - # unmount file system - if ! umount "${crypt_mount}"; then - rwx_log_error 4 "Unmounting failure: ${crypt_mount}" - fi - # remove mount directory - if ! rmdir "${crypt_mount}"; then - rwx_log_error 5 "Removal failure: ${crypt_mount}" - fi - # close device - if ! cryptsetup luksClose "${crypt_arg}"; then - rwx_log_error 6 "Closing failure: ${crypt_arg}" - fi - # load device - if ! device="$(cat "${RWX_CRYPT_VAR}/${crypt_arg}")"; then - rwx_log_error 7 "Loading failure: ${crypt_arg}" - fi - # disconnect device - if ! qemu-nbd --disconnect "${device}"; then - rwx_log_error 8 "Disconnection failure: ${device}" - fi - # remove record - if ! rm "${RWX_CRYPT_VAR}/${crypt_arg}"; then - rwx_log_error 9 "Removal failure: ${crypt_arg}" - fi - ;; - *) ;; - esac - else - rwx_log_error 3 "Not a file: ${crypt_file}" - fi - done - ;; - *) - rwx_log_info "Usage:" - rwx_log_info "${action_close}|${action_open}" - # TODO list - ;; - esac -} diff --git a/sh/ffmpeg.sh b/sh/ffmpeg.sh deleted file mode 100644 index c32ad06..0000000 --- a/sh/ffmpeg.sh +++ /dev/null @@ -1,195 +0,0 @@ -# ╭────────┬─────────┬───────╮ -# │ ffmpeg │ devices │ reset │ -# ╰────────┴─────────┴───────╯ - -_rwx_cmd_rwx_ffmpeg_devices_reset() { rwx_ffmpeg_devices_reset "${@}"; } -rwx_ffmpeg_devices_reset() { - local module="uvcvideo" - modprobe --remove "${module}" && - modprobe "${module}" -} - -# ╭────────┬────────┬─────────╮ -# │ ffmpeg │ device │ formats │ -# ╰────────┴────────┴─────────╯ - -rwx_ffmpeg_device_formats() { - local device="${1}" - [ -n "${device}" ] || device="/dev/video0" - ffmpeg \ - -f "v4l2" \ - -list_formats "all" \ - -i "${device}" -} - -# ╭────────┬───────╮ -# │ ffmpeg │ input │ -# ╰────────┴───────╯ - -rwx_ffmpeg_input_blue_yeti() { - local device="alsa_input.\ -usb-Generic_Blue_Microphones_2051BAB04XY8-00.analog-stereo" - set -- \ - -f "pulse" \ - -i "${device}" \ - -ac "2" \ - -ar "48000" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_input_dell_precision() { - local device="alsa_input.\ -pci-0000_00_1f.3.analog-stereo" - set -- \ - -f "pulse" \ - -i "${device}" \ - -ac "2" \ - -ar "48000" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_input_file() { - local file="${1}" - local from="${2}" - local to="${3}" - [ -n "${file}" ] || return - set -- \ - -i "${file}" - if [ -n "${to}" ]; then - set -- "${@}" \ - -ss "${from}" \ - -to "${to}" - fi - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_input_hdmi() { - local device="${1}" - [ -n "${device}" ] || device="/dev/video0" - set -- \ - -f "v4l2" \ - -video_size "1920x1080" \ - -framerate "120" \ - -input_format "yuv420p" \ - -pix_fmt "yuv420p" \ - -i "${device}" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -# ╭────────┬────────╮ -# │ ffmpeg │ output │ -# ╰────────┴────────╯ - -rwx_ffmpeg_output_audio_fast() { - set -- \ - -codec:a "flac" \ - -compression_level "0" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_output_audio_slow() { - set -- \ - -codec:a "libopus" \ - -b:a "128k" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_output_file() { - local file="${1}" - [ -n "${file}" ] || return - set -- \ - -y "${file}" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_output_video_fast() { - set -- \ - -codec:v "libx264" \ - -preset "ultrafast" \ - -crf "0" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -rwx_ffmpeg_output_video_slow() { - local crf="${1}" - local codec="${2}" - [ -n "${codec}" ] || codec="libx264" - if [ -z "${crm}" ]; then - case "${codec}" in - "libx264") crf="23" ;; - "libx265") crf="28" ;; - *) ;; - esac - fi - set -- \ - -codec:v "${codec}" \ - -preset "veryslow" \ - -crf "${crf}" \ - -movflags "+faststart" \ - -pix_fmt "yuv420p" - local argument - for argument in "${@}"; do echo "${argument}"; done -} - -# ╭────────┬────────╮ -# │ ffmpeg │ record │ -# ╰────────┴────────╯ - -rwx_ffmpeg_record_hdmi_precision() { - local file="${1}" - [ -n "${file}" ] || return - # LATER alternative - # shellcheck disable=SC2046,SC2312 - set -- \ - $(rwx_ffmpeg_input_hdmi) \ - $(rwx_ffmpeg_input_dell_precision) \ - $(rwx_ffmpeg_output_video_fast) \ - $(rwx_ffmpeg_output_audio_fast) \ - $(rwx_ffmpeg_output_file "${file}") - echo "${@}" - ffmpeg "${@}" -} - -rwx_ffmpeg_record_hdmi_yeti() { - local file="${1}" - [ -n "${file}" ] || return - # LATER alternative - # shellcheck disable=SC2046,SC2312 - set -- \ - $(rwx_ffmpeg_input_hdmi) \ - $(rwx_ffmpeg_input_blue_yeti) \ - $(rwx_ffmpeg_output_video_fast) \ - $(rwx_ffmpeg_output_audio_fast) \ - $(rwx_ffmpeg_output_file "${file}") - echo "${@}" - ffmpeg "${@}" -} - -# ╭────────┬────────╮ -# │ ffmpeg │ reduce │ -# ╰────────┴────────╯ - -rwx_ffmpeg_reduce() { - local input="${1}" - local output="${2}" - local from="${3}" - local to="${4}" - [ -n "${output}" ] || return - # LATER alternative - # shellcheck disable=SC2046,SC2312 - set -- \ - $(rwx_ffmpeg_input_file "${input}" "${from}" "${to}") \ - $(rwx_ffmpeg_output_video_slow) \ - $(rwx_ffmpeg_output_audio_slow) \ - $(rwx_ffmpeg_output_file "${output}") - echo "${@}" - ffmpeg "${@}" -} diff --git a/sh/file.sh b/sh/file.sh deleted file mode 100644 index becca76..0000000 --- a/sh/file.sh +++ /dev/null @@ -1,26 +0,0 @@ -# ╭──────╮ -# │ file │ -# ╰──────╯ - -rwx_file_append() { - local file="${1}" - local text="${2}" - if [ -n "${file}" ]; then - printf "%s" "${text}" >>"${file}" - fi -} - -rwx_file_empty() { - local file="${1}" - if [ -n "${file}" ]; then - rwx_file_write "${file}" "" - fi -} - -rwx_file_write() { - local file="${1}" - local text="${2}" - if [ -n "${file}" ]; then - printf "%s" "${text}" >"${file}" - fi -} diff --git a/sh/fs.sh b/sh/fs.sh index 26b11c7..ac46f6d 100644 --- a/sh/fs.sh +++ b/sh/fs.sh @@ -1,7 +1,3 @@ -# ╭────╮ -# │ fs │ -# ╰────╯ - rwx_fs_make_btrfs() { local device="${1}" local label="${2}" @@ -9,7 +5,7 @@ rwx_fs_make_btrfs() { if [ -b "${device}" ]; then set -- \ --force \ - --checksum "blake2" + --checksum "sha256" if [ -n "${label}" ]; then set -- "${@}" \ --label "${label}" diff --git a/sh/gnome.sh b/sh/gnome.sh index a571a88..11831fb 100644 --- a/sh/gnome.sh +++ b/sh/gnome.sh @@ -1,65 +1,12 @@ -# ╭───────┬────────────╮ -# │ gnome │ background │ -# ╰───────┴────────────╯ - -rwx_gnome_background_black() { - rwx_gnome_set_background "color-shading-type" "solid" - rwx_gnome_set_background "primary-color" "#000000" -} - -rwx_gnome_background_white() { - rwx_gnome_set_background "color-shading-type" "solid" - rwx_gnome_set_background "primary-color" "#ffffff" -} - -rwx_gnome_background_win3() { - rwx_gnome_set_background "color-shading-type" "vertical" - rwx_gnome_set_background "primary-color" "#000000" - rwx_gnome_set_background "secondary-color" "#0000ff" -} - -# ╭───────┬───────╮ -# │ gnome │ proxy │ -# ╰───────┴───────╯ - rwx_gnome_proxy() { - local port="${1}" - local prefix="org.gnome.system.proxy" - case "${port}" in - "") - gsettings set "${prefix}" "mode" "none" - ;; - *) - gsettings set "${prefix}" "mode" "manual" - gsettings set "${prefix}.socks" "host" "localhost" - gsettings set "${prefix}.socks" "port" "${port}" - ;; + local value + case "${1}" in + "on") value="manual" ;; + *) value="none" ;; esac + gsettings set "org.gnome.system.proxy" "mode" "${value}" } -# ╭───────┬─────╮ -# │ gnome │ set │ -# ╰───────┴─────╯ - -rwx_gnome_set() { - local group="${1}" - local key="${2}" - local value="${3}" - [ -n "${value}" ] || return - gsettings set "${group}" "${key}" "${value}" -} - -rwx_gnome_set_background() { - local key="${1}" - local value="${2}" - [ -n "${value}" ] || return - rwx_gnome_set "org.gnome.desktop.background" "${key}" "${value}" -} - -# ╭───────┬────────────╮ -# │ gnome │ workspaces │ -# ╰───────┴────────────╯ - rwx_gnome_workspaces_primary() { local bool local group="org.gnome.mutter" diff --git a/sh/gpg.sh b/sh/gpg.sh index e1bf31c..a2b7f50 100644 --- a/sh/gpg.sh +++ b/sh/gpg.sh @@ -1,20 +1,3 @@ -# functions to handle gpg - -# turn gpg agent off -#= gak -rwx_gpg_agent_kill() { - gpgconf \ - --kill "gpg-agent" -} - -# bind gpg agent to current tty -#= gau -rwx_gpg_agent_update() { - gpg-connect-agent \ - updatestartuptty \ - /bye -} - rwx_gpg_ssh_auth_sock() { local user_id user_id=$(id --user) diff --git a/sh/lint/gitlint.sh b/sh/lint/gitlint.sh deleted file mode 100644 index 643333c..0000000 --- a/sh/lint/gitlint.sh +++ /dev/null @@ -1,6 +0,0 @@ -rwx_gitlint() { - local path="${1}" - gitlint \ - --target "${path}" \ - "lint" -} diff --git a/sh/lint/lint.sh b/sh/lint/lint.sh deleted file mode 100644 index 365773f..0000000 --- a/sh/lint/lint.sh +++ /dev/null @@ -1,78 +0,0 @@ -# lint code -rwx_lint() { - local path="${1}" - [ -n "${path}" ] || return 1 - rwx_lint_clean "${path}" - rwx_lint_tasks "${path}" - set \ - "python" \ - "shell" - local code - for code in "${@}"; do - rwx_log "" "${code}" - "rwx_lint_${code}" "${path}" - done - rwx_lint_clean "${path}" -} - -# clean -rwx_lint_clean() { - local path="${1}" - [ -n "${path}" ] || return 1 - rwx_log "" "clean" "" - py3clean "${path}" - set \ - "mypy" \ - "ruff" - local tool - for tool in "${@}"; do - rwx_remove "${path}/.${tool}_cache" - done -} - -# lint python code -rwx_lint_python() { - local path="${1}" - local action - set \ - "pylint" \ - "pydoclint" \ - "mypy" \ - "ruff" - for action in "${@}"; do - rwx_log "" "${action}" - "rwx_${action}" "${path}" - done -} - -# lint shell code -rwx_lint_shell() { - local path="${1}" - local action - set \ - "shellcheck" \ - "shfmt" - for action in "${@}"; do - rwx_log "" "${action}" - "rwx_${action}" "${path}" - done -} - -# lint code tasks -rwx_lint_tasks() { - local path="${1}" - local type - set \ - "LATER" \ - "TODO" \ - "FIXME" - for type in "${@}"; do - rwx_log "" "${type}" - grep \ - --after "1" \ - --directories "recurse" \ - --line-number \ - " ${type}" \ - "${path}" - done -} diff --git a/sh/lint/mypy.sh b/sh/lint/mypy.sh deleted file mode 100644 index 586d409..0000000 --- a/sh/lint/mypy.sh +++ /dev/null @@ -1,4 +0,0 @@ -rwx_mypy() { - local path="${1}" - mypy "${path}" -} diff --git a/sh/lint/pydoclint.sh b/sh/lint/pydoclint.sh deleted file mode 100644 index d2eb72f..0000000 --- a/sh/lint/pydoclint.sh +++ /dev/null @@ -1,9 +0,0 @@ -rwx_pydoclint() { - local path="${1}" - pydoclint \ - --allow-init-docstring True \ - --quiet \ - --skip-checking-short-docstrings False \ - --style "sphinx" \ - "${path}" -} diff --git a/sh/lint/pylint.sh b/sh/lint/pylint.sh deleted file mode 100644 index 52e1bd1..0000000 --- a/sh/lint/pylint.sh +++ /dev/null @@ -1,6 +0,0 @@ -rwx_pylint() { - local path="${1}" - pylint \ - --enable-all-extensions \ - "${path}/**/*.py" -} diff --git a/sh/lint/ruff.sh b/sh/lint/ruff.sh deleted file mode 100644 index e15b701..0000000 --- a/sh/lint/ruff.sh +++ /dev/null @@ -1,28 +0,0 @@ -rwx_ruff() { - local path="${1}" - local action - set \ - "check" \ - "format" - for action in "${@}"; do - "rwx_ruff_${action}" "${path}" - done -} - -rwx_ruff_check() { - local path="${1}" - ruff check \ - --ignore "D203,D213" \ - --isolated \ - --select "ALL" \ - "${path}" -} - -rwx_ruff_format() { - local path="${1}" - ruff format \ - --diff \ - --isolated \ - --line-length "80" \ - "${path}" -} diff --git a/sh/lint/shellcheck.sh b/sh/lint/shellcheck.sh index 0253062..11b5b0d 100644 --- a/sh/lint/shellcheck.sh +++ b/sh/lint/shellcheck.sh @@ -1,20 +1,14 @@ -rwx_shellcheck() { +rwx_shellcheck_check() { local root="${1}" local file module modules path file="$(mktemp)" - modules="$(rwx_find_shell "${root}")" - while IFS= read -r module; do + modules="$(rwx_find_sh "${root}")" + rwx_ifs_set + for module in ${modules}; do path="${root}/${module}" echo ". \"${path}\"" >>"${file}" - done <"/etc/profile.d/${SH_NAME}.sh" + # bash + local file="/etc/bash.bashrc" + rm --force --recursive "${file}" + ln --symbolic "${ENV}" "${file}" +} diff --git a/sh/tmux.sh b/sh/tmux.sh deleted file mode 100644 index 9213e01..0000000 --- a/sh/tmux.sh +++ /dev/null @@ -1,398 +0,0 @@ -# ╭──────╮ -# │ tmux │ -# ╰──────╯ - -# attach -#= tma -rwx_tmux_attach() { - local server="${1}" - if [ -n "${server}" ]; then - tmux -L "${server}" attach-session - else - rwx_tmux_list - fi -} - -# kill -#= tmk -rwx_tmux_kill() { - local server="${1}" - if [ -n "${server}" ]; then - tmux -L "${server}" kill-server 2>"/dev/null" - else - rwx_tmux_list - fi -} - -# list -#= tml -rwx_tmux_list() { - local user_id - user_id="$(id --user)" - ls "/tmp/tmux-${user_id}" -} - -# ╭──────┬───────╮ -# │ tmux │ setup │ -# ╰──────┴───────╯ - -_rwx_cmd_rwx_tmux_setup() { rwx_tmux_setup "${@}"; } -rwx_tmux_setup() { - local file script - if rwx_root; then - file="/etc/tmux.conf" - script="/etc/tmux.sh" - else - file="${HOME}/.tmux.conf" - script="${HOME}/.tmux.sh" - fi - rwx_file_write "${script}" "\ -rwx_tmux_server() { - basename \"\${TMUX}\" | - cut \\ - --delimiter \",\" \\ - --fields \"1\" -} -rwx_tmux_servers() { - local active=\"\$(rwx_tmux_server)\" - local name path text - local paths=\"\$(lsof -U | - awk \"/^tmux:.*\\(LISTEN\\)\$/ {print \\\$9}\")\" - while IFS= read -r path; do - name=\"\$(basename \"\${path}\")\" - text=\"\${text}\\ -#[fg=default]\\ -#[bg=default] \\ -\" - if [ \"\${active}\" = \"\${name}\" ]; then - text=\"\${text}#[fg=green]\" - else - text=\"\${text}#[fg=yellow]\" - fi - text=\"\${text}\\ -#[bg=##181818] \\ -#[bg=##282828]\${name}\\ -#[bg=##181818] \\ -\" - done <