├── .gitignore
├── AGPL-3
├── LICENSE
├── README.md
├── ansyelfie.png
├── bin
└── pspsps
├── pspsps
├── __init__.py
├── http.py
├── safebooru.py
└── terminyal.py
├── screenshot-kyonsole.png
├── screenshot1.png
├── screenshot2.png
├── screenshot3.png
├── screenshot4.png
└── setup.py
/.gitignore:
--------------------------------------------------------------------------------
1 | build/
2 | dist/
3 | *.egg-info/
4 | __pycache__/
5 |
--------------------------------------------------------------------------------
/AGPL-3:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license
11 | for software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are
15 | designed to take away your freedom to share and change the works. By
16 | contrast, our General Public Licenses are intended to guarantee your
17 | freedom to share and change all versions of a program--to make sure it
18 | remains free software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public
64 | License.
65 |
66 | "Copyright" also means copyright-like laws that apply to other kinds
67 | of works, such as semiconductor masks.
68 |
69 | "The Program" refers to any copyrightable work licensed under this
70 | License. Each licensee is addressed as "you". "Licensees" and
71 | "recipients" may be individuals or organizations.
72 |
73 | To "modify" a work means to copy from or adapt all or part of the work
74 | in a fashion requiring copyright permission, other than the making of an
75 | exact copy. The resulting work is called a "modified version" of the
76 | earlier work or a work "based on" the earlier work.
77 |
78 | A "covered work" means either the unmodified Program or a work based
79 | on the Program.
80 |
81 | To "propagate" a work means to do anything with it that, without
82 | permission, would make you directly or secondarily liable for
83 | infringement under applicable copyright law, except executing it on a
84 | computer or modifying a private copy. Propagation includes copying,
85 | distribution (with or without modification), making available to the
86 | public, and in some countries other activities as well.
87 |
88 | To "convey" a work means any kind of propagation that enables other
89 | parties to make or receive copies. Mere interaction with a user through
90 | a computer network, with no transfer of a copy, is not conveying.
91 |
92 | An interactive user interface displays "Appropriate Legal Notices"
93 | to the extent that it includes a convenient and prominently visible
94 | feature that (1) displays an appropriate copyright notice, and (2)
95 | tells the user that there is no warranty for the work (except to the
96 | extent that warranties are provided), that licensees may convey the
97 | work under this License, and how to view a copy of this License. If
98 | the interface presents a list of user commands or options, such as a
99 | menu, a prominent item in the list meets this criterion.
100 |
101 | 1. Source Code.
102 |
103 | The "source code" for a work means the preferred form of the work
104 | for making modifications to it. "Object code" means any non-source
105 | form of a work.
106 |
107 | A "Standard Interface" means an interface that either is an official
108 | standard defined by a recognized standards body, or, in the case of
109 | interfaces specified for a particular programming language, one that
110 | is widely used among developers working in that language.
111 |
112 | The "System Libraries" of an executable work include anything, other
113 | than the work as a whole, that (a) is included in the normal form of
114 | packaging a Major Component, but which is not part of that Major
115 | Component, and (b) serves only to enable use of the work with that
116 | Major Component, or to implement a Standard Interface for which an
117 | implementation is available to the public in source code form. A
118 | "Major Component", in this context, means a major essential component
119 | (kernel, window system, and so on) of the specific operating system
120 | (if any) on which the executable work runs, or a compiler used to
121 | produce the work, or an object code interpreter used to run it.
122 |
123 | The "Corresponding Source" for a work in object code form means all
124 | the source code needed to generate, install, and (for an executable
125 | work) run the object code and to modify the work, including scripts to
126 | control those activities. However, it does not include the work's
127 | System Libraries, or general-purpose tools or generally available free
128 | programs which are used unmodified in performing those activities but
129 | which are not part of the work. For example, Corresponding Source
130 | includes interface definition files associated with source files for
131 | the work, and the source code for shared libraries and dynamically
132 | linked subprograms that the work is specifically designed to require,
133 | such as by intimate data communication or control flow between those
134 | subprograms and other parts of the work.
135 |
136 | The Corresponding Source need not include anything that users
137 | can regenerate automatically from other parts of the Corresponding
138 | Source.
139 |
140 | The Corresponding Source for a work in source code form is that
141 | same work.
142 |
143 | 2. Basic Permissions.
144 |
145 | All rights granted under this License are granted for the term of
146 | copyright on the Program, and are irrevocable provided the stated
147 | conditions are met. This License explicitly affirms your unlimited
148 | permission to run the unmodified Program. The output from running a
149 | covered work is covered by this License only if the output, given its
150 | content, constitutes a covered work. This License acknowledges your
151 | rights of fair use or other equivalent, as provided by copyright law.
152 |
153 | You may make, run and propagate covered works that you do not
154 | convey, without conditions so long as your license otherwise remains
155 | in force. You may convey covered works to others for the sole purpose
156 | of having them make modifications exclusively for you, or provide you
157 | with facilities for running those works, provided that you comply with
158 | the terms of this License in conveying all material for which you do
159 | not control copyright. Those thus making or running the covered works
160 | for you must do so exclusively on your behalf, under your direction
161 | and control, on terms that prohibit them from making any copies of
162 | your copyrighted material outside their relationship with you.
163 |
164 | Conveying under any other circumstances is permitted solely under
165 | the conditions stated below. Sublicensing is not allowed; section 10
166 | makes it unnecessary.
167 |
168 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
169 |
170 | No covered work shall be deemed part of an effective technological
171 | measure under any applicable law fulfilling obligations under article
172 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
173 | similar laws prohibiting or restricting circumvention of such
174 | measures.
175 |
176 | When you convey a covered work, you waive any legal power to forbid
177 | circumvention of technological measures to the extent such circumvention
178 | is effected by exercising rights under this License with respect to
179 | the covered work, and you disclaim any intention to limit operation or
180 | modification of the work as a means of enforcing, against the work's
181 | users, your or third parties' legal rights to forbid circumvention of
182 | technological measures.
183 |
184 | 4. Conveying Verbatim Copies.
185 |
186 | You may convey verbatim copies of the Program's source code as you
187 | receive it, in any medium, provided that you conspicuously and
188 | appropriately publish on each copy an appropriate copyright notice;
189 | keep intact all notices stating that this License and any
190 | non-permissive terms added in accord with section 7 apply to the code;
191 | keep intact all notices of the absence of any warranty; and give all
192 | recipients a copy of this License along with the Program.
193 |
194 | You may charge any price or no price for each copy that you convey,
195 | and you may offer support or warranty protection for a fee.
196 |
197 | 5. Conveying Modified Source Versions.
198 |
199 | You may convey a work based on the Program, or the modifications to
200 | produce it from the Program, in the form of source code under the
201 | terms of section 4, provided that you also meet all of these conditions:
202 |
203 | a) The work must carry prominent notices stating that you modified
204 | it, and giving a relevant date.
205 |
206 | b) The work must carry prominent notices stating that it is
207 | released under this License and any conditions added under section
208 | 7. This requirement modifies the requirement in section 4 to
209 | "keep intact all notices".
210 |
211 | c) You must license the entire work, as a whole, under this
212 | License to anyone who comes into possession of a copy. This
213 | License will therefore apply, along with any applicable section 7
214 | additional terms, to the whole of the work, and all its parts,
215 | regardless of how they are packaged. This License gives no
216 | permission to license the work in any other way, but it does not
217 | invalidate such permission if you have separately received it.
218 |
219 | d) If the work has interactive user interfaces, each must display
220 | Appropriate Legal Notices; however, if the Program has interactive
221 | interfaces that do not display Appropriate Legal Notices, your
222 | work need not make them do so.
223 |
224 | A compilation of a covered work with other separate and independent
225 | works, which are not by their nature extensions of the covered work,
226 | and which are not combined with it such as to form a larger program,
227 | in or on a volume of a storage or distribution medium, is called an
228 | "aggregate" if the compilation and its resulting copyright are not
229 | used to limit the access or legal rights of the compilation's users
230 | beyond what the individual works permit. Inclusion of a covered work
231 | in an aggregate does not cause this License to apply to the other
232 | parts of the aggregate.
233 |
234 | 6. Conveying Non-Source Forms.
235 |
236 | You may convey a covered work in object code form under the terms
237 | of sections 4 and 5, provided that you also convey the
238 | machine-readable Corresponding Source under the terms of this License,
239 | in one of these ways:
240 |
241 | a) Convey the object code in, or embodied in, a physical product
242 | (including a physical distribution medium), accompanied by the
243 | Corresponding Source fixed on a durable physical medium
244 | customarily used for software interchange.
245 |
246 | b) Convey the object code in, or embodied in, a physical product
247 | (including a physical distribution medium), accompanied by a
248 | written offer, valid for at least three years and valid for as
249 | long as you offer spare parts or customer support for that product
250 | model, to give anyone who possesses the object code either (1) a
251 | copy of the Corresponding Source for all the software in the
252 | product that is covered by this License, on a durable physical
253 | medium customarily used for software interchange, for a price no
254 | more than your reasonable cost of physically performing this
255 | conveying of source, or (2) access to copy the
256 | Corresponding Source from a network server at no charge.
257 |
258 | c) Convey individual copies of the object code with a copy of the
259 | written offer to provide the Corresponding Source. This
260 | alternative is allowed only occasionally and noncommercially, and
261 | only if you received the object code with such an offer, in accord
262 | with subsection 6b.
263 |
264 | d) Convey the object code by offering access from a designated
265 | place (gratis or for a charge), and offer equivalent access to the
266 | Corresponding Source in the same way through the same place at no
267 | further charge. You need not require recipients to copy the
268 | Corresponding Source along with the object code. If the place to
269 | copy the object code is a network server, the Corresponding Source
270 | may be on a different server (operated by you or a third party)
271 | that supports equivalent copying facilities, provided you maintain
272 | clear directions next to the object code saying where to find the
273 | Corresponding Source. Regardless of what server hosts the
274 | Corresponding Source, you remain obligated to ensure that it is
275 | available for as long as needed to satisfy these requirements.
276 |
277 | e) Convey the object code using peer-to-peer transmission, provided
278 | you inform other peers where the object code and Corresponding
279 | Source of the work are being offered to the general public at no
280 | charge under subsection 6d.
281 |
282 | A separable portion of the object code, whose source code is excluded
283 | from the Corresponding Source as a System Library, need not be
284 | included in conveying the object code work.
285 |
286 | A "User Product" is either (1) a "consumer product", which means any
287 | tangible personal property which is normally used for personal, family,
288 | or household purposes, or (2) anything designed or sold for incorporation
289 | into a dwelling. In determining whether a product is a consumer product,
290 | doubtful cases shall be resolved in favor of coverage. For a particular
291 | product received by a particular user, "normally used" refers to a
292 | typical or common use of that class of product, regardless of the status
293 | of the particular user or of the way in which the particular user
294 | actually uses, or expects or is expected to use, the product. A product
295 | is a consumer product regardless of whether the product has substantial
296 | commercial, industrial or non-consumer uses, unless such uses represent
297 | the only significant mode of use of the product.
298 |
299 | "Installation Information" for a User Product means any methods,
300 | procedures, authorization keys, or other information required to install
301 | and execute modified versions of a covered work in that User Product from
302 | a modified version of its Corresponding Source. The information must
303 | suffice to ensure that the continued functioning of the modified object
304 | code is in no case prevented or interfered with solely because
305 | modification has been made.
306 |
307 | If you convey an object code work under this section in, or with, or
308 | specifically for use in, a User Product, and the conveying occurs as
309 | part of a transaction in which the right of possession and use of the
310 | User Product is transferred to the recipient in perpetuity or for a
311 | fixed term (regardless of how the transaction is characterized), the
312 | Corresponding Source conveyed under this section must be accompanied
313 | by the Installation Information. But this requirement does not apply
314 | if neither you nor any third party retains the ability to install
315 | modified object code on the User Product (for example, the work has
316 | been installed in ROM).
317 |
318 | The requirement to provide Installation Information does not include a
319 | requirement to continue to provide support service, warranty, or updates
320 | for a work that has been modified or installed by the recipient, or for
321 | the User Product in which it has been modified or installed. Access to a
322 | network may be denied when the modification itself materially and
323 | adversely affects the operation of the network or violates the rules and
324 | protocols for communication across the network.
325 |
326 | Corresponding Source conveyed, and Installation Information provided,
327 | in accord with this section must be in a format that is publicly
328 | documented (and with an implementation available to the public in
329 | source code form), and must require no special password or key for
330 | unpacking, reading or copying.
331 |
332 | 7. Additional Terms.
333 |
334 | "Additional permissions" are terms that supplement the terms of this
335 | License by making exceptions from one or more of its conditions.
336 | Additional permissions that are applicable to the entire Program shall
337 | be treated as though they were included in this License, to the extent
338 | that they are valid under applicable law. If additional permissions
339 | apply only to part of the Program, that part may be used separately
340 | under those permissions, but the entire Program remains governed by
341 | this License without regard to the additional permissions.
342 |
343 | When you convey a copy of a covered work, you may at your option
344 | remove any additional permissions from that copy, or from any part of
345 | it. (Additional permissions may be written to require their own
346 | removal in certain cases when you modify the work.) You may place
347 | additional permissions on material, added by you to a covered work,
348 | for which you have or can give appropriate copyright permission.
349 |
350 | Notwithstanding any other provision of this License, for material you
351 | add to a covered work, you may (if authorized by the copyright holders of
352 | that material) supplement the terms of this License with terms:
353 |
354 | a) Disclaiming warranty or limiting liability differently from the
355 | terms of sections 15 and 16 of this License; or
356 |
357 | b) Requiring preservation of specified reasonable legal notices or
358 | author attributions in that material or in the Appropriate Legal
359 | Notices displayed by works containing it; or
360 |
361 | c) Prohibiting misrepresentation of the origin of that material, or
362 | requiring that modified versions of such material be marked in
363 | reasonable ways as different from the original version; or
364 |
365 | d) Limiting the use for publicity purposes of names of licensors or
366 | authors of the material; or
367 |
368 | e) Declining to grant rights under trademark law for use of some
369 | trade names, trademarks, or service marks; or
370 |
371 | f) Requiring indemnification of licensors and authors of that
372 | material by anyone who conveys the material (or modified versions of
373 | it) with contractual assumptions of liability to the recipient, for
374 | any liability that these contractual assumptions directly impose on
375 | those licensors and authors.
376 |
377 | All other non-permissive additional terms are considered "further
378 | restrictions" within the meaning of section 10. If the Program as you
379 | received it, or any part of it, contains a notice stating that it is
380 | governed by this License along with a term that is a further restriction,
381 | you may remove that term. If a license document contains a further
382 | restriction but permits relicensing or conveying under this License, you
383 | may add to a covered work material governed by the terms of that license
384 | document, provided that the further restriction does not survive such
385 | relicensing or conveying.
386 |
387 | If you add terms to a covered work in accord with this section, you
388 | must place, in the relevant source files, a statement of the
389 | additional terms that apply to those files, or a notice indicating
390 | where to find the applicable terms.
391 |
392 | Additional terms, permissive or non-permissive, may be stated in the
393 | form of a separately written license, or stated as exceptions;
394 | the above requirements apply either way.
395 |
396 | 8. Termination.
397 |
398 | You may not propagate or modify a covered work except as expressly
399 | provided under this License. Any attempt otherwise to propagate or
400 | modify it is void, and will automatically terminate your rights under
401 | this License (including any patent licenses granted under the third
402 | paragraph of section 11).
403 |
404 | However, if you cease all violation of this License, then your
405 | license from a particular copyright holder is reinstated (a)
406 | provisionally, unless and until the copyright holder explicitly and
407 | finally terminates your license, and (b) permanently, if the copyright
408 | holder fails to notify you of the violation by some reasonable means
409 | prior to 60 days after the cessation.
410 |
411 | Moreover, your license from a particular copyright holder is
412 | reinstated permanently if the copyright holder notifies you of the
413 | violation by some reasonable means, this is the first time you have
414 | received notice of violation of this License (for any work) from that
415 | copyright holder, and you cure the violation prior to 30 days after
416 | your receipt of the notice.
417 |
418 | Termination of your rights under this section does not terminate the
419 | licenses of parties who have received copies or rights from you under
420 | this License. If your rights have been terminated and not permanently
421 | reinstated, you do not qualify to receive new licenses for the same
422 | material under section 10.
423 |
424 | 9. Acceptance Not Required for Having Copies.
425 |
426 | You are not required to accept this License in order to receive or
427 | run a copy of the Program. Ancillary propagation of a covered work
428 | occurring solely as a consequence of using peer-to-peer transmission
429 | to receive a copy likewise does not require acceptance. However,
430 | nothing other than this License grants you permission to propagate or
431 | modify any covered work. These actions infringe copyright if you do
432 | not accept this License. Therefore, by modifying or propagating a
433 | covered work, you indicate your acceptance of this License to do so.
434 |
435 | 10. Automatic Licensing of Downstream Recipients.
436 |
437 | Each time you convey a covered work, the recipient automatically
438 | receives a license from the original licensors, to run, modify and
439 | propagate that work, subject to this License. You are not responsible
440 | for enforcing compliance by third parties with this License.
441 |
442 | An "entity transaction" is a transaction transferring control of an
443 | organization, or substantially all assets of one, or subdividing an
444 | organization, or merging organizations. If propagation of a covered
445 | work results from an entity transaction, each party to that
446 | transaction who receives a copy of the work also receives whatever
447 | licenses to the work the party's predecessor in interest had or could
448 | give under the previous paragraph, plus a right to possession of the
449 | Corresponding Source of the work from the predecessor in interest, if
450 | the predecessor has it or can get it with reasonable efforts.
451 |
452 | You may not impose any further restrictions on the exercise of the
453 | rights granted or affirmed under this License. For example, you may
454 | not impose a license fee, royalty, or other charge for exercise of
455 | rights granted under this License, and you may not initiate litigation
456 | (including a cross-claim or counterclaim in a lawsuit) alleging that
457 | any patent claim is infringed by making, using, selling, offering for
458 | sale, or importing the Program or any portion of it.
459 |
460 | 11. Patents.
461 |
462 | A "contributor" is a copyright holder who authorizes use under this
463 | License of the Program or a work on which the Program is based. The
464 | work thus licensed is called the contributor's "contributor version".
465 |
466 | A contributor's "essential patent claims" are all patent claims
467 | owned or controlled by the contributor, whether already acquired or
468 | hereafter acquired, that would be infringed by some manner, permitted
469 | by this License, of making, using, or selling its contributor version,
470 | but do not include claims that would be infringed only as a
471 | consequence of further modification of the contributor version. For
472 | purposes of this definition, "control" includes the right to grant
473 | patent sublicenses in a manner consistent with the requirements of
474 | this License.
475 |
476 | Each contributor grants you a non-exclusive, worldwide, royalty-free
477 | patent license under the contributor's essential patent claims, to
478 | make, use, sell, offer for sale, import and otherwise run, modify and
479 | propagate the contents of its contributor version.
480 |
481 | In the following three paragraphs, a "patent license" is any express
482 | agreement or commitment, however denominated, not to enforce a patent
483 | (such as an express permission to practice a patent or covenant not to
484 | sue for patent infringement). To "grant" such a patent license to a
485 | party means to make such an agreement or commitment not to enforce a
486 | patent against the party.
487 |
488 | If you convey a covered work, knowingly relying on a patent license,
489 | and the Corresponding Source of the work is not available for anyone
490 | to copy, free of charge and under the terms of this License, through a
491 | publicly available network server or other readily accessible means,
492 | then you must either (1) cause the Corresponding Source to be so
493 | available, or (2) arrange to deprive yourself of the benefit of the
494 | patent license for this particular work, or (3) arrange, in a manner
495 | consistent with the requirements of this License, to extend the patent
496 | license to downstream recipients. "Knowingly relying" means you have
497 | actual knowledge that, but for the patent license, your conveying the
498 | covered work in a country, or your recipient's use of the covered work
499 | in a country, would infringe one or more identifiable patents in that
500 | country that you have reason to believe are valid.
501 |
502 | If, pursuant to or in connection with a single transaction or
503 | arrangement, you convey, or propagate by procuring conveyance of, a
504 | covered work, and grant a patent license to some of the parties
505 | receiving the covered work authorizing them to use, propagate, modify
506 | or convey a specific copy of the covered work, then the patent license
507 | you grant is automatically extended to all recipients of the covered
508 | work and works based on it.
509 |
510 | A patent license is "discriminatory" if it does not include within
511 | the scope of its coverage, prohibits the exercise of, or is
512 | conditioned on the non-exercise of one or more of the rights that are
513 | specifically granted under this License. You may not convey a covered
514 | work if you are a party to an arrangement with a third party that is
515 | in the business of distributing software, under which you make payment
516 | to the third party based on the extent of your activity of conveying
517 | the work, and under which the third party grants, to any of the
518 | parties who would receive the covered work from you, a discriminatory
519 | patent license (a) in connection with copies of the covered work
520 | conveyed by you (or copies made from those copies), or (b) primarily
521 | for and in connection with specific products or compilations that
522 | contain the covered work, unless you entered into that arrangement,
523 | or that patent license was granted, prior to 28 March 2007.
524 |
525 | Nothing in this License shall be construed as excluding or limiting
526 | any implied license or other defenses to infringement that may
527 | otherwise be available to you under applicable patent law.
528 |
529 | 12. No Surrender of Others' Freedom.
530 |
531 | If conditions are imposed on you (whether by court order, agreement or
532 | otherwise) that contradict the conditions of this License, they do not
533 | excuse you from the conditions of this License. If you cannot convey a
534 | covered work so as to satisfy simultaneously your obligations under this
535 | License and any other pertinent obligations, then as a consequence you may
536 | not convey it at all. For example, if you agree to terms that obligate you
537 | to collect a royalty for further conveying from those to whom you convey
538 | the Program, the only way you could satisfy both those terms and this
539 | License would be to refrain entirely from conveying the Program.
540 |
541 | 13. Remote Network Interaction; Use with the GNU General Public License.
542 |
543 | Notwithstanding any other provision of this License, if you modify the
544 | Program, your modified version must prominently offer all users
545 | interacting with it remotely through a computer network (if your version
546 | supports such interaction) an opportunity to receive the Corresponding
547 | Source of your version by providing access to the Corresponding Source
548 | from a network server at no charge, through some standard or customary
549 | means of facilitating copying of software. This Corresponding Source
550 | shall include the Corresponding Source for any work covered by version 3
551 | of the GNU General Public License that is incorporated pursuant to the
552 | following paragraph.
553 |
554 | Notwithstanding any other provision of this License, you have permission
555 | to link or combine any covered work with a work licensed under version 3
556 | of the GNU General Public License into a single combined work, and to
557 | convey the resulting work. The terms of this License will continue to
558 | apply to the part which is the covered work, but the work with which it is
559 | combined will remain governed by version 3 of the GNU General Public
560 | License.
561 |
562 | 14. Revised Versions of this License.
563 |
564 | The Free Software Foundation may publish revised and/or new versions of
565 | the GNU Affero General Public License from time to time. Such new
566 | versions will be similar in spirit to the present version, but may differ
567 | in detail to address new problems or concerns.
568 |
569 | Each version is given a distinguishing version number. If the
570 | Program specifies that a certain numbered version of the GNU Affero
571 | General Public License "or any later version" applies to it, you have
572 | the option of following the terms and conditions either of that
573 | numbered version or of any later version published by the Free
574 | Software Foundation. If the Program does not specify a version number
575 | of the GNU Affero General Public License, you may choose any version
576 | ever published by the Free Software Foundation.
577 |
578 | If the Program specifies that a proxy can decide which future
579 | versions of the GNU Affero General Public License can be used, that
580 | proxy's public statement of acceptance of a version permanently
581 | authorizes you to choose that version for the Program.
582 |
583 | Later license versions may give you additional or different
584 | permissions. However, no additional obligations are imposed on any
585 | author or copyright holder as a result of your choosing to follow a
586 | later version.
587 |
588 | 15. Disclaimer of Warranty.
589 |
590 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
591 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
592 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
593 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
594 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
595 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
596 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
597 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
598 |
599 | 16. Limitation of Liability.
600 |
601 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
602 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
603 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
604 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
605 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
606 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
607 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
608 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
609 | SUCH DAMAGES.
610 |
611 | 17. Interpretation of Sections 15 and 16.
612 |
613 | If the disclaimer of warranty and limitation of liability provided
614 | above cannot be given local legal effect according to their terms,
615 | reviewing courts shall apply local law that most closely approximates
616 | an absolute waiver of all civil liability in connection with the
617 | Program, unless a warranty or assumption of liability accompanies a
618 | copy of the Program in return for a fee.
619 |
620 | END OF TERMS AND CONDITIONS
621 |
622 | How to Apply These Terms to Your New Programs
623 |
624 | If you develop a new program, and you want it to be of the greatest
625 | possible use to the public, the best way to achieve this is to make it
626 | free software which everyone can redistribute and change under these terms.
627 |
628 | To do so, attach the following notices to the program. It is safest
629 | to attach them to the start of each source file to most effectively
630 | state the exclusion of warranty; and each file should have at least
631 | the "copyright" line and a pointer to where the full notice is found.
632 |
633 |
634 | Copyright (C)
635 |
636 | This program is free software: you can redistribute it and/or modify
637 | it under the terms of the GNU Affero General Public License as
638 | published by the Free Software Foundation, either version 3 of the
639 | License, or (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 Affero General Public License for more details.
645 |
646 | You should have received a copy of the GNU Affero General Public License
647 | along with this program. If not, see .
648 |
649 | Also add information on how to contact you by electronic and paper mail.
650 |
651 | If your software can interact with users remotely through a computer
652 | network, you should also make sure that it provides a way for users to
653 | get its source. For example, if your program is a web application, its
654 | interface could display a "Source" link that leads users to an archive
655 | of the code. There are many ways you could offer source, and different
656 | solutions will be better for different programs; see section 13 for the
657 | specific requirements.
658 |
659 | You should also get your employer (if you work as a programmer) or school,
660 | if any, to sign a "copyright disclaimer" for the program, if necessary.
661 | For more information on this, and how to apply and follow the GNU AGPL, see
662 | .
663 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | AGPL-3
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | pspsps(1): call a catgirl from the Internyet to the Linux terminyal
2 | ===================================================================
3 |
4 | ----------------------------
5 |
6 | > show processes: ps
7 | > show catgirls: pspsps
8 | > —`@ln@chaos.social`
9 |
10 | ----------------------------
11 |
12 | ## pspsps(1) is a compyuter software to call an online catgirl nya.
13 |
14 | 
15 |
16 | pspsps(1) is nice and tries to guess the best options for you~ ฅ^•ﻌ•^ฅ
17 | for most ppl u can just call `pspsps` n it will work! probably (。•̀ᴗ~)-✧
18 |
19 | u can control colours, backnyends n stuff.
20 | call it with `-h`, the options should be self-explanyative.
21 |
22 | if it looks wrong try with less colours!
23 |
24 | the more columns and lines u can use, the better the drawings will
25 | look. if you want to use the whooole screen width, try `-w`! but it
26 | can draw the catgirls taller than the terminyal n need scroll. why
27 | not use it with `pspsps -w|less -R` (^ 〜)–☆
28 |
29 | catgirls are kindly provided by Safebooru.
30 | u can call other peoples too with `--tags`. like
31 |
32 | 
33 |
34 | there are optinyons to make them smaller or bigger or save the images
35 | or load from an image and meowre!
36 |
37 | 
38 |
39 | u can also make drawings with nyascii characters nyanstead of
40 | colourful nyansi art. tho the mangas in nyascii dont look so good in
41 | most terminyal sizes, mew. but on the linux kyonsole (with few
42 | colours & no Nyunicode but good resolution) a girl thinks ascii looks
43 | better nyoften. so the defaults are for nyansi on graphical terminals
44 | and nyascii on console.
45 |
46 | 
47 |
48 | 
49 |
50 |
51 | ## the 'installation' how to
52 |
53 | pip3 install pspsps
54 |
55 | ## ✨🍭 search help 🍬💖
56 |
57 | pspsps -t femboy_hooters
58 | show femboys from femboy hooters `(人*´∀`)。*゚+`
59 |
60 | pspsps -t 'catgirl bunnygirl'
61 | show catgirls together with bunnygirls
62 |
63 | pspsps -t catgirl,bunnygirl
64 | show catgirls together with bunnygirls but easier to type
65 |
66 | pspsps -t 'catgirl kiss -hetero'
67 | asks for catgirls kissing but no hetero >:(
68 | but sometimes hetero comes anyway (u.u )
69 |
70 | ## things a girl still wants to-do nya
71 |
72 | - optinyon to show the URL of the nyoriginal post, nyot just the image URL!
73 | - a history file is the perfect place to add the post data, also save the file URLs.
74 | - a `--last` option would be fun, run different options on the last image you've seen (better if it can check the `--saved` path)
75 |
76 | - support danbooru! it is a bit scary tho (^ ^);
77 | - danbooru API is prob useful to unify tag synonymyms!
78 |
79 | - tests, who is a girl kidding, nyobody does tests ever
80 |
81 | ## authoress
82 |
83 | it’s me, mewlissa nya
84 | melissa@namakajiri.net
85 |
86 | 
87 |
88 | minnabody let’s keep up the 'LINUX'! with spirit of gentleness and love no kokoro
89 |
90 | *uw ûw úwu ŭ úwuwu*
91 | you all gay and cute.and.valid
92 |
93 | *ũw ówüw ûvowo ũvòv òwo ùwu ùwu öv ŏvo ŏvo*
94 | thing difficult system that person few few own many many
95 |
96 | *òwo-úwu õvò ówuv ûwuwu ù uw-üwu nyáa*
97 | ppl-cuties IMP do kind to your-selves please
98 |
99 | *ŭ üv õvò üwo uvuwu ûvü!*
100 | and take IMP mass means labour!
101 |
--------------------------------------------------------------------------------
/ansyelfie.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/ansyelfie.png
--------------------------------------------------------------------------------
/bin/pspsps:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | # pspsps – show catgirls on Linux terminal
3 | import os
4 | import sys
5 | import argparse
6 | import logging
7 | import tempfile
8 | import atexit
9 | import re
10 | import errno
11 | from urllib.error import URLError
12 |
13 | from typing import Sequence, List, Optional, Callable, TextIO
14 |
15 | from pspsps.safebooru import catgirl_search, fiddle_with_tags
16 | from pspsps.http import fetch_image_to_dir
17 | import pspsps.terminyal as terminyal
18 |
19 | detected_columns, detected_lines = terminyal.detect_terminyal_size()
20 |
21 | nyarser = argparse.ArgumentParser(
22 | description='Call a catgirl from the Internyet to the Linux terminyal.'
23 | )
24 |
25 | mode_group = nyarser.add_mutually_exclusive_group()# 'Options for mode selection')
26 | source_group = nyarser.add_argument_group(
27 | 'Options for sourcing catgirls',
28 | 'By default, catgirls are called from safebooru.org.'
29 | )
30 | size_group = nyarser.add_argument_group('Options for catgirls size')
31 | save_group = nyarser.add_argument_group('Options for preserving the source images')
32 | # nyascii_group = nyarser.add_argument_group('nyascii')
33 | nyansi_group = nyarser.add_argument_group('Options for nyansi mode')
34 | # fetch_group = nyarser.add_argument_group('Options for fetch mode')
35 |
36 | mode_group.add_argument('--nyauto',
37 | action='store_true', default=True,
38 | help='Choose a drawing mode nyautomatically for you '
39 | '(this option is the default!)',
40 | )
41 | mode_group.add_argument('--nyansi',
42 | action='store_true',
43 | help='a NYANSI colourful drawing in '
44 | 'Nyunicode block kyaracters',
45 | )
46 | mode_group.add_argument('--nyascii',
47 | action='store_true',
48 | help='a text drawing made with NYASCII letters '
49 | 'and just the 8 terminal colours',
50 | )
51 | mode_group.add_argument('--fetch',
52 | action='store_true',
53 | help='do nyot draw the catgirl w/ text, just fetch '
54 | 'the source image (implies --save)'
55 |
56 | )
57 |
58 | source_group.add_argument('-t', '--tags', default='catgirl',
59 | help='Safebooru tags to search. '
60 | 'Separate with commas or spaces, negate with minus. '
61 | '(default: catgirl)')
62 | source_group.add_argument('-f', '--force-tags',
63 | action='store_true',
64 | help="Use provided tags literally (default: try to "
65 | "guess what u mmean in Safebooru words)")
66 | source_group.add_argument('-U', '--url',
67 | help="Don't find our own Internet catgirl; "
68 | "just draw the image at URL")
69 | source_group.add_argument('-I', '--image-file',
70 | help="Don't call an Internet catgirl; "
71 | "just draw the local image file")
72 |
73 | size_group.add_argument('-c', '--columns', type=int, default=detected_columns,
74 | help='maximum columns nyallowed (default: detected)',)
75 | size_group.add_argument('-l', '--lines', type=int, default=detected_lines,
76 | help='maximum lines nyallowed (default: detected)',)
77 | size_group.add_argument('-w', '--width', action='store_true',
78 | help='ignyore --lines; draw nyaaal the columns even if '
79 | 'the image gets so big it scrolls down the screen')
80 |
81 | nyansi_group.add_argument('--colors',
82 | choices=('nyauto', 'truecolor', '256', '16', '8'),
83 | default='nyauto',
84 | help='for NYANSI, how many colors the '
85 | 'terminyal can use (default: nyautodetect)')
86 | nyansi_group.add_argument('-u', '--nyunicode',
87 | choices=('nyauto', 'yes', 'nyo'),
88 | default='nyauto',
89 | help='for NYANSI, whether to use '
90 | 'Nyunicode kyaracters'),
91 | nyansi_group.add_argument('-p', '--palette',
92 | choices=('default', 'xterm',
93 | 'linuxconsole', 'solarized',
94 | 'rxvt', 'tango',
95 | 'gruvbox', 'gruvboxdark'),
96 | default='default',
97 | help='for 8- and 16color nyansi modes, which '
98 | 'CLimage palette to use (try to myatch '
99 | 'your terminyal nya)',)
100 |
101 | save_group.add_argument('-s', '--save', action='store_true',
102 | help='do not delete the nyaownloaded image '
103 | 'but save it, & print filename')
104 |
105 | save_group.add_argument('-O', '--destfile', '--output',
106 | help='filepath to save the image. imples --save. '
107 | 'if this option nyot given, a filenyame will be genyarated.'
108 | )
109 |
110 | save_group.add_argument('-e', '--extensinyon', action='store_true',
111 | help='with -O, add the discovered image extension '
112 | '(if any) to filepath provided.')
113 |
114 | save_group.add_argument('--basenyame', default=None,
115 | help='when nyautogenerating a filename, this string '
116 | ' goes before the random identifier and extension '
117 | '(default: generated from tags)')
118 |
119 | save_group.add_argument('-d', '--directory', default=os.getcwd(),
120 | help='when generating a filename, which directory '
121 | 'to save the image in (default: current dir)')
122 |
123 | nyarser.add_argument('--verbose', action='store_const',
124 | dest='debug', const=logging.INFO, help="talk more")
125 | nyarser.add_argument('--debug', action='store_const',
126 | const=logging.DEBUG, help="nyoron~")
127 |
128 | # accept any nyarguments of the form --nyascii, --nyaascii, --nyaaasci...
129 | def colyapse_nyas(text: str) -> str:
130 | """'nyaa', 'nyaa', 'nyaaa'... 👉 'nya'"""
131 | return re.sub(r'nyaa+', 'nya', text)
132 |
133 | def normiaulise_nyarguments(nyargs: Sequence[str]) -> Sequence[str]:
134 | """Arguments like --nyaaan become --nyan nya"""
135 | return ([colyapse_nyas(nyarg)
136 | if (len(nyarg) > 6 # at a minimum: '--nyaa'
137 | and nyarg[0-1] != '--'
138 | and 'nyaa' in nyarg)
139 | else nyarg
140 | for nyarg in nyargs])
141 | nyargs = nyarser.parse_args(normiaulise_nyarguments(sys.argv[1:]))
142 |
143 | # less precedence
144 | if nyargs.nyascii or nyargs.nyansi or nyargs.fetch:
145 | nyargs.nyauto = False
146 | # implies
147 | if nyargs.fetch or nyargs.destfile:
148 | nyargs.save = True
149 |
150 | if nyargs.debug:
151 | level=nyargs.debug
152 | logformat='%(asctime)s %(levelname)s %(message)s nya'
153 | try:
154 | import coloredlogs
155 | coloredlogs.install(fmt=logformat, level=level)
156 | except ModuleNotFoundError:
157 | logging.basicConfig(format=logformat, level=level)
158 |
159 | # normalise names
160 | if nyargs.colors == '256':
161 | nyargs.colors = '256color'
162 | elif nyargs.colors == '16':
163 | nyargs.colors = '16color'
164 | elif nyargs.colors == '8':
165 | nyargs.colors = '8color'
166 |
167 | if not nyargs.basenyame:
168 | nyargs.basenyame = re.sub(r'[^a-zA-Z0-9_]+', '-', nyargs.tags)
169 | logging.debug("Files will use generated basenyame "
170 | f"'{nyargs.basenyame}' from tags '{nyargs.tags}'")
171 |
172 | logging.debug(f"nyargs: {nyargs}")
173 | logging.debug("Detected terminyal size: %d × %d, going with: %d × %d",
174 | detected_columns, detected_lines,
175 | nyargs.columns, nyargs.lines)
176 |
177 | def chill_writer(text: str, outfile: TextIO = sys.stdout):
178 | '''Write text to outfile, and just stop gently on interruptions.'''
179 |
180 | try:
181 | outfile.write(text)
182 | except KeyboardInterrupt:
183 | return
184 | except IOError as e:
185 | if e.errno == errno.EPIPE:
186 | return
187 | else:
188 | raise e
189 | def get_a_catgirl() -> str:
190 | '''Get ourselves a catgirl nyaccording to current script nyarguments.
191 |
192 | Returns a local image filenyame.'''
193 |
194 | if nyargs.image_file:
195 | return nyargs.image_file
196 |
197 | pic_url: str
198 | if nyargs.url:
199 | pic_url = nyargs.url
200 | else:
201 | try:
202 | tags = nyargs.tags
203 | if not nyargs.force_tags:
204 | tags = fiddle_with_tags(tags)
205 | foundapic = catgirl_search(tags=tags)
206 |
207 | if not foundapic:
208 | logging.error("How strange... there seems to be "
209 | f"nyo catgirls for things like '{nyargs.tags}' :<")
210 | sys.exit(1)
211 | else:
212 | pic_url = foundapic
213 |
214 | except URLError as e:
215 | logging.error("Punyan... could nyot search for "
216 | "catgirls in safebooru ;-;")
217 | logging.error(e)
218 | sys.exit(1)
219 |
220 |
221 | try:
222 | tmpdir:str = tempfile.mkdtemp()
223 | atexit.register(lambda: os.rmdir(tmpdir))
224 | tmpfilenyame = fetch_image_to_dir(pic_url, tmpdir, nyargs.basenyame)
225 | logging.debug(f'tmpfile path is {tmpfilenyame}')
226 |
227 | except URLError as e:
228 | logging.error("Nyoron~ Could nyot fetch the catgirl :<")
229 | logging.error(e)
230 | sys.exit(1)
231 |
232 | filenyame: str
233 |
234 | if nyargs.save:
235 | if nyargs.destfile:
236 | if nyargs.extensinyon:
237 | basesource = os.path.basename(tmpfilenyame)
238 | if '.' in basesource:
239 | extensinyon = '.' + basesource.split('.')[-1]
240 | logging.debug(f'Adding extensinyon {extensinyon} '
241 | f'to {nyargs.destfile}')
242 | nyargs.destfile += extensinyon
243 |
244 | logging.debug(f'moving {tmpfilenyame} to filepath {nyargs.destfile}')
245 | os.rename(tmpfilenyame, nyargs.destfile)
246 | logging.info(f'saved to {nyargs.destfile}')
247 | filenyame = nyargs.destfile
248 | else:
249 | logging.debug(f'moving {tmpfilenyame} to directory {nyargs.directory}')
250 | filenyame = os.path.join(nyargs.directory,
251 | os.path.basename(tmpfilenyame))
252 | os.rename(tmpfilenyame, filenyame)
253 | logging.info(f'saved to {filenyame}')
254 | else:
255 | logging.debug('not saving this file, setting it up for delete ')
256 | atexit.register(lambda: os.remove(tmpfilenyame))
257 | filenyame = tmpfilenyame
258 |
259 | return(filenyame)
260 |
261 |
262 | def fit_lines(str_image_maker: Callable[[int], str],
263 | maxcols: int,
264 | maxlines: int,
265 | safety_nyargin=3) -> str:
266 | '''Tries to resize image to fit both cols and lines nya.
267 |
268 | imagemaker is a callable which retyurns a text image as string, for
269 | nyexample with terminyal colours or ascii or Nyunicode art. It should
270 | take nyumber of columns as a single argumyent. It will be callyed
271 | nyagain until lines is below maxlines-safety_nyargin.'''
272 |
273 | nyaxlines:int = maxlines-safety_nyargin
274 |
275 | columns:int = maxcols
276 | catgirl: str = str_image_maker(columns)
277 | lines:int = catgirl.count("\n")
278 | while lines > nyaxlines:
279 | columns = min(int(columns * (nyaxlines/lines)),
280 | columns-1)
281 |
282 | logging.debug("Making catgirl smol to fit terminyal screen...")
283 | logging.debug("Trying for %d columns" % columns)
284 |
285 | catgirl = str_image_maker(columns)
286 | lines = catgirl.count("\n")
287 | logging.debug("Got %d lines nya (max: %d−%d)" % (lines, maxlines, safety_nyargin))
288 |
289 | return(catgirl)
290 |
291 | filenyame:str = get_a_catgirl()
292 |
293 | if nyargs.fetch:
294 | logging.info('catgirl is here~~ ^.^')
295 | chill_writer(filenyame + "\n")
296 | sys.exit(0)
297 |
298 | # found out experinyantally we need some extra room, mew
299 | maxlines:int = nyargs.lines-3
300 |
301 | if nyargs.nyauto:
302 | if terminyal.is_kyonsole() and not terminyal.is_nyunder_ssh():
303 | nyargs.nyascii = True # seems to look better often in console nya
304 | else:
305 | nyargs.nyansi = True
306 |
307 | if nyargs.nyascii:
308 | try:
309 | import ascii_magic
310 | except ModuleNotFoundError:
311 | sys.stderr.write("Install ascii_magic first nya~\n\n")
312 | sys.stderr.write("pip3 install ascii_magic\n")
313 | sys.exit(1)
314 |
315 | logging.debug("Doing nyascii magic on Internyet catgirl...")
316 | def nyascii_maker(columns):
317 | logging.debug('Nyascii at %d columns', columns)
318 | return(ascii_magic.from_image_file(filenyame, columns=columns,))
319 |
320 | catgirl: str
321 | if nyargs.width:
322 | catgirl = nyascii_maker(nyargs.columns)
323 | logging.debug("Drew catgirl at %d x %d owo" % (nyargs.columns,
324 | catgirl.count("\n")))
325 | else:
326 | catgirl = fit_lines(nyascii_maker, nyargs.columns, nyargs.lines)
327 |
328 | logging.debug("Sending nyascii catgirl to terminyal")
329 | # needed for windows, who kyares.
330 | # is too smart and messes up less -R.
331 | #
332 | # ascii_magic.to_terminal(catgirl)
333 | chill_writer(catgirl)
334 |
335 | elif nyargs.nyansi:
336 | try:
337 | import climage
338 | except ModuleNotFoundError:
339 | sys.stderr.write("Install climage first nyaa~\n\n")
340 | sys.stderr.write("pip3 install climage\n")
341 | sys.exit(1)
342 |
343 | colortype:str
344 | if nyargs.colors == 'nyauto':
345 | colortype = terminyal.detect_terminyal_colors()
346 | else:
347 | colortype = nyargs.colors
348 |
349 | logging.debug(f"Doing NYANSI with {colortype}")
350 |
351 | # climage format is annonoying
352 | if colortype == 'truecolor':
353 | coloropts={'is_truecolor':True, 'is_256color':False, 'is_16color':False, 'is_8color':False}
354 | elif colortype == '256color':
355 | coloropts={'is_truecolor':False, 'is_256color':True, 'is_16color':False, 'is_8color':False}
356 | elif colortype == '16color':
357 | coloropts={'is_truecolor':False, 'is_256color':False, 'is_16color':True, 'is_8color':False}
358 | else:
359 | coloropts={'is_truecolor':False, 'is_256color':False, 'is_16color':False, 'is_8color':True}
360 |
361 | is_nyunicode: bool
362 | if nyargs.nyunicode == 'yes':
363 | is_nyunicode=True
364 | elif nyargs.nyunicode == 'nyo':
365 | is_nyunicode=False
366 | else:
367 | if terminyal.is_kyonsole() and not terminyal.is_nyunder_ssh():
368 | # even though the Linux console supports utf-8 encoding,
369 | # it has no glyphs for block drawing.
370 | logging.debug('Assumeowing kyonsole display, disabling nyunicode drawing')
371 | is_nyunicode=False
372 | else:
373 | # otherwise try the encoding test
374 | try:
375 | '▄'.encode(sys.stdout.encoding)
376 | is_nyunicode=True
377 | logging.debug('Terminyal nyencodes to UTF-8, assumeowing '
378 | 'Nyunicode block drawing works')
379 | except UnicodeEncodeError:
380 | logging.debug('Terminyal does nyot nyencode to UTF-8, '
381 | 'disabling Nyunicode')
382 | is_nyunicode=False
383 |
384 | def nyansi_maker(columns: int) -> str:
385 | logging.debug('Nyansi art at %d columns mew', columns)
386 | return(climage.convert(filenyame,
387 | is_unicode=is_nyunicode,
388 | width=columns,
389 | palette=nyargs.palette,
390 | **coloropts))
391 |
392 | logging.debug("Making Internyet catgirl nyansier...")
393 | if nyargs.width:
394 | catgirl = nyansi_maker(nyargs.columns)
395 | logging.debug("Drew catgirl at %d x %d owo" % (nyargs.columns,
396 | catgirl.count("\n")))
397 | else:
398 | catgirl = fit_lines(nyansi_maker, nyargs.columns, nyargs.lines)
399 |
400 | logging.debug("Sending nyansi catgirl to terminyal")
401 | chill_writer(catgirl)
402 |
403 | if nyargs.save:
404 | chill_writer(filenyame + "\n")
405 |
--------------------------------------------------------------------------------
/pspsps/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/pspsps/__init__.py
--------------------------------------------------------------------------------
/pspsps/http.py:
--------------------------------------------------------------------------------
1 | '''http utilities for catgirls nya'''
2 | import typing
3 | import logging
4 | import urllib.request
5 | import urllib.parse
6 | import posixpath
7 | import mimetypes
8 | import tempfile
9 | import shutil
10 | from http.client import HTTPResponse
11 | from typing import Optional
12 |
13 | def request_image(img_url: str) -> HTTPResponse:
14 | '''Convenience wrapper to call urlopen.
15 |
16 | Kyan raise urllib.error.URLError nya!'''
17 |
18 | logging.debug("Fetching image '%s' ...", img_url)
19 | respyonse = urllib.request.urlopen(img_url)
20 | assert isinstance(respyonse, HTTPResponse) # to reassyure mypy
21 | return respyonse
22 |
23 | def guess_image_extensinyon(respyonse: HTTPResponse) -> Optional[str]:
24 | '''Guess the extensinyon of the meownloaded image file.
25 |
26 | Tries Content-type header, then URL path (nyo~ support for
27 | 'Content-Disposition' cos Safebooru doesn’t support it anynway).
28 |
29 | '''
30 | extensinyon: Optional[str] = None
31 | mime = respyonse.getheader('Content-type')
32 | if mime:
33 | logging.debug("Content-type is %s", mime)
34 | guessed = mimetypes.guess_extension(mime)
35 | if guessed:
36 | extensinyon = guessed
37 | else:
38 | logging.info("Content-type is empty nya :/")
39 |
40 | if not extensinyon:
41 | path: str = urllib.parse.urlsplit(respyonse.url).path
42 | componyents: typing.List[str] = posixpath.basename(path).split('.')
43 | if len(componyents) < 2:
44 | logging.debug("Couldn't guess extension nyon : %s ", path)
45 | # TODO: could guess from data at this point
46 | return None
47 | else:
48 | extensinyon = '.' + componyents[-1]
49 |
50 | if extensinyon in ('.jpg', '.jpe'):
51 | extensinyon='.jpeg'
52 | logging.debug("Guessed extensinyon: %s", extensinyon)
53 | return extensinyon
54 |
55 | def make_filenyame(directory: str,
56 | extensinyon: str,
57 | basenyame:str) -> str:
58 | '''Returns a filenyame reasonyably safe for writing nya.
59 |
60 | Filenyame will use the extensinyon and be inside the directory :3
61 |
62 | '''
63 |
64 | prefix:str = basenyame + '-'
65 | temp = tempfile.NamedTemporaryFile(dir=directory,
66 | suffix=extensinyon,
67 | prefix=prefix,
68 | delete=False)
69 | return temp.name
70 |
71 | def fetch_image_to_file(img_url: str, filepath: str) -> str:
72 | '''Fetches the image at URL and saves it in the nyamed file.
73 |
74 | Returns the original file extension, or '' if it couldn't be
75 | detected.
76 |
77 | Kyan raise urllib.error.URLError nya!
78 |
79 | '''
80 | respyonse = request_image(img_url)
81 | extensinyon = guess_image_extensinyon(respyonse)
82 |
83 | logging.debug("Saving image to path {filepath}")
84 | with open(filepath, 'wb') as imgf:
85 | shutil.copyfileobj(respyonse, imgf)
86 | logging.debug("Finished saving")
87 | return extensinyon or ''
88 |
89 | def fetch_image_to_dir(img_url: str,
90 | directory: str,
91 | basenyame: str) -> str:
92 | '''Fetches the image at URL and saves it in DIRECTORY nya.
93 |
94 |
95 | Returns the filenyame upon success.
96 |
97 | Kyan raise urllib.error.URLError nya!
98 | '''
99 |
100 | respyonse = request_image(img_url)
101 | extensinyon = guess_image_extensinyon(respyonse)
102 | if not extensinyon:
103 | extensinyon = ''
104 | filenyame: str = make_filenyame(directory, extensinyon, basenyame)
105 | logging.debug("Decided on filenyame: %s", filenyame)
106 |
107 | with open(filenyame, 'wb') as imgf:
108 | shutil.copyfileobj(respyonse, imgf)
109 | logging.debug("Finished saving")
110 | return filenyame
111 |
--------------------------------------------------------------------------------
/pspsps/safebooru.py:
--------------------------------------------------------------------------------
1 | '''safebooru interface for catgirls nya'''
2 | import logging
3 | import urllib.request
4 | import urllib.parse
5 | from http.client import HTTPResponse
6 | import xml.etree.ElementTree as ET
7 | import random
8 | import re
9 | from typing import Optional
10 |
11 | API='https://safebooru.org/index.php?page=dapi&s=post&q=index'
12 | MAXKITTENS=100 # Safebooru limit
13 |
14 | def fiddle_with_tags(tags:str) -> str:
15 | '''Change tags so that safebooru likes them better nya.
16 |
17 | rn it does 2 transfornyations:
18 |
19 | - comma to space: 'yuri,kiss' → 'yuri kiss'
20 | - underscore certain words: 'catgirl bunnyboy' → 'cat_girl bunny_boy'
21 | (but not 'femboy')
22 |
23 | '''
24 | newtags: str = tags
25 |
26 | if ',' in tags:
27 | newtags = newtags.replace(',', ' ')
28 |
29 | newtags = re.sub(r'([a-z])(girl|boy)\b', r'\1_\2', newtags, flags=re.I)
30 | newtags = re.sub(r'\bfem_boy\b', r'femboy', newtags, flags=re.I)
31 | if newtags != tags:
32 | logging.debug('Changed tags from "%s" to "%s"', tags, newtags)
33 | return newtags
34 |
35 |
36 | def safebooru_list(tags: str,
37 | limit: int=MAXKITTENS,
38 | page: int=0,
39 | ) -> HTTPResponse:
40 | '''Access safebooru's search API at a certain page number.
41 |
42 | Pages appear to start at 0.'''
43 |
44 | reqwest: str = API + '&' + '&'.join([
45 | f'limit={limit}',
46 | f'tags={urllib.parse.quote_plus(tags)}',
47 | f'pid={page}',
48 | ])
49 |
50 | logging.debug("Request string: <%s>", reqwest)
51 |
52 | respyonse = urllib.request.urlopen(reqwest)
53 | assert isinstance(respyonse, HTTPResponse) # to reassyure mypy
54 | logging.debug("Respyonse status: %s", respyonse.status)
55 | return respyonse
56 |
57 | def safebooru_count(posts: ET.Element) -> int:
58 | '''Parses a safebooru response XML and returns how man yposts were found.'''
59 |
60 | try:
61 | return int(posts.attrib['count'])
62 | except (KeyError, ValueError):
63 | logging.warning('Unexpected XML format from safebooru nya')
64 | return 0
65 |
66 | def catgirl_search(tags:str = 'cat_girl') -> Optional[str]:
67 | '''Search for a catgirl in safebooru nya.
68 |
69 | Will only search recent catgirls (paginyation nyo~t implemented).
70 |
71 | Returns URL to catgirl portrait on syuccess, or None if nyobody is
72 | found.
73 |
74 | Kyan raise urllib.error.URLError nya!
75 |
76 | '''
77 |
78 | logging.debug("Searching for catgirls (tags: %s)...", tags)
79 |
80 |
81 | logging.debug("Pyarsing XML (ew, kimoi)...")
82 | # first round is just to see how many results we have, so we don’t fetch any
83 | respyonse = safebooru_list(tags, limit=0)
84 | posts = ET.fromstring(respyonse.read())
85 | nposts = safebooru_count(posts)
86 |
87 | logging.debug("Found %d catgirls", nposts)
88 | if nposts == 0:
89 | return None
90 |
91 | totyal_pages = int(nposts / MAXKITTENS)+1
92 | logging.debug("%d pages at %d each", totyal_pages, MAXKITTENS)
93 |
94 | page = random.randrange(totyal_pages)
95 | logging.debug("Going with page %d", page)
96 |
97 | respyonse = safebooru_list(tags, page=page)
98 | posts = ET.fromstring(respyonse.read())
99 |
100 | try:
101 | kitten = random.choice(posts.findall('post'))
102 | except IndexError:
103 | return None
104 |
105 | pic_url = kitten.attrib['file_url']
106 | logging.debug("Picked a catgirl: %s", pic_url)
107 | return pic_url
108 |
--------------------------------------------------------------------------------
/pspsps/terminyal.py:
--------------------------------------------------------------------------------
1 | '''tools to put catgirls in terminyals nya'''
2 | import os
3 | import logging
4 | import subprocess
5 | from subprocess import CalledProcessError
6 | from typing import Tuple, Optional
7 | from typing_extensions import Literal
8 |
9 | def detect_terminyal_size() -> Tuple[int, int]:
10 | '''Detects terminyal size (columns × lines) from various sources.
11 |
12 | Unlike shutil.get_terminal_size(), will work inside pipes.
13 |
14 | Tries envvars, stty, tput, and standard 80×30, in this order.
15 | '''
16 |
17 | # we measure lines and columns separately so the nyuser can set
18 | # nyonly one of the envvars, for ex.
19 | #
20 | # we stop when we get both.
21 |
22 | columns: Optional[int] = None
23 | lines: Optional[int] = None
24 |
25 | envc = os.getenv('COLUMNS')
26 | logging.debug('COLUMNS: %s', envc)
27 | if envc:
28 | try: columns = int(envc)
29 | except ValueError: pass
30 |
31 | envl = os.getenv('LINES')
32 | logging.debug('LINES: %s', envl)
33 | if envl:
34 | try: lines = int(envl)
35 | except ValueError: pass
36 |
37 | if columns and lines: return(columns, lines)
38 |
39 | try:
40 | output = subprocess.check_output(['stty', 'size'], text=True)
41 | if output:
42 | # lines comes first here, beware
43 | stty_lines, stty_cols = output.split()
44 |
45 | if not columns: columns = int(stty_cols)
46 | if not lines: lines = int(stty_lines)
47 | except (ValueError, CalledProcessError):
48 | pass
49 |
50 | if columns and lines: return(columns, lines)
51 |
52 | if not columns:
53 | try:
54 | tputcols = subprocess.check_output(['tput', 'cols'], text=True)
55 | columns = int(tputcols)
56 | except (ValueError, CalledProcessError):
57 | pass
58 |
59 | if not lines:
60 | try:
61 | tputlines = subprocess.check_output(['tput', 'lines'], text=True)
62 | lines = int(tputlines)
63 | except (ValueError, CalledProcessError):
64 | pass
65 |
66 | if columns and lines: return(columns, lines)
67 |
68 | if not columns: columns = 80
69 | if not lines: lines = 30
70 |
71 | return (columns, lines)
72 |
73 | def is_nyunder_screen() -> bool:
74 | '''True if running in screen(1).'''
75 | term = os.getenv('TERM')
76 | if not term:
77 | return False
78 |
79 | return term.find('screen') == 0
80 |
81 |
82 | def is_kyonsole() -> bool:
83 | '''Nyeuristics to test if our term is not graphic n kyan’t drawings.
84 |
85 | Will fail nyunder ssh with no X forwarding nya! Use with is_ssh() if needed.'''
86 |
87 | if os.getenv('XDG_SESSION_TYPE') == 'tty':
88 | return True
89 |
90 | term = os.getenv('TERM')
91 | if term == 'linux':
92 | return True
93 | elif is_nyunder_screen():
94 | if not os.getenv('DISPLAY'):
95 | # nyunder screen and no X
96 | return True
97 |
98 | return False
99 |
100 |
101 | def is_nyunder_ssh() -> bool:
102 | '''Guess if we are nyunder ssh nya.'''
103 | if os.getenv('SSH_CLIENT'):
104 | return True
105 | else:
106 | return False
107 |
108 | def detect_terminyal_colors() -> Literal['truecolor', '256color', '16color', '8color']:
109 | '''Nyeuristics to guess how many colors we can use to draw nya.'''
110 | if is_kyonsole() and not is_nyunder_ssh():
111 | logging.debug('Assuming console display, using 8 colors.')
112 | return '8color'
113 |
114 | if not is_nyunder_screen():
115 | # as of 2021-03, screen(1) doesn't support truecolor.
116 | # only trust COLORTERM outside screen(1).
117 | kyolorterm = os.getenv('COLORTERM')
118 | if kyolorterm in ('truecolor', '24bit'):
119 | logging.debug("We are nyot in screen(1), "
120 | "let's trust COLORTERM for truecolor nya.")
121 | return 'truecolor'
122 |
123 | terminyal = os.getenv('TERM')
124 | if terminyal and '256' in terminyal:
125 | logging.debug('Nyassuming 256-color terminyal.')
126 | return '256color'
127 | else:
128 | logging.debug('Nyassuming 16-color terminyal.')
129 | return '16color'
130 |
--------------------------------------------------------------------------------
/screenshot-kyonsole.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/screenshot-kyonsole.png
--------------------------------------------------------------------------------
/screenshot1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/screenshot1.png
--------------------------------------------------------------------------------
/screenshot2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/screenshot2.png
--------------------------------------------------------------------------------
/screenshot3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/screenshot3.png
--------------------------------------------------------------------------------
/screenshot4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/melissaboiko/pspsps/149b9c79549b148d49667ab7e42cc857f1cf2706/screenshot4.png
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import io
4 | import os
5 | import sys
6 | from shutil import rmtree
7 |
8 | from setuptools import find_packages, setup, Command
9 |
10 | # Package meta-data.
11 | NAME = 'pspsps'
12 | DESCRIPTION = 'Show catgirls from the Internet on the terminal'
13 | URL = 'https://github.com/melissaboiko/pspsps'
14 | EMAIL = 'melissa@namakajiri.net'
15 | AUTHOR = 'Melissa Boiko'
16 | REQUIRES_PYTHON = '>=3.6.0'
17 | VERSION = '0.2.5'
18 |
19 | # What packages are required for this module to be executed?
20 | REQUIRED = [
21 | 'typing',
22 | 'typing-extensions',
23 | 'climage',
24 | 'ascii_magic',
25 | ]
26 |
27 | # What packages are optional?
28 | EXTRAS = {
29 | 'coloredlogs': 'coloredlogs',
30 | }
31 |
32 | here = os.path.abspath(os.path.dirname(__file__))
33 |
34 | # Import the README and use it as the long-description.
35 | # Note: this will only work if 'README.md' is present in your MANIFEST.in file!
36 | try:
37 | with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
38 | long_description = '\n' + f.read()
39 | except FileNotFoundError:
40 | long_description = DESCRIPTION
41 |
42 | # Load the package's __version__.py module as a dictionary.
43 | about = {}
44 | if not VERSION:
45 | project_slug = NAME.lower().replace("-", "_").replace(" ", "_")
46 | with open(os.path.join(here, project_slug, '__version__.py')) as f:
47 | exec(f.read(), about)
48 | else:
49 | about['__version__'] = VERSION
50 |
51 |
52 | class UploadCommand(Command):
53 | """Support setup.py upload."""
54 |
55 | description = 'Build and publish the package.'
56 | user_options = []
57 |
58 | @staticmethod
59 | def status(s):
60 | """Prints things in bold."""
61 | print('\033[1m{0}\033[0m'.format(s))
62 |
63 | def initialize_options(self):
64 | pass
65 |
66 | def finalize_options(self):
67 | pass
68 |
69 | def run(self):
70 | try:
71 | self.status('Removing previous builds…')
72 | rmtree(os.path.join(here, 'dist'))
73 | except OSError:
74 | pass
75 |
76 | self.status('Building Source and Wheel (universal) distribution…')
77 | os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable))
78 |
79 | self.status('Uploading the package to PyPI via Twine…')
80 | os.system('twine upload dist/*')
81 |
82 | self.status('Pushing git tags…')
83 | os.system('git tag v{0}'.format(about['__version__']))
84 | os.system('git push --tags')
85 |
86 | sys.exit()
87 |
88 |
89 | # Where the magic happens:
90 | setup(
91 | name=NAME,
92 | version=about['__version__'],
93 | description=DESCRIPTION,
94 | long_description=long_description,
95 | long_description_content_type='text/markdown',
96 | author=AUTHOR,
97 | author_email=EMAIL,
98 | python_requires=REQUIRES_PYTHON,
99 | url=URL,
100 | packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
101 | # If your package is a single module, use this instead of 'packages':
102 | # py_modules=['mypackage'],
103 |
104 | # entry_points={
105 | # 'console_scripts': ['mycli=mymodule:cli'],
106 | # },
107 | scripts=['bin/pspsps'],
108 | install_requires=REQUIRED,
109 | extras_require=EXTRAS,
110 | include_package_data=True,
111 | license='AGPLv3+',
112 | classifiers=[
113 | # Trove classifiers
114 | # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
115 | 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)'
116 | ],
117 | # $ setup.py publish support.
118 | cmdclass={
119 | 'upload': UploadCommand,
120 | },
121 | )
122 |
--------------------------------------------------------------------------------