GITGUD

neiam neiam /ppl

public · Issues · Pulls · Labels · Forks · Compare · Actions failure · Badges · Packages

⭐

Log in to mark this repository.

other stuff

43c1e4a · gmorell · 2026-01-18 22:55

7 files +1057 -8

Files changed

modified Cargo.toml
+26 −3
@@ -2,10 +2,27 @@
2 2 name = "ppl"
3 3 version = "0.1.0"
4 4 edition = "2021"
5 +description = "A nanocalendar"
6 +authors = ["Gabe <gabe@neiam.org>"]
7 +license = "GPLv3"
5 8
6 −[lints.clippy]
7 −upper_case_acronyms = "allow"
8 −large_enum_variant = "allow"
9 +
10 +[package.metadata.deb]
11 +assets = [
12 + # target/release path is special, and gets replaced by cargo-deb with the actual target dir path.
13 + ["target/release/ppl", "usr/bin/", "755"],
14 + { source = "LICENSE.md", dest = "/usr/share/doc/neiam-ppl/LICENSE", doc = true, mode = "0644" },
15 + { source = "README.md", dest = "/usr/share/doc/neiam-ppl/README.md", doc = true, mode = "0644" },
16 +]
17 +section = "utility"
18 +license-file = ["LICENSE.md", "4"]
19 +
20 +[package.metadata.generate-rpm]
21 +assets = [
22 + { source = "target/release/ppl", dest = "/usr/bin/ppl", mode = "0755" },
23 + { source = "LICENSE.md", dest = "/usr/share/doc/neiam-ppl/LICENSE", doc = true, mode = "0644" },
24 + { source = "README.md", dest = "/usr/share/doc/neiam-ppl/README.md", doc = true, mode = "0644" },
25 +]
9 26
10 27 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
11 28
@@ -37,3 +54,9 @@ time = "0.3.37"
37 54 itertools = "0.12.0"
38 55 xdg = "2.5.2"
39 56 serde_json = "1.0.149"
57 +
58 +
59 +[lints.clippy]
60 +upper_case_acronyms = "allow"
61 +large_enum_variant = "allow"
62 +too_many_arguments = "allow"
added LICENSE.md
+675 −0
@@ -0,0 +1,675 @@
1 +# GNU GENERAL PUBLIC LICENSE
2 +
3 +Version 3, 29 June 2007
4 +
5 +Copyright (C) 2007 Free Software Foundation, Inc.
6 +<https://fsf.org/>
7 +
8 +Everyone is permitted to copy and distribute verbatim copies of this
9 +license document, but changing it is not allowed.
10 +
11 +## Preamble
12 +
13 +The GNU General Public License is a free, copyleft license for
14 +software and other kinds of works.
15 +
16 +The licenses for most software and other practical works are designed
17 +to take away your freedom to share and change the works. By contrast,
18 +the GNU General Public License is intended to guarantee your freedom
19 +to share and change all versions of a program--to make sure it remains
20 +free software for all its users. We, the Free Software Foundation, use
21 +the GNU General Public License for most of our software; it applies
22 +also to any other work released this way by its authors. You can apply
23 +it to your programs, too.
24 +
25 +When we speak of free software, we are referring to freedom, not
26 +price. Our General Public Licenses are designed to make sure that you
27 +have the freedom to distribute copies of free software (and charge for
28 +them if you wish), that you receive source code or can get it if you
29 +want it, that you can change the software or use pieces of it in new
30 +free programs, and that you know you can do these things.
31 +
32 +To protect your rights, we need to prevent others from denying you
33 +these rights or asking you to surrender the rights. Therefore, you
34 +have certain responsibilities if you distribute copies of the
35 +software, or if you modify it: responsibilities to respect the freedom
36 +of others.
37 +
38 +For example, if you distribute copies of such a program, whether
39 +gratis or for a fee, you must pass on to the recipients the same
40 +freedoms that you received. You must make sure that they, too, receive
41 +or can get the source code. And you must show them these terms so they
42 +know their rights.
43 +
44 +Developers that use the GNU GPL protect your rights with two steps:
45 +(1) assert copyright on the software, and (2) offer you this License
46 +giving you legal permission to copy, distribute and/or modify it.
47 +
48 +For the developers' and authors' protection, the GPL clearly explains
49 +that there is no warranty for this free software. For both users' and
50 +authors' sake, the GPL requires that modified versions be marked as
51 +changed, so that their problems will not be attributed erroneously to
52 +authors of previous versions.
53 +
54 +Some devices are designed to deny users access to install or run
55 +modified versions of the software inside them, although the
56 +manufacturer can do so. This is fundamentally incompatible with the
57 +aim of protecting users' freedom to change the software. The
58 +systematic pattern of such abuse occurs in the area of products for
59 +individuals to use, which is precisely where it is most unacceptable.
60 +Therefore, we have designed this version of the GPL to prohibit the
61 +practice for those products. If such problems arise substantially in
62 +other domains, we stand ready to extend this provision to those
63 +domains in future versions of the GPL, as needed to protect the
64 +freedom of users.
65 +
66 +Finally, every program is threatened constantly by software patents.
67 +States should not allow patents to restrict development and use of
68 +software on general-purpose computers, but in those that do, we wish
69 +to avoid the special danger that patents applied to a free program
70 +could make it effectively proprietary. To prevent this, the GPL
71 +assures that patents cannot be used to render the program non-free.
72 +
73 +The precise terms and conditions for copying, distribution and
74 +modification follow.
75 +
76 +## TERMS AND CONDITIONS
77 +
78 +### 0. Definitions.
79 +
80 +"This License" refers to version 3 of the GNU General Public License.
81 +
82 +"Copyright" also means copyright-like laws that apply to other kinds
83 +of works, such as semiconductor masks.
84 +
85 +"The Program" refers to any copyrightable work licensed under this
86 +License. Each licensee is addressed as "you". "Licensees" and
87 +"recipients" may be individuals or organizations.
88 +
89 +To "modify" a work means to copy from or adapt all or part of the work
90 +in a fashion requiring copyright permission, other than the making of
91 +an exact copy. The resulting work is called a "modified version" of
92 +the earlier work or a work "based on" the earlier work.
93 +
94 +A "covered work" means either the unmodified Program or a work based
95 +on the Program.
96 +
97 +To "propagate" a work means to do anything with it that, without
98 +permission, would make you directly or secondarily liable for
99 +infringement under applicable copyright law, except executing it on a
100 +computer or modifying a private copy. Propagation includes copying,
101 +distribution (with or without modification), making available to the
102 +public, and in some countries other activities as well.
103 +
104 +To "convey" a work means any kind of propagation that enables other
105 +parties to make or receive copies. Mere interaction with a user
106 +through a computer network, with no transfer of a copy, is not
107 +conveying.
108 +
109 +An interactive user interface displays "Appropriate Legal Notices" to
110 +the extent that it includes a convenient and prominently visible
111 +feature that (1) displays an appropriate copyright notice, and (2)
112 +tells the user that there is no warranty for the work (except to the
113 +extent that warranties are provided), that licensees may convey the
114 +work under this License, and how to view a copy of this License. If
115 +the interface presents a list of user commands or options, such as a
116 +menu, a prominent item in the list meets this criterion.
117 +
118 +### 1. Source Code.
119 +
120 +The "source code" for a work means the preferred form of the work for
121 +making modifications to it. "Object code" means any non-source form of
122 +a work.
123 +
124 +A "Standard Interface" means an interface that either is an official
125 +standard defined by a recognized standards body, or, in the case of
126 +interfaces specified for a particular programming language, one that
127 +is widely used among developers working in that language.
128 +
129 +The "System Libraries" of an executable work include anything, other
130 +than the work as a whole, that (a) is included in the normal form of
131 +packaging a Major Component, but which is not part of that Major
132 +Component, and (b) serves only to enable use of the work with that
133 +Major Component, or to implement a Standard Interface for which an
134 +implementation is available to the public in source code form. A
135 +"Major Component", in this context, means a major essential component
136 +(kernel, window system, and so on) of the specific operating system
137 +(if any) on which the executable work runs, or a compiler used to
138 +produce the work, or an object code interpreter used to run it.
139 +
140 +The "Corresponding Source" for a work in object code form means all
141 +the source code needed to generate, install, and (for an executable
142 +work) run the object code and to modify the work, including scripts to
143 +control those activities. However, it does not include the work's
144 +System Libraries, or general-purpose tools or generally available free
145 +programs which are used unmodified in performing those activities but
146 +which are not part of the work. For example, Corresponding Source
147 +includes interface definition files associated with source files for
148 +the work, and the source code for shared libraries and dynamically
149 +linked subprograms that the work is specifically designed to require,
150 +such as by intimate data communication or control flow between those
151 +subprograms and other parts of the work.
152 +
153 +The Corresponding Source need not include anything that users can
154 +regenerate automatically from other parts of the Corresponding Source.
155 +
156 +The Corresponding Source for a work in source code form is that same
157 +work.
158 +
159 +### 2. Basic Permissions.
160 +
161 +All rights granted under this License are granted for the term of
162 +copyright on the Program, and are irrevocable provided the stated
163 +conditions are met. This License explicitly affirms your unlimited
164 +permission to run the unmodified Program. The output from running a
165 +covered work is covered by this License only if the output, given its
166 +content, constitutes a covered work. This License acknowledges your
167 +rights of fair use or other equivalent, as provided by copyright law.
168 +
169 +You may make, run and propagate covered works that you do not convey,
170 +without conditions so long as your license otherwise remains in force.
171 +You may convey covered works to others for the sole purpose of having
172 +them make modifications exclusively for you, or provide you with
173 +facilities for running those works, provided that you comply with the
174 +terms of this License in conveying all material for which you do not
175 +control copyright. Those thus making or running the covered works for
176 +you must do so exclusively on your behalf, under your direction and
177 +control, on terms that prohibit them from making any copies of your
178 +copyrighted material outside their relationship with you.
179 +
180 +Conveying under any other circumstances is permitted solely under the
181 +conditions stated below. Sublicensing is not allowed; section 10 makes
182 +it unnecessary.
183 +
184 +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
185 +
186 +No covered work shall be deemed part of an effective technological
187 +measure under any applicable law fulfilling obligations under article
188 +11 of the WIPO copyright treaty adopted on 20 December 1996, or
189 +similar laws prohibiting or restricting circumvention of such
190 +measures.
191 +
192 +When you convey a covered work, you waive any legal power to forbid
193 +circumvention of technological measures to the extent such
194 +circumvention is effected by exercising rights under this License with
195 +respect to the covered work, and you disclaim any intention to limit
196 +operation or modification of the work as a means of enforcing, against
197 +the work's users, your or third parties' legal rights to forbid
198 +circumvention of technological measures.
199 +
200 +### 4. Conveying Verbatim Copies.
201 +
202 +You may convey verbatim copies of the Program's source code as you
203 +receive it, in any medium, provided that you conspicuously and
204 +appropriately publish on each copy an appropriate copyright notice;
205 +keep intact all notices stating that this License and any
206 +non-permissive terms added in accord with section 7 apply to the code;
207 +keep intact all notices of the absence of any warranty; and give all
208 +recipients a copy of this License along with the Program.
209 +
210 +You may charge any price or no price for each copy that you convey,
211 +and you may offer support or warranty protection for a fee.
212 +
213 +### 5. Conveying Modified Source Versions.
214 +
215 +You may convey a work based on the Program, or the modifications to
216 +produce it from the Program, in the form of source code under the
217 +terms of section 4, provided that you also meet all of these
218 +conditions:
219 +
220 +- a) The work must carry prominent notices stating that you modified
221 + it, and giving a relevant date.
222 +- b) The work must carry prominent notices stating that it is
223 + released under this License and any conditions added under
224 + section 7. This requirement modifies the requirement in section 4
225 + to "keep intact all notices".
226 +- c) You must license the entire work, as a whole, under this
227 + License to anyone who comes into possession of a copy. This
228 + License will therefore apply, along with any applicable section 7
229 + additional terms, to the whole of the work, and all its parts,
230 + regardless of how they are packaged. This License gives no
231 + permission to license the work in any other way, but it does not
232 + invalidate such permission if you have separately received it.
233 +- d) If the work has interactive user interfaces, each must display
234 + Appropriate Legal Notices; however, if the Program has interactive
235 + interfaces that do not display Appropriate Legal Notices, your
236 + work need not make them do so.
237 +
238 +A compilation of a covered work with other separate and independent
239 +works, which are not by their nature extensions of the covered work,
240 +and which are not combined with it such as to form a larger program,
241 +in or on a volume of a storage or distribution medium, is called an
242 +"aggregate" if the compilation and its resulting copyright are not
243 +used to limit the access or legal rights of the compilation's users
244 +beyond what the individual works permit. Inclusion of a covered work
245 +in an aggregate does not cause this License to apply to the other
246 +parts of the aggregate.
247 +
248 +### 6. Conveying Non-Source Forms.
249 +
250 +You may convey a covered work in object code form under the terms of
251 +sections 4 and 5, provided that you also convey the machine-readable
252 +Corresponding Source under the terms of this License, in one of these
253 +ways:
254 +
255 +- a) Convey the object code in, or embodied in, a physical product
256 + (including a physical distribution medium), accompanied by the
257 + Corresponding Source fixed on a durable physical medium
258 + customarily used for software interchange.
259 +- b) Convey the object code in, or embodied in, a physical product
260 + (including a physical distribution medium), accompanied by a
261 + written offer, valid for at least three years and valid for as
262 + long as you offer spare parts or customer support for that product
263 + model, to give anyone who possesses the object code either (1) a
264 + copy of the Corresponding Source for all the software in the
265 + product that is covered by this License, on a durable physical
266 + medium customarily used for software interchange, for a price no
267 + more than your reasonable cost of physically performing this
268 + conveying of source, or (2) access to copy the Corresponding
269 + Source from a network server at no charge.
270 +- c) Convey individual copies of the object code with a copy of the
271 + written offer to provide the Corresponding Source. This
272 + alternative is allowed only occasionally and noncommercially, and
273 + only if you received the object code with such an offer, in accord
274 + with subsection 6b.
275 +- d) Convey the object code by offering access from a designated
276 + place (gratis or for a charge), and offer equivalent access to the
277 + Corresponding Source in the same way through the same place at no
278 + further charge. You need not require recipients to copy the
279 + Corresponding Source along with the object code. If the place to
280 + copy the object code is a network server, the Corresponding Source
281 + may be on a different server (operated by you or a third party)
282 + that supports equivalent copying facilities, provided you maintain
283 + clear directions next to the object code saying where to find the
284 + Corresponding Source. Regardless of what server hosts the
285 + Corresponding Source, you remain obligated to ensure that it is
286 + available for as long as needed to satisfy these requirements.
287 +- e) Convey the object code using peer-to-peer transmission,
288 + provided you inform other peers where the object code and
289 + Corresponding Source of the work are being offered to the general
290 + public at no charge under subsection 6d.
291 +
292 +A separable portion of the object code, whose source code is excluded
293 +from the Corresponding Source as a System Library, need not be
294 +included in conveying the object code work.
295 +
296 +A "User Product" is either (1) a "consumer product", which means any
297 +tangible personal property which is normally used for personal,
298 +family, or household purposes, or (2) anything designed or sold for
299 +incorporation into a dwelling. In determining whether a product is a
300 +consumer product, doubtful cases shall be resolved in favor of
301 +coverage. For a particular product received by a particular user,
302 +"normally used" refers to a typical or common use of that class of
303 +product, regardless of the status of the particular user or of the way
304 +in which the particular user actually uses, or expects or is expected
305 +to use, the product. A product is a consumer product regardless of
306 +whether the product has substantial commercial, industrial or
307 +non-consumer uses, unless such uses represent the only significant
308 +mode of use of the product.
309 +
310 +"Installation Information" for a User Product means any methods,
311 +procedures, authorization keys, or other information required to
312 +install and execute modified versions of a covered work in that User
313 +Product from a modified version of its Corresponding Source. The
314 +information must suffice to ensure that the continued functioning of
315 +the modified object code is in no case prevented or interfered with
316 +solely because modification has been made.
317 +
318 +If you convey an object code work under this section in, or with, or
319 +specifically for use in, a User Product, and the conveying occurs as
320 +part of a transaction in which the right of possession and use of the
321 +User Product is transferred to the recipient in perpetuity or for a
322 +fixed term (regardless of how the transaction is characterized), the
323 +Corresponding Source conveyed under this section must be accompanied
324 +by the Installation Information. But this requirement does not apply
325 +if neither you nor any third party retains the ability to install
326 +modified object code on the User Product (for example, the work has
327 +been installed in ROM).
328 +
329 +The requirement to provide Installation Information does not include a
330 +requirement to continue to provide support service, warranty, or
331 +updates for a work that has been modified or installed by the
332 +recipient, or for the User Product in which it has been modified or
333 +installed. Access to a network may be denied when the modification
334 +itself materially and adversely affects the operation of the network
335 +or violates the rules and protocols for communication across the
336 +network.
337 +
338 +Corresponding Source conveyed, and Installation Information provided,
339 +in accord with this section must be in a format that is publicly
340 +documented (and with an implementation available to the public in
341 +source code form), and must require no special password or key for
342 +unpacking, reading or copying.
343 +
344 +### 7. Additional Terms.
345 +
346 +"Additional permissions" are terms that supplement the terms of this
347 +License by making exceptions from one or more of its conditions.
348 +Additional permissions that are applicable to the entire Program shall
349 +be treated as though they were included in this License, to the extent
350 +that they are valid under applicable law. If additional permissions
351 +apply only to part of the Program, that part may be used separately
352 +under those permissions, but the entire Program remains governed by
353 +this License without regard to the additional permissions.
354 +
355 +When you convey a copy of a covered work, you may at your option
356 +remove any additional permissions from that copy, or from any part of
357 +it. (Additional permissions may be written to require their own
358 +removal in certain cases when you modify the work.) You may place
359 +additional permissions on material, added by you to a covered work,
360 +for which you have or can give appropriate copyright permission.
361 +
362 +Notwithstanding any other provision of this License, for material you
363 +add to a covered work, you may (if authorized by the copyright holders
364 +of that material) supplement the terms of this License with terms:
365 +
366 +- a) Disclaiming warranty or limiting liability differently from the
367 + terms of sections 15 and 16 of this License; or
368 +- b) Requiring preservation of specified reasonable legal notices or
369 + author attributions in that material or in the Appropriate Legal
370 + Notices displayed by works containing it; or
371 +- c) Prohibiting misrepresentation of the origin of that material,
372 + or requiring that modified versions of such material be marked in
373 + reasonable ways as different from the original version; or
374 +- d) Limiting the use for publicity purposes of names of licensors
375 + or authors of the material; or
376 +- e) Declining to grant rights under trademark law for use of some
377 + trade names, trademarks, or service marks; or
378 +- f) Requiring indemnification of licensors and authors of that
379 + material by anyone who conveys the material (or modified versions
380 + of it) with contractual assumptions of liability to the recipient,
381 + for any liability that these contractual assumptions directly
382 + impose on those licensors and authors.
383 +
384 +All other non-permissive additional terms are considered "further
385 +restrictions" within the meaning of section 10. If the Program as you
386 +received it, or any part of it, contains a notice stating that it is
387 +governed by this License along with a term that is a further
388 +restriction, you may remove that term. If a license document contains
389 +a further restriction but permits relicensing or conveying under this
390 +License, you may add to a covered work material governed by the terms
391 +of that license document, provided that the further restriction does
392 +not survive such relicensing or conveying.
393 +
394 +If you add terms to a covered work in accord with this section, you
395 +must place, in the relevant source files, a statement of the
396 +additional terms that apply to those files, or a notice indicating
397 +where to find the applicable terms.
398 +
399 +Additional terms, permissive or non-permissive, may be stated in the
400 +form of a separately written license, or stated as exceptions; the
401 +above requirements apply either way.
402 +
403 +### 8. Termination.
404 +
405 +You may not propagate or modify a covered work except as expressly
406 +provided under this License. Any attempt otherwise to propagate or
407 +modify it is void, and will automatically terminate your rights under
408 +this License (including any patent licenses granted under the third
409 +paragraph of section 11).
410 +
411 +However, if you cease all violation of this License, then your license
412 +from a particular copyright holder is reinstated (a) provisionally,
413 +unless and until the copyright holder explicitly and finally
414 +terminates your license, and (b) permanently, if the copyright holder
415 +fails to notify you of the violation by some reasonable means prior to
416 +60 days after the cessation.
417 +
418 +Moreover, your license from a particular copyright holder is
419 +reinstated permanently if the copyright holder notifies you of the
420 +violation by some reasonable means, this is the first time you have
421 +received notice of violation of this License (for any work) from that
422 +copyright holder, and you cure the violation prior to 30 days after
423 +your receipt of the notice.
424 +
425 +Termination of your rights under this section does not terminate the
426 +licenses of parties who have received copies or rights from you under
427 +this License. If your rights have been terminated and not permanently
428 +reinstated, you do not qualify to receive new licenses for the same
429 +material under section 10.
430 +
431 +### 9. Acceptance Not Required for Having Copies.
432 +
433 +You are not required to accept this License in order to receive or run
434 +a copy of the Program. Ancillary propagation of a covered work
435 +occurring solely as a consequence of using peer-to-peer transmission
436 +to receive a copy likewise does not require acceptance. However,
437 +nothing other than this License grants you permission to propagate or
438 +modify any covered work. These actions infringe copyright if you do
439 +not accept this License. Therefore, by modifying or propagating a
440 +covered work, you indicate your acceptance of this License to do so.
441 +
442 +### 10. Automatic Licensing of Downstream Recipients.
443 +
444 +Each time you convey a covered work, the recipient automatically
445 +receives a license from the original licensors, to run, modify and
446 +propagate that work, subject to this License. You are not responsible
447 +for enforcing compliance by third parties with this License.
448 +
449 +An "entity transaction" is a transaction transferring control of an
450 +organization, or substantially all assets of one, or subdividing an
451 +organization, or merging organizations. If propagation of a covered
452 +work results from an entity transaction, each party to that
453 +transaction who receives a copy of the work also receives whatever
454 +licenses to the work the party's predecessor in interest had or could
455 +give under the previous paragraph, plus a right to possession of the
456 +Corresponding Source of the work from the predecessor in interest, if
457 +the predecessor has it or can get it with reasonable efforts.
458 +
459 +You may not impose any further restrictions on the exercise of the
460 +rights granted or affirmed under this License. For example, you may
461 +not impose a license fee, royalty, or other charge for exercise of
462 +rights granted under this License, and you may not initiate litigation
463 +(including a cross-claim or counterclaim in a lawsuit) alleging that
464 +any patent claim is infringed by making, using, selling, offering for
465 +sale, or importing the Program or any portion of it.
466 +
467 +### 11. Patents.
468 +
469 +A "contributor" is a copyright holder who authorizes use under this
470 +License of the Program or a work on which the Program is based. The
471 +work thus licensed is called the contributor's "contributor version".
472 +
473 +A contributor's "essential patent claims" are all patent claims owned
474 +or controlled by the contributor, whether already acquired or
475 +hereafter acquired, that would be infringed by some manner, permitted
476 +by this License, of making, using, or selling its contributor version,
477 +but do not include claims that would be infringed only as a
478 +consequence of further modification of the contributor version. For
479 +purposes of this definition, "control" includes the right to grant
480 +patent sublicenses in a manner consistent with the requirements of
481 +this License.
482 +
483 +Each contributor grants you a non-exclusive, worldwide, royalty-free
484 +patent license under the contributor's essential patent claims, to
485 +make, use, sell, offer for sale, import and otherwise run, modify and
486 +propagate the contents of its contributor version.
487 +
488 +In the following three paragraphs, a "patent license" is any express
489 +agreement or commitment, however denominated, not to enforce a patent
490 +(such as an express permission to practice a patent or covenant not to
491 +sue for patent infringement). To "grant" such a patent license to a
492 +party means to make such an agreement or commitment not to enforce a
493 +patent against the party.
494 +
495 +If you convey a covered work, knowingly relying on a patent license,
496 +and the Corresponding Source of the work is not available for anyone
497 +to copy, free of charge and under the terms of this License, through a
498 +publicly available network server or other readily accessible means,
499 +then you must either (1) cause the Corresponding Source to be so
500 +available, or (2) arrange to deprive yourself of the benefit of the
501 +patent license for this particular work, or (3) arrange, in a manner
502 +consistent with the requirements of this License, to extend the patent
503 +license to downstream recipients. "Knowingly relying" means you have
504 +actual knowledge that, but for the patent license, your conveying the
505 +covered work in a country, or your recipient's use of the covered work
506 +in a country, would infringe one or more identifiable patents in that
507 +country that you have reason to believe are valid.
508 +
509 +If, pursuant to or in connection with a single transaction or
510 +arrangement, you convey, or propagate by procuring conveyance of, a
511 +covered work, and grant a patent license to some of the parties
512 +receiving the covered work authorizing them to use, propagate, modify
513 +or convey a specific copy of the covered work, then the patent license
514 +you grant is automatically extended to all recipients of the covered
515 +work and works based on it.
516 +
517 +A patent license is "discriminatory" if it does not include within the
518 +scope of its coverage, prohibits the exercise of, or is conditioned on
519 +the non-exercise of one or more of the rights that are specifically
520 +granted under this License. You may not convey a covered work if you
521 +are a party to an arrangement with a third party that is in the
522 +business of distributing software, under which you make payment to the
523 +third party based on the extent of your activity of conveying the
524 +work, and under which the third party grants, to any of the parties
525 +who would receive the covered work from you, a discriminatory patent
526 +license (a) in connection with copies of the covered work conveyed by
527 +you (or copies made from those copies), or (b) primarily for and in
528 +connection with specific products or compilations that contain the
529 +covered work, unless you entered into that arrangement, or that patent
530 +license was granted, prior to 28 March 2007.
531 +
532 +Nothing in this License shall be construed as excluding or limiting
533 +any implied license or other defenses to infringement that may
534 +otherwise be available to you under applicable patent law.
535 +
536 +### 12. No Surrender of Others' Freedom.
537 +
538 +If conditions are imposed on you (whether by court order, agreement or
539 +otherwise) that contradict the conditions of this License, they do not
540 +excuse you from the conditions of this License. If you cannot convey a
541 +covered work so as to satisfy simultaneously your obligations under
542 +this License and any other pertinent obligations, then as a
543 +consequence you may not convey it at all. For example, if you agree to
544 +terms that obligate you to collect a royalty for further conveying
545 +from those to whom you convey the Program, the only way you could
546 +satisfy both those terms and this License would be to refrain entirely
547 +from conveying the Program.
548 +
549 +### 13. Use with the GNU Affero General Public License.
550 +
551 +Notwithstanding any other provision of this License, you have
552 +permission to link or combine any covered work with a work licensed
553 +under version 3 of the GNU Affero General Public License into a single
554 +combined work, and to convey the resulting work. The terms of this
555 +License will continue to apply to the part which is the covered work,
556 +but the special requirements of the GNU Affero General Public License,
557 +section 13, concerning interaction through a network will apply to the
558 +combination as such.
559 +
560 +### 14. Revised Versions of this License.
561 +
562 +The Free Software Foundation may publish revised and/or new versions
563 +of the GNU General Public License from time to time. Such new versions
564 +will be similar in spirit to the present version, but may differ in
565 +detail to address new problems or concerns.
566 +
567 +Each version is given a distinguishing version number. If the Program
568 +specifies that a certain numbered version of the GNU General Public
569 +License "or any later version" applies to it, you have the option of
570 +following the terms and conditions either of that numbered version or
571 +of any later version published by the Free Software Foundation. If the
572 +Program does not specify a version number of the GNU General Public
573 +License, you may choose any version ever published by the Free
574 +Software Foundation.
575 +
576 +If the Program specifies that a proxy can decide which future versions
577 +of the GNU General Public License can be used, that proxy's public
578 +statement of acceptance of a version permanently authorizes you to
579 +choose that version for the Program.
580 +
581 +Later license versions may give you additional or different
582 +permissions. However, no additional obligations are imposed on any
583 +author or copyright holder as a result of your choosing to follow a
584 +later version.
585 +
586 +### 15. Disclaimer of Warranty.
587 +
588 +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
589 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
590 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
591 +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
592 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
593 +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
594 +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
595 +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
596 +CORRECTION.
597 +
598 +### 16. Limitation of Liability.
599 +
600 +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
602 +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
603 +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
604 +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
605 +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
606 +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
607 +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
608 +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
609 +
610 +### 17. Interpretation of Sections 15 and 16.
611 +
612 +If the disclaimer of warranty and limitation of liability provided
613 +above cannot be given local legal effect according to their terms,
614 +reviewing courts shall apply local law that most closely approximates
615 +an absolute waiver of all civil liability in connection with the
616 +Program, unless a warranty or assumption of liability accompanies a
617 +copy of the Program in return for a fee.
618 +
619 +END OF TERMS AND CONDITIONS
620 +
621 +## How to Apply These Terms to Your New Programs
622 +
623 +If you develop a new program, and you want it to be of the greatest
624 +possible use to the public, the best way to achieve this is to make it
625 +free software which everyone can redistribute and change under these
626 +terms.
627 +
628 +To do so, attach the following notices to the program. It is safest to
629 +attach them to the start of each source file to most effectively state
630 +the exclusion of warranty; and each file should have at least the
631 +"copyright" line and a pointer to where the full notice is found.
632 +
633 + <one line to give the program's name and a brief idea of what it does.>
634 + Copyright (C) <year> <name of author>
635 +
636 + This program is free software: you can redistribute it and/or modify
637 + it under the terms of the GNU General Public License as published by
638 + the Free Software Foundation, either version 3 of the License, or
639 + (at your option) any later version.
640 +
641 + This program is distributed in the hope that it will be useful,
642 + but WITHOUT ANY WARRANTY; without even the implied warranty of
643 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644 + GNU General Public License for more details.
645 +
646 + You should have received a copy of the GNU General Public License
647 + along with this program. If not, see <https://www.gnu.org/licenses/>.
648 +
649 +Also add information on how to contact you by electronic and paper
650 +mail.
651 +
652 +If the program does terminal interaction, make it output a short
653 +notice like this when it starts in an interactive mode:
654 +
655 + <program> Copyright (C) <year> <name of author>
656 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 + This is free software, and you are welcome to redistribute it
658 + under certain conditions; type `show c' for details.
659 +
660 +The hypothetical commands \`show w' and \`show c' should show the
661 +appropriate parts of the General Public License. Of course, your
662 +program's commands might be different; for a GUI interface, you would
663 +use an "about box".
664 +
665 +You should also get your employer (if you work as a programmer) or
666 +school, if any, to sign a "copyright disclaimer" for the program, if
667 +necessary. For more information on this, and how to apply and follow
668 +the GNU GPL, see <https://www.gnu.org/licenses/>.
669 +
670 +The GNU General Public License does not permit incorporating your
671 +program into proprietary programs. If your program is a subroutine
672 +library, you may consider it more useful to permit linking proprietary
673 +applications with the library. If this is what you want to do, use the
674 +GNU Lesser General Public License instead of this License. But first,
675 +please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
modified README.md
+23 −4
@@ -10,7 +10,7 @@ Just enough to get by.
10 10
11 11 Shipping a syncable database for the following information
12 12
13 −- [x] PPl
13 +- [x] PPL
14 14 - [x] Contact information
15 15 - [x] Tiers
16 16 - [x] Traits
@@ -22,10 +22,21 @@ Shipping a syncable database for the following information
22 22 ### MOTD
23 23
24 24 Put a message of the day in your bashrc to remind you of important dates.
25 −```ppl motd```
25 +`ppl motd` outputs:
26 26
27 27 ![motd.png](screenshots/motd.png)
28 28
29 +#### Reminders
30 +
31 +By default reminders will only be shown once per day unless otherwise configured. The options are:
32 +- `OnlyOnce`, // Default, Only the first time the motd is run that day`
33 +- `OnceHourly`, // Only once per hour, resetting at the top of the hour
34 +- `Randomly(u8)`, // Will show this motd person randomly u8% every run
35 +- `Always`, // Will always show this person's upcoming
36 +- `Never`, // Never show this person's upcoming
37 +
38 +
39 +
29 40 ### TUI
30 41
31 42 A Terminal UI for managing all the various stored information in the database.
@@ -49,8 +60,16 @@ Add and Modify Tiers and Defaults
49 60
50 61 ![tiers.png](screenshots/tiers.png)
51 62
52 −### Trait View
63 +#### Trait View
53 64
54 65 Add and Modify Traits and Defaults
55 66
56 −![img.png](screenshots/traits.png)
67 +![img.png](screenshots/traits.png)
68 +
69 +### Stats
70 +
71 +`ppl stats` shows a summary of the current database
72 +
73 +### Tiers & Traits
74 +
75 +`ppl tiers` and `ppl traits` list all the tiers and traits in the database
added release.sh
+333 −0
@@ -0,0 +1,333 @@
1 +#!/bin/bash
2 +
3 +# NEIAM Release Script
4 +# This script helps create and manage releases for the NEIAM projects
5 +
6 +set -euo pipefail
7 +
8 +# Colors for output
9 +RED='\033[0;31m'
10 +GREEN='\033[0;32m'
11 +YELLOW='\033[1;33m'
12 +BLUE='\033[0;34m'
13 +NC='\033[0m' # No Color
14 +
15 +# Function to print colored output
16 +print_status() {
17 + local color=$1
18 + local message=$2
19 + echo -e "${color}${message}${NC}"
20 +}
21 +
22 +# Function to get current version from Cargo.toml
23 +get_current_version() {
24 + grep '^version = ' Cargo.toml | cut -d'"' -f2
25 +}
26 +
27 +# Function to validate version format
28 +validate_version() {
29 + local version=$1
30 + if [[ ! $version =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+)?$ ]]; then
31 + print_status $RED "Invalid version format: $version"
32 + print_status $YELLOW "Version should be in format: X.Y.Z or X.Y.Z-suffix"
33 + return 1
34 + fi
35 +}
36 +
37 +# Function to update version in Cargo.toml
38 +update_version() {
39 + local new_version=$1
40 + print_status $BLUE "Updating version to $new_version in Cargo.toml..."
41 + sed -i "s/^version = \".*\"/version = \"$new_version\"/" Cargo.toml
42 + print_status $GREEN "Version updated successfully!"
43 +}
44 +
45 +# Function to create git tag
46 +create_tag() {
47 + local version=$1
48 + local tag_name="v$version"
49 +
50 + print_status $BLUE "Creating git tag $tag_name..."
51 +
52 + # Check if tag already exists
53 + if git tag -l | grep -q "^$tag_name$"; then
54 + print_status $RED "Tag $tag_name already exists!"
55 + return 1
56 + fi
57 +
58 + # Create annotated tag
59 + git tag -a "$tag_name" -m "Release $tag_name"
60 + print_status $GREEN "Tag $tag_name created successfully!"
61 +}
62 +
63 +# Function to show release preparation checklist
64 +show_checklist() {
65 + print_status $BLUE "Pre-release Checklist:"
66 + echo
67 + echo " [ ] All tests are passing"
68 + echo " [ ] Documentation is up to date"
69 + echo " [ ] CHANGELOG.md is updated (if exists)"
70 + echo " [ ] All changes are committed"
71 + echo " [ ] Working directory is clean"
72 + echo " [ ] On the correct branch (usually master/main)"
73 + echo
74 +}
75 +
76 +# Function to check working directory
77 +check_working_directory() {
78 + if [[ -n $(git status --porcelain) ]]; then
79 + print_status $RED "Working directory is not clean!"
80 + print_status $YELLOW "Please commit or stash your changes first."
81 + git status --short
82 + return 1
83 + fi
84 +}
85 +
86 +# Function to check current branch
87 +check_branch() {
88 + local current_branch=$(git branch --show-current)
89 + if [[ $current_branch != "master" && $current_branch != "main" ]]; then
90 + print_status $YELLOW "Warning: You are on branch '$current_branch', not on master/main"
91 + read -p "Do you want to continue? (y/N): " -n 1 -r
92 + echo
93 + if [[ ! $REPLY =~ ^[Yy]$ ]]; then
94 + print_status $RED "Release cancelled."
95 + return 1
96 + fi
97 + fi
98 +}
99 +
100 +# Function to run tests
101 +run_tests() {
102 + print_status $BLUE "Running tests..."
103 + if cargo test; then
104 + print_status $GREEN "All tests passed!"
105 + else
106 + print_status $RED "Tests failed! Please fix issues before releasing."
107 + return 1
108 + fi
109 +}
110 +
111 +# Function to build project
112 +build_project() {
113 + print_status $BLUE "Building project..."
114 + if cargo build --release; then
115 + print_status $GREEN "Build successful!"
116 + else
117 + print_status $RED "Build failed! Please fix issues before releasing."
118 + return 1
119 + fi
120 +}
121 +
122 +# Function to push release
123 +push_release() {
124 + local version=$1
125 + local tag_name="v$version"
126 +
127 + print_status $BLUE "Pushing release to GitHub..."
128 +
129 + # Push commits
130 + git push origin
131 +
132 + # Push tag
133 + git push origin "$tag_name"
134 +
135 + print_status $GREEN "Release pushed successfully!"
136 + print_status $BLUE "GitHub Actions will now build and create the release."
137 + print_status $BLUE "Check the Actions tab in your GitHub repository for progress."
138 +}
139 +
140 +# Function to show help
141 +show_help() {
142 + cat << EOF
143 +NEIAM Release Script
144 +
145 +Usage: $0 <command> [options]
146 +
147 +Commands:
148 + current Show current version
149 + prepare <version> Prepare a new release (update version, create tag)
150 + patch Increment patch version and prepare release
151 + minor Increment minor version and prepare release
152 + major Increment major version and prepare release
153 + push <version> Push release tag to trigger GitHub Actions
154 + checklist Show pre-release checklist
155 + help Show this help message
156 +
157 +Options:
158 + --dry-run Show what would be done without making changes
159 + --no-tests Skip running tests
160 + --no-build Skip building project
161 +
162 +Examples:
163 + $0 current # Show current version
164 + $0 prepare 1.2.3 # Prepare version 1.2.3
165 + $0 patch # Increment patch version (1.2.3 -> 1.2.4)
166 + $0 minor # Increment minor version (1.2.3 -> 1.3.0)
167 + $0 major # Increment major version (1.2.3 -> 2.0.0)
168 + $0 push 1.2.3 # Push v1.2.3 tag to trigger release
169 + $0 prepare 1.2.3 --dry-run # Show what would be done
170 +
171 +Release Process:
172 + 1. Run '$0 checklist' to review pre-release requirements
173 + 2. Run '$0 prepare <version>' to update version and create tag
174 + 3. Run '$0 push <version>' to push and trigger GitHub Actions release
175 +
176 + Or use shortcuts:
177 + - '$0 patch' for patch releases
178 + - '$0 minor' for minor releases
179 + - '$0 major' for major releases
180 +EOF
181 +}
182 +
183 +# Function to increment version
184 +increment_version() {
185 + local current_version=$(get_current_version)
186 + local increment_type=$1
187 +
188 + IFS='.' read -r major minor patch <<< "$current_version"
189 +
190 + case $increment_type in
191 + "patch")
192 + patch=$((patch + 1))
193 + ;;
194 + "minor")
195 + minor=$((minor + 1))
196 + patch=0
197 + ;;
198 + "major")
199 + major=$((major + 1))
200 + minor=0
201 + patch=0
202 + ;;
203 + esac
204 +
205 + echo "$major.$minor.$patch"
206 +}
207 +
208 +# Main function
209 +main() {
210 + local command=${1:-help}
211 + local dry_run=false
212 + local no_tests=false
213 + local no_build=false
214 +
215 + # Parse options
216 + while [[ $# -gt 0 ]]; do
217 + case $1 in
218 + --dry-run)
219 + dry_run=true
220 + shift
221 + ;;
222 + --no-tests)
223 + no_tests=true
224 + shift
225 + ;;
226 + --no-build)
227 + no_build=true
228 + shift
229 + ;;
230 + -*)
231 + print_status $RED "Unknown option: $1"
232 + show_help
233 + exit 1
234 + ;;
235 + *)
236 + break
237 + ;;
238 + esac
239 + done
240 +
241 + case $command in
242 + "current")
243 + local current_version=$(get_current_version)
244 + print_status $BLUE "Current version: $current_version"
245 + ;;
246 + "prepare")
247 + local version=${2:-}
248 + if [[ -z $version ]]; then
249 + print_status $RED "Version is required for prepare command"
250 + show_help
251 + exit 1
252 + fi
253 +
254 + validate_version "$version"
255 +
256 + if [[ $dry_run == true ]]; then
257 + print_status $YELLOW "DRY RUN: Would update version to $version and create tag v$version"
258 + exit 0
259 + fi
260 +
261 + check_working_directory
262 + check_branch
263 +
264 + if [[ $no_tests == false ]]; then
265 + run_tests
266 + fi
267 +
268 + if [[ $no_build == false ]]; then
269 + build_project
270 + fi
271 +
272 + update_version "$version"
273 +
274 + # Commit version change
275 + git add Cargo.toml
276 + git commit -m "Bump version to $version"
277 +
278 + create_tag "$version"
279 +
280 + print_status $GREEN "Release $version prepared successfully!"
281 + print_status $BLUE "Run '$0 push $version' to push and trigger GitHub Actions release"
282 + ;;
283 + "patch"|"minor"|"major")
284 + local new_version=$(increment_version "$command")
285 + print_status $BLUE "Incrementing $command version to $new_version"
286 +
287 + if [[ $dry_run == true ]]; then
288 + print_status $YELLOW "DRY RUN: Would increment $command version to $new_version"
289 + exit 0
290 + fi
291 +
292 + # Call prepare with the new version
293 + main "prepare" "$new_version"
294 + ;;
295 + "push")
296 + local version=${2:-}
297 + if [[ -z $version ]]; then
298 + print_status $RED "Version is required for push command"
299 + show_help
300 + exit 1
301 + fi
302 +
303 + validate_version "$version"
304 +
305 + if [[ $dry_run == true ]]; then
306 + print_status $YELLOW "DRY RUN: Would push tag v$version"
307 + exit 0
308 + fi
309 +
310 + push_release "$version"
311 + ;;
312 + "checklist")
313 + show_checklist
314 + ;;
315 + "help"|*)
316 + show_help
317 + ;;
318 + esac
319 +}
320 +
321 +# Check if we're in a git repository
322 +if ! git rev-parse --git-dir > /dev/null 2>&1; then
323 + print_status $RED "This script must be run from within a git repository"
324 + exit 1
325 +fi
326 +
327 +# Check if Cargo.toml exists
328 +if [[ ! -f Cargo.toml ]]; then
329 + print_status $RED "Cargo.toml not found. This script must be run from the project root."
330 + exit 1
331 +fi
332 +
333 +main "$@"
modified src/do_init.rs
+0 −2
@@ -318,7 +318,6 @@ pub async fn run_init(
318 318 app.of_ppl = app
319 319 .input
320 320 .value()
321 − .to_string()
322 321 .split(",")
323 322 .map(|s| s.trim().to_string())
324 323 .collect::<Vec<String>>();
@@ -330,7 +329,6 @@ pub async fn run_init(
330 329 app.with_ppl = app
331 330 .input
332 331 .value()
333 − .to_string()
334 332 .split(",")
335 333 .map(|s| s.trim().to_string())
336 334 .collect::<Vec<String>>();
modified src/main.rs
+1 −0
@@ -196,6 +196,7 @@ enum MotdRemindEnum {
196 196 OnceHourly, // Only once per hour, resetting at the top of the hour
197 197 Randomly(u8), // Will show this motd person randomly u8% every run
198 198 Always, // Will always show this person's upcoming
199 + Never, // Never show this person's upcoming
199 200 }
200 201
201 202 async fn motd(db: &DatabaseConnection) -> Result<(), PplError> {

Parents: 646a679