commit fe7877fde63cb7c2be545e21248a92441fac9b6f Author: Ari Archer Date: Fri Jun 21 02:29:56 2024 +0300 init Signed-off-by: Ari Archer diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..6c54233 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,11 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +tab_width = 2 + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9dc6e5b --- /dev/null +++ b/.gitignore @@ -0,0 +1,168 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ + +# Databases +*.db + +# Other +.ccls-cache/ +!py.typed +*.png diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0dd7b75 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + 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. + + Project "forgejo-stats" + Copyright (C) 2024 Ari Archer + + 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/README.md b/README.md new file mode 100644 index 0000000..cb12133 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Forgejo stats + +> Forgejo profile README statistics all in CI/CD + +## Setup + +- Place `stats.py` in your .profile +- Modify `stats.py` to your needs +- Place `requirements.txt`, `lang.json`, and `requirements.txt` in your .profile repo +- Place `stats.yaml` in `.forgejo/workflows/` in your .profile repo +- Embed the images + +For example: diff --git a/lang.json b/lang.json new file mode 100644 index 0000000..b6630dc --- /dev/null +++ b/lang.json @@ -0,0 +1,596 @@ +{ + "1c enterprise": "#814CCC", + "2-dimensional array": "#38761D", + "4d": "#004289", + "abap": "#E8274B", + "abap cds": "#555e25", + "ags script": "#B9D9FF", + "aidl": "#34EB6B", + "al": "#3AA2B5", + "ampl": "#E6EFBB", + "antlr": "#9DC3FF", + "api blueprint": "#2ACCA8", + "apl": "#5A8164", + "asp.net": "#9400ff", + "ats": "#1ac620", + "actionscript": "#882B0F", + "ada": "#02f88c", + "adblock filter list": "#800000", + "adobe font metrics": "#fa0f00", + "agda": "#315665", + "alloy": "#64C800", + "alpine abuild": "#0D597F", + "altium designer": "#A89663", + "angelscript": "#C7D7DC", + "ant build system": "#A9157E", + "antlers": "#ff269e", + "apacheconf": "#d12127", + "apex": "#1797c0", + "apollo guidance computer": "#0B3D91", + "applescript": "#101F1F", + "arc": "#aa2afe", + "asciidoc": "#73a0c5", + "aspectj": "#a957b0", + "assembly": "#6E4C13", + "astro": "#ff5a03", + "asymptote": "#ff0000", + "augeas": "#9CC134", + "autohotkey": "#6594b9", + "autoit": "#1C3552", + "avro idl": "#0040FF", + "awk": "#c30e9b", + "basic": "#ff0000", + "bqn": "#2b7067", + "ballerina": "#FF5000", + "batchfile": "#C1F12E", + "beef": "#a52f4e", + "berry": "#15A13C", + "bibtex": "#778899", + "bicep": "#519aba", + "bikeshed": "#5562ac", + "bison": "#6A463F", + "bitbake": "#00bce4", + "blade": "#f7523f", + "blitzbasic": "#00FFAE", + "blitzmax": "#cd6400", + "bluespec": "#12223c", + "bluespec bh": "#12223c", + "boo": "#d4bec1", + "boogie": "#c80fa0", + "brainfuck": "#2F2530", + "brighterscript": "#66AABB", + "brightscript": "#662D91", + "browserslist": "#ffd539", + "c": "#555555", + "c#": "#178600", + "c++": "#f34b7d", + "cap cds": "#0092d1", + "clips": "#00A300", + "cmake": "#DA3434", + "collada": "#F1A42B", + "cson": "#244776", + "css": "#563d7c", + "csv": "#237346", + "cue": "#5886E1", + "cweb": "#00007a", + "cabal config": "#483465", + "caddyfile": "#22b638", + "cadence": "#00ef8b", + "cairo": "#ff4a48", + "cameligo": "#3be133", + "cap'n proto": "#c42727", + "ceylon": "#dfa535", + "chapel": "#8dc63f", + "chuck": "#3f8000", + "circom": "#707575", + "cirru": "#ccccff", + "clarion": "#db901e", + "clarity": "#5546ff", + "classic asp": "#6a40fd", + "clean": "#3F85AF", + "click": "#E4E6F3", + "clojure": "#db5855", + "closure templates": "#0d948f", + "cloud firestore security rules": "#FFA000", + "codeql": "#140f46", + "coffeescript": "#244776", + "coldfusion": "#ed2cd6", + "coldfusion cfc": "#ed2cd6", + "common lisp": "#3fb68b", + "common workflow language": "#B5314C", + "component pascal": "#B0CE4E", + "coq": "#d0b68c", + "crystal": "#000100", + "csound": "#1a1a1a", + "csound document": "#1a1a1a", + "csound score": "#1a1a1a", + "cuda": "#3A4E3A", + "curry": "#531242", + "cypher": "#34c0eb", + "cython": "#fedf5b", + "d": "#ba595e", + "d2": "#526ee8", + "dm": "#447265", + "dafny": "#FFEC25", + "darcs patch": "#8eff23", + "dart": "#00B4AB", + "dataweave": "#003a52", + "debian package control file": "#D70751", + "denizenscript": "#FBEE96", + "dhall": "#dfafff", + "directx 3d file": "#aace60", + "dockerfile": "#384d54", + "dogescript": "#cca760", + "dotenv": "#e5d559", + "dylan": "#6c616e", + "e": "#ccce35", + "ecl": "#8a1267", + "eclipse": "#001d9d", + "ejs": "#a91e50", + "eq": "#a78649", + "earthly": "#2af0ff", + "easybuild": "#069406", + "ecere projects": "#913960", + "ecmarkup": "#eb8131", + "edge": "#0dffe0", + "edgeql": "#31A7FF", + "editorconfig": "#fff1f2", + "eiffel": "#4d6977", + "elixir": "#6e4a7e", + "elm": "#60B5CC", + "elvish": "#55BB55", + "elvish transcript": "#55BB55", + "emacs lisp": "#c065db", + "emberscript": "#FFF4F3", + "erlang": "#B83998", + "euphoria": "#FF790B", + "f#": "#b845fc", + "f*": "#572e30", + "figlet font": "#FFDDBB", + "firrtl": "#2f632f", + "flux": "#88ccff", + "factor": "#636746", + "fancy": "#7b9db4", + "fantom": "#14253c", + "faust": "#c37240", + "fennel": "#fff3d7", + "filebench wml": "#F6B900", + "fluent": "#ffcc33", + "forth": "#341708", + "fortran": "#4d41b1", + "fortran free form": "#4d41b1", + "freebasic": "#141AC9", + "freemarker": "#0050b2", + "frege": "#00cafe", + "futhark": "#5f021f", + "g-code": "#D08CF2", + "gaml": "#FFC766", + "gams": "#f49a22", + "gap": "#0000cc", + "gcc machine description": "#FFCFAB", + "gdscript": "#355570", + "gedcom": "#003058", + "glsl": "#5686a5", + "gsc": "#FF6800", + "game maker language": "#71b417", + "gemfile.lock": "#701516", + "gemini": "#ff6900", + "genero 4gl": "#63408e", + "genero per": "#d8df39", + "genie": "#fb855d", + "genshi": "#951531", + "gentoo ebuild": "#9400ff", + "gentoo eclass": "#9400ff", + "gerber image": "#d20b00", + "gherkin": "#5B2063", + "git attributes": "#F44D27", + "git config": "#F44D27", + "git revision list": "#F44D27", + "gleam": "#ffaff3", + "glimmer js": "#F5835F", + "glimmer ts": "#3178c6", + "glyph": "#c1ac7f", + "gnuplot": "#f0a9f0", + "go": "#00ADD8", + "go checksums": "#00ADD8", + "go module": "#00ADD8", + "go workspace": "#00ADD8", + "godot resource": "#355570", + "golo": "#88562A", + "gosu": "#82937f", + "grace": "#615f8b", + "gradle": "#02303a", + "gradle kotlin dsl": "#02303a", + "grammatical framework": "#ff0000", + "graphql": "#e10098", + "graphviz (dot)": "#2596be", + "groovy": "#4298b8", + "groovy server pages": "#4298b8", + "haproxy": "#106da9", + "hcl": "#844FBA", + "hlsl": "#aace60", + "hocon": "#9ff8ee", + "html": "#e34c26", + "html+ecr": "#2e1052", + "html+eex": "#6e4a7e", + "html+erb": "#701516", + "html+php": "#4f5d95", + "html+razor": "#512be4", + "http": "#005C9C", + "hxml": "#f68712", + "hack": "#878787", + "haml": "#ece2a9", + "handlebars": "#f7931e", + "harbour": "#0e60e3", + "haskell": "#5e5086", + "haxe": "#df7900", + "hiveql": "#dce200", + "holyc": "#ffefaf", + "hosts file": "#308888", + "hy": "#7790B2", + "idl": "#a3522f", + "igor pro": "#0000cc", + "ini": "#d1dbe0", + "idris": "#b30000", + "ignore list": "#000000", + "imagej macro": "#99AAFF", + "imba": "#16cec6", + "inno setup": "#264b99", + "io": "#a9188d", + "ioke": "#078193", + "isabelle": "#FEFE00", + "isabelle root": "#FEFE00", + "j": "#9EEDFF", + "jar manifest": "#b07219", + "jcl": "#d90e09", + "jflex": "#DBCA00", + "json": "#292929", + "json with comments": "#292929", + "json5": "#267CB9", + "jsonld": "#0c479c", + "jsoniq": "#40d47e", + "janet": "#0886a5", + "jasmin": "#d03600", + "java": "#b07219", + "java properties": "#2A6277", + "java server pages": "#2A6277", + "javascript": "#f1e05a", + "javascript+erb": "#f1e05a", + "jest snapshot": "#15c213", + "jetbrains mps": "#21D789", + "jinja": "#a52a22", + "jison": "#56b3cb", + "jison lex": "#56b3cb", + "jolie": "#843179", + "jsonnet": "#0064bd", + "julia": "#a270ba", + "julia repl": "#a270ba", + "jupyter notebook": "#DA5B0B", + "just": "#384d54", + "krl": "#28430A", + "kaitai struct": "#773b37", + "kakounescript": "#6f8042", + "kerboscript": "#41adf0", + "kicad layout": "#2f4aab", + "kicad legacy layout": "#2f4aab", + "kicad schematic": "#2f4aab", + "kotlin": "#A97BFF", + "lfe": "#4C3023", + "llvm": "#185619", + "lolcode": "#cc9900", + "lsl": "#3d9970", + "labview": "#fede06", + "lark": "#2980B9", + "lasso": "#999999", + "latte": "#f2a542", + "less": "#1d365d", + "lex": "#DBCA00", + "ligolang": "#0e74ff", + "lilypond": "#9ccc7c", + "liquid": "#67b8de", + "literate agda": "#315665", + "literate coffeescript": "#244776", + "literate haskell": "#5e5086", + "livescript": "#499886", + "logtalk": "#295b9a", + "lookml": "#652B81", + "lua": "#000080", + "luau": "#00A2FF", + "matlab": "#e16737", + "maxscript": "#00a6a6", + "mdx": "#fcb32c", + "mlir": "#5EC8DB", + "mql4": "#62A8D6", + "mql5": "#4A76B8", + "mtml": "#b7e1f4", + "macaulay2": "#d8ffff", + "makefile": "#427819", + "mako": "#7e858d", + "markdown": "#083fa1", + "marko": "#42bff2", + "mask": "#f97732", + "mathematica": "#dd1100", + "max": "#c4a79c", + "mercury": "#ff2b2b", + "mermaid": "#ff3670", + "meson": "#007800", + "metal": "#8f14e9", + "miniyaml": "#ff1111", + "mint": "#02b046", + "mirah": "#c7a938", + "modelica": "#de1d31", + "modula-2": "#10253f", + "modula-3": "#223388", + "mojo": "#ff4c1f", + "monkey c": "#8D6747", + "moonscript": "#ff4585", + "motoko": "#fbb03b", + "motorola 68k assembly": "#005daa", + "move": "#4a137a", + "mustache": "#724b3b", + "ncl": "#28431f", + "nmodl": "#00356B", + "npm config": "#cb3837", + "nwscript": "#111522", + "nasal": "#1d2c4e", + "nearley": "#990000", + "nemerle": "#3d3c6e", + "netlinx": "#0aa0ff", + "netlinx+erb": "#747faa", + "netlogo": "#ff6375", + "newlisp": "#87AED7", + "nextflow": "#3ac486", + "nginx": "#009639", + "nim": "#ffc200", + "nit": "#009917", + "nix": "#7e7eff", + "nu": "#c9df40", + "numpy": "#9C8AF9", + "nunjucks": "#3d8137", + "nushell": "#4E9906", + "oasv2-json": "#85ea2d", + "oasv2-yaml": "#85ea2d", + "oasv3-json": "#85ea2d", + "oasv3-yaml": "#85ea2d", + "ocaml": "#ef7a08", + "objectscript": "#424893", + "objective-c": "#438eff", + "objective-c++": "#6866fb", + "objective-j": "#ff0c5a", + "odin": "#60AFFE", + "omgrofl": "#cabbff", + "opal": "#f7ede0", + "open policy agent": "#7d9199", + "openapi specification v2": "#85ea2d", + "openapi specification v3": "#85ea2d", + "opencl": "#ed2e2d", + "openedge abl": "#5ce600", + "openqasm": "#AA70FF", + "openscad": "#e5cd45", + "option list": "#476732", + "org": "#77aa99", + "oxygene": "#cdd0e3", + "oz": "#fab738", + "p4": "#7055b5", + "pddl": "#0d00ff", + "peg.js": "#234d6b", + "php": "#4F5D95", + "plsql": "#dad8d8", + "plpgsql": "#336790", + "pov-ray sdl": "#6bac65", + "pact": "#F7A8B8", + "pan": "#cc0000", + "papyrus": "#6600cc", + "parrot": "#f3ca0a", + "pascal": "#E3F171", + "pawn": "#dbb284", + "pep8": "#C76F5B", + "perl": "#0298c3", + "picolisp": "#6067af", + "piglatin": "#fcd7de", + "pike": "#005390", + "pip requirements": "#FFD343", + "pkl": "#6b9543", + "plantuml": "#fbbd16", + "pogoscript": "#d80074", + "polar": "#ae81ff", + "portugol": "#f8bd00", + "postcss": "#dc3a0c", + "postscript": "#da291c", + "powerbuilder": "#8f0f8d", + "powershell": "#012456", + "praat": "#c8506d", + "prisma": "#0c344b", + "processing": "#0096D8", + "procfile": "#3B2F63", + "prolog": "#74283c", + "promela": "#de0000", + "propeller spin": "#7fa2a7", + "pug": "#a86454", + "puppet": "#302B6D", + "purebasic": "#5a6986", + "purescript": "#1D222D", + "pyret": "#ee1e10", + "python": "#3572A5", + "python console": "#3572A5", + "python traceback": "#3572A5", + "q#": "#fed659", + "qml": "#44a51c", + "qt script": "#00b841", + "quake": "#882233", + "r": "#198CE7", + "raml": "#77d9fb", + "rbs": "#701516", + "rdoc": "#701516", + "rexx": "#d90e09", + "rmarkdown": "#198ce7", + "ron": "#a62c00", + "rpgle": "#2BDE21", + "runoff": "#665a4e", + "racket": "#3c5caa", + "ragel": "#9d5200", + "raku": "#0000fb", + "rascal": "#fffaa0", + "rescript": "#ed5051", + "reason": "#ff5847", + "reasonligo": "#ff5847", + "rebol": "#358a5b", + "record jar": "#0673ba", + "red": "#f50000", + "regular expression": "#009a00", + "ren'py": "#ff7f7f", + "rez": "#FFDAB3", + "ring": "#2D54CB", + "riot": "#A71E49", + "robotframework": "#00c0b5", + "roc": "#7c38f5", + "roff": "#ecdebe", + "roff manpage": "#ecdebe", + "rouge": "#cc0088", + "routeros script": "#DE3941", + "ruby": "#701516", + "rust": "#dea584", + "sas": "#B34936", + "scss": "#c6538c", + "sparql": "#0C4597", + "sqf": "#3F3F3F", + "sql": "#e38c00", + "sqlpl": "#e38c00", + "srecode template": "#348a34", + "stl": "#373b5e", + "svg": "#ff9900", + "saltstack": "#646464", + "sass": "#a53b70", + "scala": "#c22d40", + "scaml": "#bd181a", + "scenic": "#fdc700", + "scheme": "#1e4aec", + "scilab": "#ca0f21", + "self": "#0579aa", + "shaderlab": "#222c37", + "shell": "#89e051", + "shellcheck config": "#cecfcb", + "shen": "#120F14", + "simple file verification": "#C9BFED", + "singularity": "#64E6AD", + "slash": "#007eff", + "slice": "#003fa2", + "slim": "#2b2b2b", + "slint": "#2379F4", + "smpl": "#c94949", + "smalltalk": "#596706", + "smarty": "#f0c040", + "smithy": "#c44536", + "snakemake": "#419179", + "solidity": "#AA6746", + "sourcepawn": "#f69e1d", + "squirrel": "#800000", + "stan": "#b2011d", + "standard ml": "#dc566d", + "starlark": "#76d275", + "stata": "#1a5f91", + "stringtemplate": "#3fb34f", + "stylus": "#ff6347", + "subrip text": "#9e0101", + "sugarss": "#2fcc9f", + "supercollider": "#46390b", + "svelte": "#ff3e00", + "sway": "#00F58C", + "sweave": "#198ce7", + "swift": "#F05138", + "systemverilog": "#DAE1C2", + "ti program": "#A0AA87", + "tl-verilog": "#C40023", + "tla": "#4b0079", + "toml": "#9c4221", + "tsql": "#e38c00", + "tsv": "#237346", + "tsx": "#3178c6", + "txl": "#0178b8", + "talon": "#333333", + "tcl": "#e4cc98", + "tex": "#3D6117", + "terra": "#00004c", + "terraform template": "#7b42bb", + "textgrid": "#c8506d", + "textmate properties": "#df66e4", + "textile": "#ffe7ac", + "thrift": "#D12127", + "toit": "#c2c9fb", + "turing": "#cf142b", + "twig": "#c1d026", + "typescript": "#3178c6", + "typst": "#239dad", + "unified parallel c": "#4e3617", + "unity3d asset": "#222c37", + "uno": "#9933cc", + "unrealscript": "#a54c4d", + "urweb": "#ccccee", + "v": "#4f87c4", + "vba": "#867db1", + "vbscript": "#15dcdc", + "vcl": "#148AA8", + "vhdl": "#adb2cb", + "vala": "#a56de2", + "valve data format": "#f26025", + "velocity template language": "#507cff", + "verilog": "#b2b7f8", + "vim help file": "#199f4b", + "vim script": "#199f4b", + "vim snippet": "#199f4b", + "visual basic .net": "#945db7", + "visual basic 6.0": "#2c6353", + "volt": "#1F1F1F", + "vue": "#41b883", + "vyper": "#2980b9", + "wdl": "#42f1f4", + "wgsl": "#1a5e9a", + "web ontology language": "#5b70bd", + "webassembly": "#04133b", + "webassembly interface type": "#6250e7", + "whiley": "#d5c397", + "wikitext": "#fc5757", + "windows registry entries": "#52d5ff", + "witcher script": "#ff0000", + "wollok": "#a23738", + "world of warcraft addon data": "#f7e43f", + "wren": "#383838", + "x10": "#4B6BEF", + "xc": "#99DA07", + "xml": "#0060ac", + "xml property list": "#0060ac", + "xquery": "#5232e7", + "xslt": "#EB8CEB", + "xojo": "#81bd41", + "xonsh": "#285EEF", + "xtend": "#24255d", + "yaml": "#cb171e", + "yara": "#220000", + "yasnippet": "#32AB90", + "yacc": "#4B6C4B", + "yul": "#794932", + "zap": "#0d665e", + "zil": "#dc75e5", + "zenscript": "#00BCD1", + "zephir": "#118f9e", + "zig": "#ec915c", + "zimpl": "#d67711", + "crontab": "#ead7ac", + "ec": "#913960", + "fish": "#4aae47", + "hoon": "#00b171", + "jq": "#c7254e", + "kvlang": "#1da6e0", + "mirc script": "#3d57c3", + "mcfunction": "#E22837", + "mupad": "#244963", + "nanorc": "#2d004d", + "nesc": "#94B0C7", + "ooc": "#b0b77e", + "q": "#0040cd", + "restructuredtext": "#141414", + "sed": "#64b970", + "templ": "#66D0DD", + "wisp": "#7582D1", + "xbase": "#403a40" +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..53053d3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,21 @@ +[tool.pyright] +pythonVersion = "3.10" +exclude = [ + "venv", + "**/node_modules", + "**/__pycache__", + ".git" +] +include = ["src", "scripts"] +venv = "venv" +stubPath = "src/stubs" +typeCheckingMode = "strict" +useLibraryCodeForTypes = true +reportMissingTypeStubs = true + +[tool.mypy] +exclude = [ + "^venv/.*", + "^node_modules/.*", + "^__pycache__/.*", +] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..be38434 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +matplotlib +numpy +requests diff --git a/stats.py b/stats.py new file mode 100644 index 0000000..08aa2ca --- /dev/null +++ b/stats.py @@ -0,0 +1,282 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +"""Forgejo statistics + +Copyright (C) 2024 Ari Archer + +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 .""" + + +import json +import typing as t +from collections import defaultdict +from datetime import datetime, timedelta +from warnings import filterwarnings as filter_warnings + +import matplotlib.dates as mdates +import matplotlib.pyplot as plt +import numpy as np +import requests + +# Configuration + +BASE_URL: str = "https://git.ari.lt/api/v1" +USERNAME: str = "ari" +LANG_COLS: t.Final[int] = 3 # How many colums for the languages +AUTHORS: t.Tuple[str, ...] = ( + USERNAME, + "TruncatedDinoSour", + "Ari Archer", + "ari.web.xyz@gmail.com", + "ari@ari.lt", + "B00bleaTeA", + "4FAD63E936B305906A6C4894A50D5B4B599AF8A2", +) +IGNORE_REPOS: t.Tuple[str, ...] = "dino-kernel", "sysvinit" +COLOUR: str = "#ffa647" +DPI: t.Final[int] = 300 +COMMIT_PAGE_LIMIT: t.Final[int] = 5 # Maximum commit pages (similar to UI) +COMMIT_YEARS: t.Final[int] = ( + 2 # How many years should the commit plot use in your commit history? +) + + +# Code + + +def is_authoring(author: t.Any) -> bool: + """Returns if the user is authoring""" + + author = str(author) + + for a in AUTHORS: + if a.lower() in author.lower(): + return True + + return False + + +def get_repositories() -> t.List[t.Dict[str, t.Any]]: + """Fetch all repositories of a user""" + + all_repos: t.List[t.Dict[str, t.Any]] = [] + + page: int = 1 + + while True: + response: requests.Response = requests.get( + f"{BASE_URL}/users/{USERNAME}/repos?page={page}&limit=4" + ) + + response.raise_for_status() + repos: t.List[t.Any] = response.json() + + print(f"Got {len(repos)} repositories from page {page}") + + if not repos: + break + + for repo in repos: + if repo["name"] not in IGNORE_REPOS and is_authoring(repo["owner"]): + print(f"Author of {repo['name']}") + all_repos.append(repo) + + page += 1 + break + + return all_repos + + +def get_repo_languages(repo: t.Dict[str, t.Any]) -> t.Dict[str, int]: + """Fetch languages used in a specific repository""" + + response: requests.Response = requests.get( + f"{BASE_URL}/repos/{USERNAME}/{repo['name']}/languages" + ) + response.raise_for_status() + + languages: t.Dict[str, int] = response.json() + print(f"Languages for {repo['name']}: {languages}") + return languages + + +def get_repo_commits(repo: t.Dict[str, t.Any]) -> t.List[t.Dict[str, t.Any]]: + """Get the commit objects in a specific repository""" + + all_commits: t.List[t.Dict[str, t.Any]] = [] + + page: int = 1 + + while page <= COMMIT_PAGE_LIMIT: + response: requests.Response = requests.get( + f"{BASE_URL}/repos/{USERNAME}/{repo['name']}/commits?author={USERNAME}&page={page}&limit=100" + ) + + if response.status_code == 409: + break + + response.raise_for_status() + + commits: t.List[t.Dict[str, t.Any]] = [ + commit for commit in response.json() if is_authoring(commit) + ] + + print( + f"Got authored {len(commits)} commits from repository's {repo['name']} page {page}" + ) + + if not commits: + break + + all_commits.extend(commits) + + page += 1 + + return all_commits + + +def analyze_data( + repos: t.List[t.Dict[str, t.Any]] +) -> t.Tuple[t.Dict[str, int], t.Dict[str, int]]: + """Analyze repositories to get language usage and commit activity""" + + language_stats: t.Dict[str, int] = defaultdict(int) + commit_activity: t.Dict[str, int] = defaultdict(int) + + for idx, repo in enumerate(repos): + print(f"[{idx / len(repos):.2%}] Analyzing {repo['name']} ...") + + languages: t.Dict[str, int] = get_repo_languages(repo) + + for lang, count in languages.items(): + language_stats[lang] += count + + commits: t.List[t.Dict[str, t.Any]] = get_repo_commits(repo) + + for commit in commits: + date_str = commit["commit"]["author"]["date"][:10] + commit_activity[date_str] += 1 + + return language_stats, commit_activity + + +def plot_data( + language_stats: t.Dict[str, int], + commit_activity: t.Dict[str, int], + language_colours: t.Dict[str, str], +) -> None: + """Plot language statistics and commit activity""" + + plt.style.use("dark_background") + + # -*- Language statistics -*- + + print(f"Plotting languages...") + + sorted_languages: t.List[t.Tuple[str, int]] = sorted( + language_stats.items(), key=lambda x: x[1], reverse=True + )[: (7 * LANG_COLS)] + languages, counts = zip(*sorted_languages) + total: int = sum(counts) + + cumulative_counts = np.cumsum([0] + list(counts[:-1])) + + plt.figure(figsize=((10 / 3) * LANG_COLS, (2 / 3) * LANG_COLS)) + + for lang, count, cum_count in zip(languages, counts, cumulative_counts): + color = language_colours.get(lang.lower(), "#CCCCCC") + plt.barh(0, count, color=color, left=cum_count, edgecolor="white") + + plt.axis("off") + plt.title("Top Programming Languages by Usage", fontsize=14, color=COLOUR) + plt.legend( + handles=[ + plt.Rectangle( + (0, 0), 1, 1, color=language_colours.get(lang.lower(), "#CCCCCC") + ) + for lang in languages + ], + labels=[ + f"{lang} - {count/total:.2%}" for lang, count in zip(languages, counts) + ], + loc="upper center", + bbox_to_anchor=(0.5, -0.05), + ncol=LANG_COLS, + fontsize=8, + frameon=False, + ) + + plt.tight_layout() + plt.savefig("languages.png", transparent=True, dpi=DPI) + print("Wrote languages.png") + + # -*- Commit statistics -*- + + print(f"Plotting commits...") + + two_years_ago: datetime = datetime.now() - timedelta(days=(365.25 * COMMIT_YEARS)) + filtered_dates: t.Dict[str, int] = { + date: count + for date, count in commit_activity.items() + if datetime.strptime(date, "%Y-%m-%d") >= two_years_ago + } + + dates: t.List[str] = sorted(filtered_dates.keys()) + counts: t.List[int] = [filtered_dates[date] for date in dates] + dates: t.List[np.datetime64] = [np.datetime64(date) for date in dates] + + plt.figure(figsize=(16, 9)) + + plt.fill_between(dates, counts, color=COLOUR, alpha=0.4) + plt.plot(dates, counts, color=COLOUR, alpha=0.6) + plt.gcf().autofmt_xdate() + plt.gca().xaxis.set_major_locator(mdates.MonthLocator()) + plt.gca().xaxis.set_major_formatter(mdates.DateFormatter("%Y-%m")) + plt.xlabel("Date", fontsize=12, color="white") + plt.ylabel("Number of Commits", fontsize=12, color="white") + plt.title("Commit Activity", fontsize=14, color=COLOUR) + plt.grid(True, which="both", linestyle="--", linewidth=0.5, color="gray") + + plt.tight_layout() + plt.savefig( + "commits.png", + transparent=True, + dpi=DPI, + ) + print("Wrote commits.png") + + +def main() -> int: + """entry / main function""" + + with open("lang.json", "r") as fp: + language_colours: t.Dict[str, str] = json.load(fp) + + repos: t.List[t.Dict[str, t.Any]] = get_repositories() + print(f"Found {len(repos)} repositories") + + print("Analyzing repositories...") + language_stats, commit_activity = analyze_data(repos) + + print("Plotting data...") + plot_data(language_stats, commit_activity, language_colours) + + return 0 + + +if __name__ == "__main__": + assert main.__annotations__.get("return") is int, "main() should return an integer" + + filter_warnings("error", category=Warning) + raise SystemExit(main()) diff --git a/stats.yaml b/stats.yaml new file mode 100644 index 0000000..f92615c --- /dev/null +++ b/stats.yaml @@ -0,0 +1,55 @@ +on: + push: + branches: + - main + paths-ignore: + - 'commits.png' + - 'languages.png' + schedule: + - cron: '0 */8 * * *' + +jobs: + stats: + runs-on: docker + container: catthehacker/ubuntu:act-latest + steps: + - uses: actions/checkout@v4 + with: + token: ${{ secrets.GIT_TOKEN }} + + - name: Check for Skip CI in Last Commit + id: check_commit + run: | + commit_message=$(git log -1 --pretty=%B) + if echo "$commit_message" | grep -q "\[skip ci\]"; then + echo "Skip CI based on commit message" && exit 78; + fi + + - uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'pip' + + - name: Install dependencies + run: | + pip install -r requirements.txt + + - name: Generate statistics + run: | + python3 stats.py + + - name: Stage the changes + run: | + git add languages.png commits.png + + - name: Commit and Push Changes + run: | + if git diff --staged --quiet; then + echo "No changes to commit." + else + git config --local user.email "stats@localhost" + git config --local user.name "Stats CI/CD" + git add commits.png languages.png + git commit -am "Update stats" || echo "No changes to commit" + git push origin HEAD + fi diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..8c213ed --- /dev/null +++ b/tox.ini @@ -0,0 +1,8 @@ +[tox] +envlist = py310 + +[flake8] +max-line-length = 160 + +[pycodestyle] +max-line-length = 160