From ffa939d1ee2789d40cc696b170cf85500d038810 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Fri, 21 Nov 2025 17:05:08 -0500 Subject: [PATCH 01/17] docs: Update TODO --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33d8cc1..b4e1135 100644 --- a/README.md +++ b/README.md @@ -7,5 +7,5 @@ Learning golang, writing a simple app to interface with an HTTP API and generate - [x] Fetch the category information for each category as well as the overall groups - [x] Compile a email-friendly report of the information - [x] Send the email to the desired parties via SMTP -- [ ] Write flake derivation +- [x] Write flake derivation - [ ] Write flake module and systemd service From 612a82390f899c3dde1ecd9db2ea123f46b19c1a Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Fri, 21 Nov 2025 23:53:25 -0500 Subject: [PATCH 02/17] chore: add nixosModule docs: add LICENSE --- LICENSE | 674 ++++++++++++++++++++++++ flake.nix | 8 +- main.go | 17 + modules/actualbudget-report/default.nix | 56 ++ 4 files changed, 750 insertions(+), 5 deletions(-) create mode 100644 LICENSE create mode 100644 modules/actualbudget-report/default.nix diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/flake.nix b/flake.nix index c441155..e9f61cc 100644 --- a/flake.nix +++ b/flake.nix @@ -15,6 +15,9 @@ "aarch64-darwin" "x86_64-darwin" ]; + flake.nixosModules = { + default = ./modules/actualbudget-report; + }; perSystem = { config, @@ -25,11 +28,6 @@ ... }: { - # Per-system attributes can be defined here. The self' and inputs' - # module parameters provide easy access to attributes of the same - # system. - - # Equivalent to inputs'.nixpkgs.legacyPackages.hello; packages.default = pkgs.buildGoModule { name = "actualbudget-report"; src = pkgs.fetchFromGitea { diff --git a/main.go b/main.go index 192b04a..a0bfcbb 100644 --- a/main.go +++ b/main.go @@ -1,3 +1,20 @@ +/* +Copyright (C) 2025 TheWanderingCrow + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + package main import ( diff --git a/modules/actualbudget-report/default.nix b/modules/actualbudget-report/default.nix new file mode 100644 index 0000000..d3e3763 --- /dev/null +++ b/modules/actualbudget-report/default.nix @@ -0,0 +1,56 @@ +{ + config, + options, + lib, + pkgs, + ... +}: +let + cfg = config.services.actualbudget-report; + opt = options.services.actualbudget-report; + inherit (lib) + mkEnableOption + mkOption + mkPackageOption + mkIf + types + ; +in +{ + options = { + services.actualbudget-report = { + enable = mkEnableOption "Actualbudget email reports"; + package = mkPackageOption pkgs.default; + interval = { + type = types.str; + default = "Sun 12:00:00"; + description = "systemd-timer OnCalendar legal string for sending reports."; + }; + environmentFile = mkOption { + type = types.path; + default = ""; + description = "environmentFile containing configuration secrets"; + }; + }; + }; + + config = mkIf cfg.enable { + systemd.services.actualbudget-report = { + description = "Actualbudget report sender service"; + serviceConfig = { + Type = "oneshot"; + ExecStart = "${cfg.package}/bin/actualbudget-report"; + EnvironmentFile = cfg.environmentFile; + }; + }; + systemd.timers.flamesite-backup = { + enable = true; + wantedBy = [ "timers.target" ]; + timerConfig = { + OnCalendar = cfg.interval; + Unit = "actualbudget-report.service"; + }; + }; + + }; +} From 63d37d295556235f47bed25284655f5849971b37 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 22 Nov 2025 15:30:41 -0500 Subject: [PATCH 03/17] chore: update sha256 --- flake.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flake.nix b/flake.nix index e9f61cc..60e139b 100644 --- a/flake.nix +++ b/flake.nix @@ -35,7 +35,7 @@ owner = "TheWanderingCrow"; repo = "actualbudget-report"; rev = "v0.1"; - hash = "sha256-Jf/cnYdAYTHOBSY0DmqMFqErxtBJmaUPBriBqALpc2Q="; + hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; From 599da9c3e6e560954e222b7b3ee958428a7088e1 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 22 Nov 2025 15:52:29 -0500 Subject: [PATCH 04/17] docs: update README with install instructions --- README.md | 41 +++++++++++++++++++++++++++++++---------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b4e1135..72a8e36 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,32 @@ -Learning golang, writing a simple app to interface with an HTTP API and generate emailable reports from an actualbudget instance +A simple Go service to generate and email reports on a schedule. -# TODO -- [x] Fetch the desired budget file -- [x] Change path to route in API caller -- [x] Trigger a bank sync and see if we can wait for it to finish (looks like it's a blocking call so we can safely sync before reports) -- [x] Fetch the category information for each category as well as the overall groups -- [x] Compile a email-friendly report of the information -- [x] Send the email to the desired parties via SMTP -- [x] Write flake derivation -- [ ] Write flake module and systemd service +# Installation (NixOS) +If you're using NixOS we provide a simple flake module: + +```nix +inputs.actualbudget-report.url = "git+https://git.wanderingcrow.net/TheWanderingCrow/actualbudget-report"; +``` + +Then in your configuration (using sops-nix, you will need to adjust it if you use agenix or alternatives): +```nix +imports = [ + inputs.actualbudget-report.nixosModules.default; +]; + +# Fill out all the following environment variables for the service +sops.templates."actualbudget-report-env".content = '' + BASE_URL= + API_KEY= + SYNC_ID= + SMTP_USERNAME= + SMTP_PASSWORD= + SMTP_HOST= + SMTP_RECIPIENTS= +''; + +services.actualbudget-report = { + enable = true; + interval = "Mon-Fri 12:00:00"; + environmentFile = config.sops.templates."actualbudget-report-env".path; +}; +``` From 100f8a52530d80a45a766f1bb441550c165f2e68 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 22 Nov 2025 17:49:14 -0500 Subject: [PATCH 05/17] docs: update README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 72a8e36..bad7a8b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ A simple Go service to generate and email reports on a schedule. +# Dependencies +This depends on https://github.com/jhonderson/actual-http-api to provide the API. Setup instructions can be found on that repo. + # Installation (NixOS) If you're using NixOS we provide a simple flake module: From a2232ef7dce4a548412651170402172fac5551b9 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 10:11:59 -0500 Subject: [PATCH 06/17] fix: Uncomment the budget sync functionality, handle recipients string properly --- main.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/main.go b/main.go index a0bfcbb..195a22a 100644 --- a/main.go +++ b/main.go @@ -144,9 +144,9 @@ func main() { var smtpHost = os.Getenv("SMTP_HOST") var smtpRecipients = os.Getenv("SMTP_RECIPIENTS") client := CreateBudgetClient(baseUrl, apiKey, syncId) - //if !client.BankSync() { - // log.Println("Bank Sync failed, information may not be up to date") - //} + if !client.BankSync() { + log.Println("Bank Sync failed, information may not be up to date") + } budgetMonths := client.GetBudgetMonths() subject := "Subject: Budget Report\n" @@ -182,7 +182,7 @@ func main() { } else { auth = smtp.PlainAuth("", smtpUsername, smtpPassword, smtpHost) } - err := smtp.SendMail(smtpHost, auth, smtpUsername, []string{smtpRecipients}, []byte(message)) + err := smtp.SendMail(smtpHost, auth, smtpUsername, strings.Split(smtpRecipients, ","), []byte(message)) if err != nil { log.Fatal(err) } From 0267945d0f53f92443d4c26359d84a9753c29f6f Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 10:11:59 -0500 Subject: [PATCH 07/17] chore: update .env.example to demonstrate recipients format --- .env.example | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.env.example b/.env.example index 10baf48..5a808c2 100644 --- a/.env.example +++ b/.env.example @@ -4,4 +4,4 @@ SMTP_USERNAME=demo@mailpit.nil SMTP_PASSWORD=nil SMTP_HOST=localhost:1025 - SMTP_RECIPIENTS= + SMTP_RECIPIENTS=example1@example.net,example2@example.net From d951f673c3ff424f20a6c89642c1cd9827feeb9b Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 10:54:18 -0500 Subject: [PATCH 08/17] chore: get devenv fully setup for working on the project --- .envrc | 13 +++- .gitignore | 22 ++++++ README.md | 4 + devenv.lock | 214 ++++++++++++++++++++++++++++++++++++++++++++++++++++ devenv.nix | 22 ++++++ devenv.yaml | 8 ++ flake.nix | 3 +- 7 files changed, 283 insertions(+), 3 deletions(-) create mode 100644 devenv.lock create mode 100644 devenv.nix create mode 100644 devenv.yaml diff --git a/.envrc b/.envrc index 3550a30..cc5c18b 100644 --- a/.envrc +++ b/.envrc @@ -1 +1,12 @@ -use flake +#!/usr/bin/env bash + +export DIRENV_WARN_TIMEOUT=20s + +eval "$(devenv direnvrc)" + +# `use devenv` supports the same options as the `devenv shell` command. +# +# To silence all output, use `--quiet`. +# +# Example usage: use devenv --quiet --impure --option services.postgres.enable:bool true +use devenv diff --git a/.gitignore b/.gitignore index a4534d5..1a4e12c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,25 @@ .direnv/ result .env + +# Devenv +.devenv* +devenv.local.nix +devenv.local.yaml + +# direnv +.direnv + +# pre-commit +.pre-commit-config.yaml + +# Devenv +.devenv* +devenv.local.nix +devenv.local.yaml + +# direnv +.direnv + +# pre-commit +.pre-commit-config.yaml diff --git a/README.md b/README.md index bad7a8b..14e047b 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,7 @@ services.actualbudget-report = { environmentFile = config.sops.templates."actualbudget-report-env".path; }; ``` + +# Development + +If you are on NixOS and have devenv installed, `devenv up -d` will spin up the mailpit instance and `devenv shell` will give you tools. If you do not have devenv it is provided in the devShell output at `nix shell` diff --git a/devenv.lock b/devenv.lock new file mode 100644 index 0000000..d2bd648 --- /dev/null +++ b/devenv.lock @@ -0,0 +1,214 @@ +{ + "nodes": { + "devenv": { + "locked": { + "dir": "src/modules", + "lastModified": 1766415291, + "owner": "cachix", + "repo": "devenv", + "rev": "445843843575c324f56f46e0a54c2fef1332f3cc", + "type": "github" + }, + "original": { + "dir": "src/modules", + "owner": "cachix", + "repo": "devenv", + "type": "github" + } + }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1765121682, + "owner": "edolstra", + "repo": "flake-compat", + "rev": "65f23138d8d09a92e30f1e5c87611b23ef451bf3", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-compat_2": { + "flake": false, + "locked": { + "lastModified": 1765121682, + "owner": "edolstra", + "repo": "flake-compat", + "rev": "65f23138d8d09a92e30f1e5c87611b23ef451bf3", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "git-hooks": { + "inputs": { + "flake-compat": "flake-compat", + "gitignore": "gitignore", + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1765911976, + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "b68b780b69702a090c8bb1b973bab13756cc7a27", + "type": "github" + }, + "original": { + "owner": "cachix", + "repo": "git-hooks.nix", + "type": "github" + } + }, + "git-hooks_2": { + "inputs": { + "flake-compat": "flake-compat_2", + "gitignore": "gitignore_2", + "nixpkgs": [ + "go-overlay", + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1765911976, + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "b68b780b69702a090c8bb1b973bab13756cc7a27", + "type": "github" + }, + "original": { + "owner": "cachix", + "repo": "git-hooks.nix", + "type": "github" + } + }, + "gitignore": { + "inputs": { + "nixpkgs": [ + "git-hooks", + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1762808025, + "owner": "hercules-ci", + "repo": "gitignore.nix", + "rev": "cb5e3fdca1de58ccbc3ef53de65bd372b48f567c", + "type": "github" + }, + "original": { + "owner": "hercules-ci", + "repo": "gitignore.nix", + "type": "github" + } + }, + "gitignore_2": { + "inputs": { + "nixpkgs": [ + "go-overlay", + "git-hooks", + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1762808025, + "owner": "hercules-ci", + "repo": "gitignore.nix", + "rev": "cb5e3fdca1de58ccbc3ef53de65bd372b48f567c", + "type": "github" + }, + "original": { + "owner": "hercules-ci", + "repo": "gitignore.nix", + "type": "github" + } + }, + "go-overlay": { + "inputs": { + "flake-utils": "flake-utils", + "git-hooks": "git-hooks_2", + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1766383731, + "owner": "purpleclay", + "repo": "go-overlay", + "rev": "36a0b6eb01220f9ad5e07d5ae8d8cb4879978421", + "type": "github" + }, + "original": { + "owner": "purpleclay", + "repo": "go-overlay", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1764580874, + "owner": "cachix", + "repo": "devenv-nixpkgs", + "rev": "dcf61356c3ab25f1362b4a4428a6d871e84f1d1d", + "type": "github" + }, + "original": { + "owner": "cachix", + "ref": "rolling", + "repo": "devenv-nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "devenv": "devenv", + "git-hooks": "git-hooks", + "go-overlay": "go-overlay", + "nixpkgs": "nixpkgs", + "pre-commit-hooks": [ + "git-hooks" + ] + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/devenv.nix b/devenv.nix new file mode 100644 index 0000000..3110c6c --- /dev/null +++ b/devenv.nix @@ -0,0 +1,22 @@ +{ + pkgs, + lib, + config, + inputs, + ... +}: + +{ + services.mailpit = { + enable = true; + smtpListenAddress = "127.0.0.1:1025"; + uiListenAddress = "127.0.0.1:8025"; + }; + + dotenv.enable = true; + + languages.go = { + enable = true; + version = "1.25.2"; + }; +} diff --git a/devenv.yaml b/devenv.yaml new file mode 100644 index 0000000..8030b4c --- /dev/null +++ b/devenv.yaml @@ -0,0 +1,8 @@ +inputs: + go-overlay: + url: github:purpleclay/go-overlay + inputs: + nixpkgs: + follows: nixpkgs + nixpkgs: + url: github:cachix/devenv-nixpkgs/rolling diff --git a/flake.nix b/flake.nix index 60e139b..5caf0c0 100644 --- a/flake.nix +++ b/flake.nix @@ -42,8 +42,7 @@ devShells.default = pkgs.mkShell { ENVIRONMENT = "dev"; nativeBuildInputs = with pkgs; [ - go - mailpit + devenv ]; }; }; From 72a425a76caaa77ab19ca34b5a9dda588f0fa796 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 12:03:21 -0500 Subject: [PATCH 09/17] chore: modify devenv --- devenv.nix | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/devenv.nix b/devenv.nix index 3110c6c..a33d6a3 100644 --- a/devenv.nix +++ b/devenv.nix @@ -13,7 +13,8 @@ uiListenAddress = "127.0.0.1:8025"; }; - dotenv.enable = true; + env.ENVIRONMENT = "dev"; + dotenv.disableHint = true; languages.go = { enable = true; From 6636a7cb3a9180d892de50f82e743bf82b002e5f Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 12:07:16 -0500 Subject: [PATCH 10/17] chore: bump release to v0.2 From 700659ff6011ab032331219f0c8f61f2fa8f2510 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Mon, 22 Dec 2025 15:12:22 -0500 Subject: [PATCH 11/17] fix: make module work and add instructions for using --- README.md | 2 + flake.nix | 84 ++++++++++++++----------- modules/actualbudget-report/default.nix | 12 ++-- 3 files changed, 54 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 14e047b..0bec688 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ inputs.actualbudget-report.url = "git+https://git.wanderingcrow.net/TheWandering Then in your configuration (using sops-nix, you will need to adjust it if you use agenix or alternatives): ```nix +nixpkgs.overlays = [ inputs.actualbudget-report.overlays.default ]; + imports = [ inputs.actualbudget-report.nixosModules.default; ]; diff --git a/flake.nix b/flake.nix index 5caf0c0..29ec137 100644 --- a/flake.nix +++ b/flake.nix @@ -7,44 +7,52 @@ }; outputs = - inputs@{ flake-parts, ... }: - flake-parts.lib.mkFlake { inherit inputs; } { - systems = [ - "x86_64-linux" - "aarch64-linux" - "aarch64-darwin" - "x86_64-darwin" - ]; - flake.nixosModules = { - default = ./modules/actualbudget-report; - }; - perSystem = - { - config, - self', - inputs', - pkgs, - system, - ... - }: - { - packages.default = pkgs.buildGoModule { - name = "actualbudget-report"; - src = pkgs.fetchFromGitea { - domain = "git.wanderingcrow.net"; - owner = "TheWanderingCrow"; - repo = "actualbudget-report"; - rev = "v0.1"; - hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + inputs@{ + self, + flake-parts, + ... + }: + flake-parts.lib.mkFlake + { + inherit inputs; + } + { + imports = [ inputs.flake-parts.flakeModules.easyOverlay ]; + systems = [ + "x86_64-linux" + "aarch64-linux" + "aarch64-darwin" + "x86_64-darwin" + ]; + flake.nixosModules.default = ./modules/actualbudget-report; + perSystem = + { + config, + self', + inputs', + pkgs, + system, + ... + }: + { + overlayAttrs = { inherit (config.packages) actualbudget-report; }; + packages.actualbudget-report = pkgs.buildGoModule { + name = "actualbudget-report"; + src = pkgs.fetchFromGitea { + domain = "git.wanderingcrow.net"; + owner = "TheWanderingCrow"; + repo = "actualbudget-report"; + rev = "v0.1"; + hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + }; + vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; + }; + devShells.default = pkgs.mkShell { + ENVIRONMENT = "dev"; + nativeBuildInputs = with pkgs; [ + devenv + ]; }; - vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; - devShells.default = pkgs.mkShell { - ENVIRONMENT = "dev"; - nativeBuildInputs = with pkgs; [ - devenv - ]; - }; - }; - }; + }; } diff --git a/modules/actualbudget-report/default.nix b/modules/actualbudget-report/default.nix index d3e3763..c856982 100644 --- a/modules/actualbudget-report/default.nix +++ b/modules/actualbudget-report/default.nix @@ -1,8 +1,8 @@ { + pkgs, config, options, lib, - pkgs, ... }: let @@ -10,8 +10,8 @@ let opt = options.services.actualbudget-report; inherit (lib) mkEnableOption - mkOption mkPackageOption + mkOption mkIf types ; @@ -20,12 +20,12 @@ in options = { services.actualbudget-report = { enable = mkEnableOption "Actualbudget email reports"; - package = mkPackageOption pkgs.default; - interval = { + interval = mkOption { type = types.str; default = "Sun 12:00:00"; description = "systemd-timer OnCalendar legal string for sending reports."; }; + package = mkPackageOption pkgs "actualbudget-report" { }; environmentFile = mkOption { type = types.path; default = ""; @@ -39,11 +39,11 @@ in description = "Actualbudget report sender service"; serviceConfig = { Type = "oneshot"; - ExecStart = "${cfg.package}/bin/actualbudget-report"; + ExecStart = "${pkgs.actualbudget-report}/bin/actualbudget-report"; EnvironmentFile = cfg.environmentFile; }; }; - systemd.timers.flamesite-backup = { + systemd.timers.actualbudget-report = { enable = true; wantedBy = [ "timers.target" ]; timerConfig = { From 6eb0beb355259b8a7ef29202508b605dc97a61fc Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 10:45:31 -0500 Subject: [PATCH 12/17] add support for encryption key protected budget files --- README.md | 1 + main.go | 23 +++++++++++++++-------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0bec688..2829f18 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ sops.templates."actualbudget-report-env".content = '' SMTP_PASSWORD= SMTP_HOST= SMTP_RECIPIENTS= + BUDGET_ENCRYPTION_KEY= ''; services.actualbudget-report = { diff --git a/main.go b/main.go index 195a22a..945591e 100644 --- a/main.go +++ b/main.go @@ -32,10 +32,11 @@ import ( ) type BudgetClient struct { - baseUrl string - apiKey string - syncId string - fullUrl string + baseUrl string + apiKey string + syncId string + fullUrl string + encryptionKey string } type BudgetMonthsResponse struct { @@ -73,9 +74,12 @@ type BudgetMonthsResponse struct { } `json:"data"` } -func CreateBudgetClient(baseUrl string, apiKey string, syncId string) *BudgetClient { +// Create budget client, you may pass empty strings to optional parameters +// Required: baseUrl, apiKey, syncId +// Optional: encryptionKey +func CreateBudgetClient(baseUrl string, apiKey string, syncId string, encryptionKey string) *BudgetClient { fullUrl := baseUrl + "/v1/budgets/" + syncId - client := BudgetClient{baseUrl, apiKey, syncId, fullUrl} + client := BudgetClient{baseUrl, apiKey, syncId, fullUrl, encryptionKey} return &client } @@ -111,7 +115,9 @@ func (b BudgetClient) GetBudgetMonths() *BudgetMonthsResponse { currentTime := time.Now() year, month := currentTime.Year(), int(currentTime.Month()) budgetMonth := fmt.Sprintf("%v-%v", year, month) - resp := b.callApi("GET", "/months/"+budgetMonth, nil) + resp := b.callApi("GET", "/months/"+budgetMonth, map[string]string{ + "budget-encryption-password": b.encryptionKey, + }) defer resp.Body.Close() if resp.StatusCode != http.StatusOK { log.Fatal("GetBudgetAmounts failed with: " + string(resp.Status)) @@ -139,11 +145,12 @@ func main() { var baseUrl = os.Getenv("BASE_URL") var apiKey = os.Getenv("API_KEY") var syncId = os.Getenv("SYNC_ID") + var encryptionKey = os.Getenv("BUDGET_ENCRYPTION_KEY") var smtpUsername = os.Getenv("SMTP_USERNAME") var smtpPassword = os.Getenv("SMTP_PASSWORD") var smtpHost = os.Getenv("SMTP_HOST") var smtpRecipients = os.Getenv("SMTP_RECIPIENTS") - client := CreateBudgetClient(baseUrl, apiKey, syncId) + client := CreateBudgetClient(baseUrl, apiKey, syncId, encryptionKey) if !client.BankSync() { log.Println("Bank Sync failed, information may not be up to date") } From ae765605d9fce350c3773abb6b14bbd2c67d95c5 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 10:49:42 -0500 Subject: [PATCH 13/17] chore: release v1.0 --- flake.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flake.nix b/flake.nix index 29ec137..a07b5a6 100644 --- a/flake.nix +++ b/flake.nix @@ -42,8 +42,8 @@ domain = "git.wanderingcrow.net"; owner = "TheWanderingCrow"; repo = "actualbudget-report"; - rev = "v0.1"; - hash = "sha256-1Z3+Efx0MCsZhfz49nKsdaWgyVt9+7kekwgfQyaYUxQ="; + rev = "v1.0"; + hash = "sha256-MP2JRBls5rqUZOMmb8BD60jcLwGgvGRAAixWxMttNhA="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; From 00104dc59a91875835e98fff123608fb55397874 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Sat, 27 Dec 2025 11:04:02 -0500 Subject: [PATCH 14/17] docs: fix syntax error in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2829f18..4d5e23d 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Then in your configuration (using sops-nix, you will need to adjust it if you us nixpkgs.overlays = [ inputs.actualbudget-report.overlays.default ]; imports = [ - inputs.actualbudget-report.nixosModules.default; + inputs.actualbudget-report.nixosModules.default ]; # Fill out all the following environment variables for the service From 43d4e6caee531c8ad1a0bb4f54ae4e0470b72331 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:20:52 -0500 Subject: [PATCH 15/17] chore: update sha256 --- flake.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/flake.nix b/flake.nix index a07b5a6..1db92a9 100644 --- a/flake.nix +++ b/flake.nix @@ -43,7 +43,7 @@ owner = "TheWanderingCrow"; repo = "actualbudget-report"; rev = "v1.0"; - hash = "sha256-MP2JRBls5rqUZOMmb8BD60jcLwGgvGRAAixWxMttNhA="; + hash = "sha256-rt4wiSzsNqmSWGoMBf6fiNpCxZfEPwYlZuClLI+s+A4="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; }; From 1c1b2a3a1d1475a1b04a6a4e37b9d484ae19518a Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:49:28 -0500 Subject: [PATCH 16/17] fix!: SMTP now works properly in non-dev environments --- main.go | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/main.go b/main.go index 945591e..38d12d0 100644 --- a/main.go +++ b/main.go @@ -149,6 +149,7 @@ func main() { var smtpUsername = os.Getenv("SMTP_USERNAME") var smtpPassword = os.Getenv("SMTP_PASSWORD") var smtpHost = os.Getenv("SMTP_HOST") + var smtpPort = os.Getenv("SMTP_PORT") var smtpRecipients = os.Getenv("SMTP_RECIPIENTS") client := CreateBudgetClient(baseUrl, apiKey, syncId, encryptionKey) if !client.BankSync() { @@ -184,12 +185,8 @@ func main() { message := []byte(subject + mime + body + categories.String()) var auth smtp.Auth - if os.Getenv("ENVIRONMENT") == "dev" { - auth = nil - } else { - auth = smtp.PlainAuth("", smtpUsername, smtpPassword, smtpHost) - } - err := smtp.SendMail(smtpHost, auth, smtpUsername, strings.Split(smtpRecipients, ","), []byte(message)) + auth = smtp.PlainAuth("", smtpUsername, smtpPassword, smtpHost) + err := smtp.SendMail(smtpHost+":"+smtpPort, auth, smtpUsername, strings.Split(smtpRecipients, ","), []byte(message)) if err != nil { log.Fatal(err) } From 586e336cb885cbc87d2f296e995590385e9d60d9 Mon Sep 17 00:00:00 2001 From: TheWanderingCrow Date: Tue, 30 Dec 2025 21:52:15 -0500 Subject: [PATCH 17/17] chore: release v2.0 --- flake.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flake.nix b/flake.nix index 1db92a9..21fc84e 100644 --- a/flake.nix +++ b/flake.nix @@ -42,8 +42,8 @@ domain = "git.wanderingcrow.net"; owner = "TheWanderingCrow"; repo = "actualbudget-report"; - rev = "v1.0"; - hash = "sha256-rt4wiSzsNqmSWGoMBf6fiNpCxZfEPwYlZuClLI+s+A4="; + rev = "v2.0"; + hash = "sha256-H+pA9dFsP5QQ3W32NEU1TWYiOiti53jnzN3Bnq+QJ5Q="; }; vendorHash = "sha256-NHTKwUSIbNCUco88JbHOo3gt6S37ggee+LWNbHaRGEs="; };