├── .gitignore ├── COPYING ├── COPYING.LESSER ├── Makefile ├── README.md ├── TODO.md ├── pixcat ├── __about__.py ├── __init__.py ├── __main__.py ├── cli.py ├── data.py ├── grid.py ├── image.py └── terminal.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | build 3 | dist 4 | *.egg-info 5 | *.pyc 6 | 7 | .pylintrc 8 | 9 | tmp-* 10 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 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 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant 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 install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | 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 updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 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 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper 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 | Copyright (C) 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 appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /COPYING.LESSER: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | PKG_DIR = pixcat 5 | 6 | PYTHON = python3 7 | PIP = pip3 8 | PYLINT = pylint 9 | CLOC = cloc 10 | 11 | ARCHIVE_FORMATS = gztar 12 | INSTALL_FLAGS = --user --editable 13 | PYLINT_FLAGS = --output-format colorized 14 | CLOC_FLAGS = --ignore-whitespace 15 | 16 | .PHONY: all clean dist install upload test 17 | 18 | 19 | all: clean dist install 20 | 21 | clean: 22 | find . -name '__pycache__' -exec rm -Rfv {} + 23 | find . -name '*.pyc' -exec rm -Rfv {} + 24 | find . -name '*.egg-info' -exec rm -Rfv {} + 25 | rm -Rfv build dist 26 | 27 | dist: clean 28 | @echo 29 | ${PYTHON} setup.py sdist --format ${ARCHIVE_FORMATS} 30 | @echo 31 | ${PYTHON} setup.py bdist_wheel 32 | 33 | install: clean 34 | @echo 35 | ${PIP} install ${INSTALL_FLAGS} . 36 | 37 | 38 | upload: dist 39 | @echo 40 | twine upload dist/* 41 | 42 | 43 | test: 44 | - ${PYLINT} ${PYLINT_FLAGS} ${PKG_DIR} *.py 45 | @echo 46 | ${CLOC} ${CLOC_FLAGS} ${PKG_DIR} 47 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pixcat 2 | 3 | [![PyPI downloads](http://pepy.tech/badge/pixcat)]( 4 | http://pepy.tech/project/pixcat) 5 | [![PyPI version](https://img.shields.io/pypi/v/pixcat.svg)]( 6 | https://pypi.org/project/pixcat) 7 | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/pixcat.svg)]( 8 | https://pypi.python.org/pypi/pixcat) 9 | 10 | **WORK IN PROGRESS** 11 | 12 | Display images on a [kitty](https://sw.kovidgoyal.net/kitty/) terminal 13 | with optional custom/thumbnail/fit-to-screen resizing. 14 | Developed with the goal of being a more powerful alternative to `kitty icat`, 15 | while also providing an usable Python 3.6+ API. 16 | 17 | ## Usage 18 | 19 | Basic CLI examples: 20 | 21 | ```sh 22 | pixcat file.jpg 23 | 24 | pixcat fit-screen --enlarge /tmp/abc.jpg 25 | 26 | pixcat thumbnail --size 128 --align left 'https://picsum.photos/480?random' 27 | 28 | pixcat resize --min-width 1920 --min-height 1080 \ 29 | --max-width 1920 --max-height 1080 \ 30 | ~/images/wallpapers 1.jpg 2.png 31 | ``` 32 | 33 | The commands and options have short forms too. 34 | See `pixcat --help` for more information. 35 | 36 | Same examples using the Python package (no documentation yet): 37 | 38 | ```python3 39 | from pixcat import Image 40 | 41 | Image("file.jpg").show() 42 | 43 | Image("/tmp/abc.jpg").fit_screen(enlarge=True).show() 44 | 45 | Image("https://picsum.photos/480?random").thumbnail(128).show(align="left") 46 | 47 | for i in Image.factory("~/images/wallpapers", "1.jpg", "2.png"): 48 | i.resize(1920, 1080, 1920, 1080).show() 49 | ``` 50 | 51 | ## Installation 52 | 53 | Requires Python 3.6+, tested on GNU/Linux only. 54 | 55 | ```sh 56 | pip3 install --upgrade pixcat 57 | ``` 58 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | - Independent sizes for cols/rows 2 | - Nested grids 3 | - Vertical align option 4 | - Move print path/name/etc to Image functions 5 | 6 | - Clearing images stuff 7 | 8 | - Use standard .thumbnails caches? 9 | - Parallel requests 10 | 11 | - Better README, documentation 12 | -------------------------------------------------------------------------------- /pixcat/__about__.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | """Display images on a kitty terminal with optional resizing.""" 5 | 6 | __pkg_name__ = "pixcat" 7 | __version__ = "0.1.4" 8 | __status__ = "Development" 9 | # __status__ = "Production" 10 | 11 | __author__ = "miruka" 12 | __email__ = "miruka@disroot.org" 13 | 14 | __license__ = "LGPLv3" 15 | -------------------------------------------------------------------------------- /pixcat/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | from . import data, terminal 5 | from .__about__ import __doc__ 6 | from .image import Image 7 | from .grid import Grid 8 | -------------------------------------------------------------------------------- /pixcat/__main__.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | "Call cli.main() when this package is executed from 'python -m '." 5 | 6 | from . import cli 7 | 8 | cli.main() 9 | -------------------------------------------------------------------------------- /pixcat/cli.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | """Usage: 5 | pixcat (-d|--detect-support) 6 | pixcat [r|resize | t|thumbnail | f|fit-screen] [options] LOCATION... 7 | 8 | Display images on a kitty terminal with optional resizing. 9 | 10 | For resizing options, measures (INT number arguments) are in pixel by default. 11 | To indicate columns/rows instead, prefix the number with a dash. 12 | 13 | Positioning options are always in columns/rows. 14 | 15 | Arguments: 16 | LOCATION: File, folder to be be scanned recursively for images, or URL. 17 | Any number of file, folder or URLs can be specified. 18 | 19 | Options: 20 | Resizing: 21 | -S, --stretch Do not force keeping the original aspect ratio. 22 | -r ALGO, --resample ALGO From fastest/worse to slowest/best quality: 23 | nearest, bilinear, bicubic, lanczos (default). 24 | 25 | Specific to r/resize: 26 | -w INT, --min-width INT Upscale when width is lower than INT. 27 | -h INT, --min-height INT Upscale when height is lower than INT. 28 | -W INT, --max-width INT Downscale when height is higher than INT. 29 | -H INT, --max-height INT Downscale when height is higher than INT. 30 | 31 | Specific to t/thumbnail: 32 | -s INT, --size INT Scale to INTxINT, default 256. 33 | 34 | Specific to f/fit-screen: 35 | -e, --enlarge Scale up for images smaller than terminal. 36 | -o INT, --horizontal-margin INT Have a left-right padding of INT columns. 37 | -v INT, --vertical-margin INT Have a top-bottom padding of INT columns. 38 | 39 | Positioning: 40 | -x INT, --absolute-x INT Left image origin in columns, from terminal left. 41 | -y INT, --absolute-y INT Top image origin in rows, from terminal top. 42 | -z INT, --z-index INT Images are drawn in front of others that have a 43 | lower index. -1 and lower will draw behind text. 44 | 45 | -X INT, --relative-x INT Like -x, but from current cursor position. 46 | -Y INT, --relative-y INT Like -y, but from current cursor position. 47 | 48 | -a ALI, --align ALI Image and text alignement, -X is added to it. 49 | left, center (default) or right. 50 | 51 | -f INT, --offset-x INT Left offset in pixel, max is column width. 52 | -F INT, --offset-y INT Top offset in pixel, max is row height. 53 | 54 | -c INT, --crop-w INT Crop image left-to-right to INT pixels. 55 | -C INT, --crop-h INT Crop image top-to-bottom to INT pixels. 56 | 57 | General: 58 | -O, --print-origin Print image origin, like a path or URL. 59 | -n, --print-name Print image filename. 60 | -i, --print-id Print kitty image ID. 61 | 62 | -q, --quiet Keep quiet about errors, e.g. "cannot identify image" 63 | -R, --raise-errors Exit and show full traceback if an error happens. 64 | 65 | -g, --hang Wait for an enter keypress between every image. 66 | -G, --hang-final Wait for enter keypress after all images are drawn. 67 | 68 | -d, --detect-support Exit with 0 if terminal supports images, else 1. 69 | 70 | 71 | Standard: 72 | -- Mark the end of options, useful if a LOCATION starts by a dash. 73 | --help Show this help. 74 | --version Show the program version. 75 | 76 | Examples: 77 | pixcat image.jpg 78 | Just display image.jpg, no resizing. 79 | If the width exceeds the terminal's, it will be cropped. 80 | 81 | pixcat fit-screen --enlarge image.jpg 82 | Display image.jpg, downscale or upscale (if --enlarge) when necessary to 83 | make image match terminal dimensions. 84 | 85 | pixcat resize -w 64 -h 32 -W 512 -H 256 --align right --relative-x -2 *.png 86 | Display all png files in the current dir with a size of at least 64x32 and 87 | no bigger than 512x256. 88 | 89 | Align the pictures against the terminal's right edge, 90 | minus 2 columns (negative --relative-x). 91 | 92 | pixcat thumbnail --size 128 --resample nearest dir1 dir2 93 | Recursively find and display images in dir1 and dir2, 94 | with a min-max-size of 128x128 (aspect ratio will be taken into account). 95 | 96 | The nearest rescaling algorithm will trade quality for speed, useful 97 | if there are a lot of images to display. 98 | 99 | pixcat t -s 128 -r nearest dir1 dir2 100 | Same as the command above, short form. 101 | 102 | Bugs and limitations: 103 | - Does not work in tmux 104 | - Resizing the terminal can lead to a mess, use clear/CTRL+L to fix it.""" 105 | 106 | 107 | import sys 108 | from pathlib import Path 109 | from typing import List, Optional 110 | 111 | import docopt 112 | 113 | from . import Image, data 114 | from .__about__ import __version__ 115 | from .terminal import TERM 116 | 117 | 118 | def main(argv: Optional[List[str]] = None) -> None: 119 | argv = argv if argv is not None else sys.argv[1:] 120 | 121 | try: 122 | params = docopt.docopt(__doc__, argv=argv, version=__version__) 123 | except docopt.DocoptExit: 124 | if len(sys.argv) > 1: 125 | print("Invalid command syntax, check help:\n") 126 | 127 | main(["--help"]) 128 | sys.exit(1) 129 | 130 | if params["--detect-support"]: 131 | sys.exit(0 if TERM.detect_support() else 1) 132 | 133 | images = Image.factory( 134 | *params["LOCATION"], 135 | raise_errors = params["--raise-errors"], 136 | print_errors = not params["--quiet"] 137 | ) 138 | 139 | for image in images: 140 | handle_image(image, params) 141 | 142 | if params["--hang-final"]: 143 | input("Press enter to exit...") 144 | 145 | 146 | def handle_image(image: Image, params: dict) -> None: 147 | if params["r"] or params["resize"]: 148 | image = image.resize(**cli_to_func_params("resize", params)) 149 | 150 | elif params["t"] or params["thumbnail"]: 151 | image = image.thumbnail(**cli_to_func_params("thumbnail", params)) 152 | 153 | elif params["f"] or params["fit-screen"]: 154 | image = image.fit_screen(**cli_to_func_params("fit_screen", params)) 155 | 156 | print_align = lambda t: print(TERM.align(t, params["--align"] or "center")) 157 | 158 | if params["--print-name"]: 159 | if isinstance(image.origin, (Path, str)): 160 | print_align(Path(image.origin).name) 161 | else: 162 | print_align("-") 163 | 164 | if params["--print-origin"]: 165 | if isinstance(image.origin, (Path, str)): 166 | print_align(str(image.origin)) 167 | else: 168 | print_align("-") 169 | 170 | if params["--print-id"]: 171 | print_align(image.id) 172 | 173 | image.show(**cli_to_func_params("show", params)) 174 | 175 | if params["--hang"]: 176 | input() 177 | 178 | 179 | def cli_to_func_params(func_name: str, params: dict) -> dict: 180 | mappings = data.CLI_TO_FUNCTIONS_PARAMS 181 | return { 182 | mappings[func_name][param][0]: mappings[func_name][param][1](value) 183 | for param, value in params.items() 184 | if value is not None and param in mappings[func_name] 185 | } 186 | -------------------------------------------------------------------------------- /pixcat/data.py: -------------------------------------------------------------------------------- 1 | ESC = "\033" 2 | 3 | MIN_ID = 1 4 | MAX_ID = 4_294_967_295 5 | 6 | # kitty sends a response on stdin (...) for those actions 7 | ACTIONS_WITH_ANSWER = {"display", "transmit+display", "query"} 8 | 9 | IMAGE_CONTROLS = { 10 | "action": ("a", { 11 | "query": "q", # check if image is already transmited? 12 | "transmit": "t", # id key must be used to set stored image id 13 | "display": "p", # retrieve image from id, id key must be used 14 | "transmit+display": "T", 15 | "delete": "d", 16 | }), 17 | "format": ("f", { 18 | "rgb": "24", 19 | "rgba": "32", 20 | "png": "100", 21 | }), 22 | "medium": ("t", { 23 | "direct": "d", # payload: base64 raw image data, 4096 bytes chunks 24 | "file": "f", # payload: base64 file path 25 | "tempfile": "t", # like file, but the file will be deleted after 26 | "sharedmem": "s" # payload: "/shared_mem_object_name" 27 | }), 28 | "compress": ("o", { 29 | "zlib": "z" 30 | }), 31 | "chunks": ("m", { 32 | "partial": "1", 33 | "final": "0" 34 | }), 35 | "id": ("i", {}), 36 | 37 | # In px, no need to specify if format is png. 38 | "source_w": ("s", {}), 39 | "source_h": ("v", {}), 40 | 41 | 42 | "del_target": ("d", { 43 | "all": "a", 44 | "id": "i", # specify using index key 45 | "at_cursor": "c", # current cursor position 46 | "at_cell": "p", # specify cell using origin_x and origin_y keys 47 | "at_cell_zindex": "q", # same as above, but also specify z_index 48 | "at_cols": "x", # specify column using origin_x 49 | "at_row": "y", # specify row using origin_y 50 | }), 51 | 52 | # delete + free up stored image data 53 | "del_data_target": ("d", { 54 | "all": "A", 55 | "id": "I", 56 | "at_cursor": "C", 57 | "at_cell": "P", 58 | "at_cell_zindex": "Q", 59 | "at_cols": "X", 60 | "at_row": "Y", 61 | "at_zindex": "Z", 62 | }), 63 | 64 | "offset_x": ("X", {}), 65 | "offset_y": ("Y", {}), 66 | 67 | "origin_x": ("x", {}), 68 | "origin_y": ("y", {}), 69 | "z_index": ("z", {}), 70 | 71 | "crop_w": ("w", {}), 72 | "crop_h": ("h", {}), 73 | 74 | "fit_cols": ("c", {}), 75 | "fit_rows": ("r", {}), 76 | } 77 | 78 | CLI_TO_FUNCTIONS_PARAMS = { 79 | "resize": { 80 | "--min-width": ("min_w", int), 81 | "--min-height": ("min_h", int), 82 | "--max-width": ("max_w", int), 83 | "--max-height": ("max_h", int), 84 | "--stretch": ("stretch", bool), 85 | "--resample": ("resample", str), 86 | }, 87 | "thumbnail": { 88 | "--size": ("size", int), 89 | "--stretch": ("stretch", bool), 90 | "--resample": ("resample", str), 91 | }, 92 | "fit_screen": { 93 | "--enlarge": ("enlarge", bool), 94 | "--horizontal-margin": ("h_margin", int), 95 | "--vertical-margin": ("v_margin", int), 96 | "--stretch": ("stretch", bool), 97 | "--resample": ("resample", str), 98 | }, 99 | "show": { 100 | "--absolute-x": ("x", int), 101 | "--absolute-y": ("y", int), 102 | "--z-index": ("z", int), 103 | "--relative-x": ("relative_x", int), 104 | "--relative-y": ("relative_y", int), 105 | "--align": ("align", str), 106 | "--offset-x": ("offset_x", int), 107 | "--offset-y": ("offset_y", int), 108 | "--crop-w": ("crop_w", int), 109 | "--crop-h": ("crop_h", int), 110 | } 111 | } 112 | -------------------------------------------------------------------------------- /pixcat/grid.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | import math 5 | import textwrap 6 | from typing import AnyStr, Callable, Iterable, Optional, Union 7 | 8 | import ansiwrap 9 | from ansiwrap import ansilen 10 | from dataclasses import dataclass, field 11 | 12 | from . import Image 13 | from .terminal import TERM 14 | 15 | FromCallable = Union[None, Image, AnyStr] 16 | CellType = Union[None, Image, AnyStr, Callable[["Grid"], FromCallable]] 17 | 18 | 19 | @dataclass 20 | class Grid: 21 | cells: Iterable[CellType] = field() 22 | 23 | cell_w: int = 256 # TODO: accept val in cols/rows 24 | cell_h: int = 256 25 | max_cols: Optional[int] = None 26 | max_rows: Optional[int] = None 27 | 28 | text_overflow: str = "wrap" # wrap or shorten 29 | cut_placeholder: str = " …" 30 | 31 | raise_errors: bool = False 32 | print_errors: bool = True 33 | 34 | 35 | @property 36 | def cell_cols(self) -> int: 37 | return math.ceil(self.cell_w / TERM.cell_px_width) 38 | 39 | @property 40 | def cell_rows(self) -> int: 41 | return math.ceil(self.cell_h / TERM.cell_px_height) 42 | 43 | @property 44 | def cells_per_row(self) -> int: 45 | if self.max_cols: 46 | return self.max_cols 47 | 48 | return max(1, math.floor(TERM.width / self.cell_cols)) 49 | 50 | 51 | def show(self) -> "Grid": 52 | # We have to handle y/rows manually because of forced blank lines, 53 | # terminal scrolling, etc; but x/columns are no trouble. 54 | start_x = x = TERM.get_location()[1] 55 | 56 | printed_rows = 0 57 | 58 | for index, cell in enumerate(self.cells): 59 | 60 | last_in_row = index % self.cells_per_row == 0 61 | one_per_row = self.cells_per_row < 2 62 | first_in_row = index == 0 63 | 64 | if last_in_row and (one_per_row or not first_in_row): 65 | # Print enough lines to begin a new row below the previous one 66 | TERM.print_esc("\n" * self.cell_rows) 67 | 68 | printed_rows += 1 69 | 70 | if self.max_rows and printed_rows > self.max_rows: 71 | break 72 | 73 | x = start_x 74 | 75 | content: FromCallable = self._get_content(cell) 76 | 77 | if isinstance(content, Image): 78 | content_cols = content.cols 79 | content_rows = content.rows 80 | elif not content: 81 | content_cols = content_rows = 0 82 | else: 83 | content_cols = ansilen(max(content.splitlines(), key=ansilen)) 84 | content_rows = ansilen(content.splitlines()) 85 | 86 | # Calculate paddings inside the cell to align the content 87 | inner_x = round((self.cell_cols / 2) - (content_cols / 2)) 88 | inner_y = math.floor((self.cell_rows / 2) - (content_rows / 2)) 89 | 90 | # Print the vertical padding as blank lines 91 | TERM.print_esc("\n" * inner_y) 92 | 93 | if isinstance(content, Image): 94 | content.show(x = x + inner_x, z=-1) 95 | else: 96 | print(textwrap.indent(content, " " * (x + inner_x))) 97 | 98 | # If needed, print blank lines to "complete the cell", 99 | # i.e. content height didn't fill it. 100 | # The cursor needs to always be at the cell row's bottom, 101 | # for the next "put back" escape code to work properly. 102 | TERM.print_esc("\n" * (self.cell_rows - content_rows - inner_y)) 103 | 104 | # "Undo" any terminal scrolling and put cursor back to the row 105 | # beginning so we can print more content in line. 106 | TERM.print_esc(TERM.move_relative_y(-self.cell_rows - 1)) 107 | 108 | x += self.cell_cols 109 | 110 | TERM.print_esc("\n" * self.cell_rows) 111 | return self 112 | 113 | 114 | def _get_content(self, cell: CellType) -> Union[Image, str]: 115 | if cell is None: 116 | return "" 117 | 118 | if isinstance(cell, Callable): 119 | return self._get_content(cell(self)) 120 | 121 | if isinstance(cell, Image): 122 | return self._get_resized_image(cell) 123 | 124 | return self._get_text(cell) 125 | 126 | 127 | def _get_resized_image(self, image: Image) -> Image: 128 | try: 129 | return image.resize(1, 1, self.cell_w, self.cell_h) 130 | 131 | except Exception as err: 132 | if self.raise_errors: 133 | raise 134 | 135 | if self.print_errors: 136 | print(TERM.red("%s: %s" % (type(err).__name__, err))) 137 | 138 | 139 | def _get_text(self, text: AnyStr) -> str: 140 | assert self.text_overflow in ("wrap", "shorten") 141 | 142 | lines = getattr(ansiwrap, self.text_overflow)( 143 | str(text), 144 | width = self.cell_cols, 145 | placeholder = self.cut_placeholder, 146 | tabsize = 4, 147 | replace_whitespace = False, 148 | drop_whitespace = False 149 | ) 150 | 151 | if isinstance(lines, str): # shorten returns a str, wrap a list 152 | return lines 153 | 154 | lines = [l for line in lines for l in line.splitlines()] 155 | return "\n".join(lines[:self.cell_rows]) 156 | -------------------------------------------------------------------------------- /pixcat/image.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | import io 5 | import math 6 | import random 7 | import re 8 | from pathlib import Path 9 | from tempfile import NamedTemporaryFile 10 | from typing import Dict, Generator, Optional, Tuple, Union 11 | 12 | from dataclasses import InitVar, dataclass, field 13 | from PIL import Image as PILImage 14 | 15 | from . import data 16 | from .terminal import TERM 17 | 18 | ImageType = Union[bytes, str, Path, PILImage.Image] 19 | 20 | @dataclass 21 | class Image: 22 | min_id = data.MIN_ID 23 | max_id = data.MAX_ID 24 | used_ids = set() 25 | 26 | source: InitVar[ImageType] 27 | id: Optional[int] = None 28 | 29 | origin: ImageType = field(init=False, default=None) 30 | 31 | _pil_image: PILImage.Image = field(init=False, repr=False, default=None) 32 | 33 | _resized_cache: Dict[Tuple[str, tuple], "Image"] = \ 34 | field(init=False, repr=False, compare=False, default_factory=dict) 35 | 36 | 37 | def __post_init__(self, source) -> None: 38 | self._resized_cache = {} # to make pylint shut up 39 | self.origin = source 40 | self.id = self._get_id() 41 | self._pil_image = self._get_pil_image(source) 42 | 43 | 44 | def _get_id(self) -> int: 45 | # Avoid hanging if somehow more than 4 billion of ids are registered: 46 | if len(self.used_ids) >= self.max_id: 47 | self.used_ids = set() 48 | 49 | random_id = random.randint(self.min_id, self.max_id) 50 | 51 | while random_id in self.used_ids: 52 | random_id = random.randint(self.min_id, self.max_id) 53 | 54 | self.used_ids.add(random_id) 55 | return random_id 56 | 57 | 58 | def _get_pil_image(self, source) -> PILImage.Image: 59 | if isinstance(source, PILImage.Image): 60 | return source 61 | 62 | if re.match(r"https?://.+", str(source)): 63 | import requests 64 | req = requests.get(source) 65 | req.raise_for_status() # Raise if 400 < http code < 600 66 | source = req.content # bytes 67 | 68 | if isinstance(source, bytes): 69 | # Don't use `with` here, or _get_kitty_file() will fail. 70 | out = io.BytesIO() 71 | out.write(source) 72 | out.seek(0) 73 | return PILImage.open(out) 74 | 75 | self.origin = path = Path(source).expanduser().resolve() 76 | return PILImage.open(path) 77 | 78 | 79 | def _get_kitty_file(self) -> str: 80 | dest = NamedTemporaryFile(prefix=".pixcat-", delete=False) 81 | self._pil_image.save(dest.name, format="PNG", compress_level=0) 82 | return dest.name 83 | 84 | 85 | @property 86 | def cols(self) -> int: 87 | return math.ceil(self._pil_image.size[0] / TERM.cell_px_width) 88 | 89 | @property 90 | def rows(self) -> int: 91 | return math.ceil(self._pil_image.size[1] / TERM.cell_px_height) 92 | 93 | 94 | @staticmethod 95 | def _negative_col_to_px(num: int) -> int: 96 | return num if num >= 0 else TERM.cell_px_width * abs(num) 97 | 98 | @staticmethod 99 | def _negative_row_to_px(num: int) -> int: 100 | return num if num >= 0 else TERM.cell_px_height * abs(num) 101 | 102 | 103 | def resize(self, 104 | min_w: int = 1, 105 | min_h: int = 1, 106 | max_w: Optional[int] = None, 107 | max_h: Optional[int] = None, 108 | stretch: bool = False, 109 | resample: str = "lanczos") -> "Image": 110 | 111 | w, h = img_w, img_h = self._pil_image.size 112 | 113 | max_w = max_w or img_w 114 | max_h = max_h or img_h 115 | 116 | min_w = self._negative_col_to_px(min_w) 117 | min_h = self._negative_row_to_px(min_h) 118 | max_w = self._negative_col_to_px(max_w) 119 | max_h = self._negative_row_to_px(max_h) 120 | 121 | assert min_w <= max_w 122 | assert min_h <= max_h 123 | 124 | # Upscale if image is smaller than minimum width/height: 125 | if (img_w < min_w or img_h < min_h) and img_w < max_w and img_h = min_h: 131 | # If calculated height > max_h: max_h, if < min_h: min_h 132 | h = min(max_h, math.ceil((min_w / img_w) * img_h)) 133 | w = math.floor((h / img_h) * img_w) 134 | 135 | else: 136 | w = min(max_w, math.ceil((min_h / img_h) * img_w)) 137 | h = math.floor((w / img_w) * img_h) 138 | 139 | # Downscale if image is bigger than maximum width/height: 140 | elif img_w > max_w or img_h > max_h: 141 | 142 | if stretch: 143 | w, h = max_w, max_h 144 | 145 | elif max_w >= max_h: 146 | h = min(max_h, math.ceil((max_w / img_w) * img_h)) 147 | w = math.floor((h / img_h) * img_w) 148 | 149 | else: 150 | w = min(max_w, math.ceil((max_h / img_h) * img_w)) 151 | h = math.floor((w / img_w) * img_h) 152 | 153 | # Nothing to do: 154 | else: 155 | return self 156 | 157 | # If an image was already made for decided width/height, return it: 158 | 159 | cached = self._resized_cache.get((w, h)) 160 | if cached: 161 | return cached 162 | 163 | # Return and save in the cache dict an Image object of the resized. 164 | 165 | resample = getattr(PILImage, resample.upper()) 166 | image = type(self)(self._pil_image.resize((w, h), resample)) 167 | 168 | self._resized_cache[(w, h)] = image 169 | return image 170 | 171 | 172 | def thumbnail(self, 173 | size: int = 256, 174 | stretch: bool = False, 175 | resample: str = "lanczos") -> "Image": 176 | 177 | return self.resize(*(size,) * 4, stretch, resample) 178 | 179 | 180 | def fit_screen(self, 181 | h_margin: int = 0, 182 | v_margin: int = 0, 183 | enlarge: bool = False, 184 | stretch: bool = False, 185 | resample: str = "lanczos") -> "Image": 186 | 187 | h_margin = self._negative_col_to_px(h_margin) * 4 188 | v_margin = self._negative_row_to_px(v_margin) * 4 189 | 190 | max_wh = (TERM.px_width - h_margin, TERM.px_height - v_margin) 191 | min_wh = max_wh if enlarge else (1, 1) 192 | 193 | return self.resize(*min_wh, *max_wh, stretch, resample) 194 | 195 | 196 | def show(self, 197 | x: Optional[int] = None, 198 | y: Optional[int] = None, 199 | z: int = -1, 200 | relative_x: int = 0, 201 | relative_y: int = 0, 202 | align: str = "center", 203 | offset_x: int = 0, 204 | offset_y: int = 0, 205 | crop_w: int = 0, 206 | crop_h: int = 0) -> "Image": 207 | 208 | assert align in ("left", "center", "right") 209 | 210 | crop_w = self._negative_col_to_px(crop_w) 211 | crop_h = self._negative_row_to_px(crop_h) 212 | 213 | params = { 214 | "offset_x": offset_x, "offset_y": offset_y, 215 | "crop_w": crop_w, "crop_h": crop_h, 216 | "z_index": z, 217 | 218 | "action": "transmit+display", 219 | "medium" : "tempfile", 220 | "format" : "png", 221 | "id": self.id, 222 | "payload": self._get_kitty_file(), 223 | } 224 | 225 | if x is not None: 226 | TERM.print_esc(TERM.move_x(x)) 227 | 228 | elif align == "center": 229 | relative_x += round(TERM.width / 2) - round(self.cols / 2) 230 | 231 | elif align == "right": 232 | relative_x += TERM.width - self.cols 233 | 234 | if relative_x: 235 | TERM.print_esc(TERM.move_relative_x(relative_x)) 236 | 237 | if y is not None: 238 | TERM.print_esc(TERM.move_y(y)) 239 | 240 | if relative_y: 241 | TERM.print_esc(TERM.move_relative_y(relative_y)) 242 | 243 | 244 | # import time; time.sleep(2) 245 | TERM.run_code(**params) 246 | return self 247 | 248 | 249 | def hide(self, resized_too: bool = True) -> "Image": 250 | ids = [self.id] 251 | 252 | if resized_too: 253 | ids += [img.id for img in self._resized_cache.values()] 254 | 255 | for id_ in ids: 256 | TERM.run_code(action="delete", del_data_target="id", id=id_) 257 | 258 | return self 259 | 260 | 261 | def copy(self, new_id: Optional[int] = None) -> "Image": 262 | return type(self)(source=self.origin, id=new_id) 263 | 264 | 265 | def __copy__(self) -> "Image": 266 | return self.copy() 267 | 268 | 269 | @classmethod 270 | def factory(cls, 271 | *sources: ImageType, 272 | raise_errors: bool = False, 273 | print_errors: bool = True) -> Generator["Image", None, None]: 274 | 275 | for source in sources: 276 | try: 277 | if isinstance(source, (bytes, PILImage.Image)) or \ 278 | re.match(r"https?://.+", str(source)): 279 | yield cls(source) 280 | continue 281 | 282 | path = Path(source).expanduser().resolve() 283 | 284 | if path.is_dir(): 285 | for item in path.iterdir(): 286 | yield from cls.factory( 287 | item, 288 | raise_errors = raise_errors, 289 | print_errors = print_errors 290 | ) 291 | continue 292 | 293 | yield cls(path) 294 | 295 | except Exception as err: 296 | if raise_errors: 297 | raise 298 | 299 | if print_errors: 300 | print(TERM.red("%s: %s" % (type(err).__name__, err))) 301 | -------------------------------------------------------------------------------- /pixcat/terminal.py: -------------------------------------------------------------------------------- 1 | import array 2 | import base64 3 | import fcntl 4 | import signal 5 | import sys 6 | import termios 7 | from contextlib import contextmanager 8 | from typing import Tuple 9 | 10 | import blessed 11 | 12 | from . import data 13 | 14 | 15 | class KittyAnswerError(Exception): 16 | def __init__(self, from_code: str, answer: str) -> None: 17 | super().__init__(f"{from_code!r} : terminal responded with {answer!r}") 18 | 19 | 20 | class KittyAnswerTimeout(Exception): 21 | pass 22 | 23 | 24 | class PixTerminal(blessed.Terminal): 25 | actions_with_answer = data.ACTIONS_WITH_ANSWER 26 | img_controls = data.IMAGE_CONTROLS 27 | esc = data.ESC 28 | 29 | 30 | @property 31 | def size(self) -> Tuple[int, int]: 32 | return (self.width, self.height) 33 | 34 | 35 | @property 36 | def px_size(self) -> Tuple[int, int]: 37 | buf = array.array("H", [0, 0, 0, 0]) 38 | fcntl.ioctl(sys.stdout, termios.TIOCGWINSZ, buf) 39 | return (buf[2], buf[3]) 40 | 41 | @property 42 | def px_width(self) -> int: 43 | return self.px_size[0] 44 | 45 | @property 46 | def px_height(self) -> int: 47 | return self.px_size[1] 48 | 49 | 50 | @property 51 | def cell_px_size(self) -> Tuple[int, int]: 52 | return (self.px_width // self.width, self.px_height // self.height) 53 | 54 | @property 55 | def cell_px_width(self) -> int: 56 | return self.cell_px_size[0] 57 | 58 | @property 59 | def cell_px_height(self) -> int: 60 | return self.cell_px_size[1] 61 | 62 | 63 | def get_code(self, payload: str = "", **controls: str) -> str: 64 | if "id" in controls: 65 | assert data.MIN_ID <= controls["id"] <= data.MAX_ID 66 | 67 | real_keys = { 68 | self.img_controls[k][0]: 69 | self.img_controls[k][1][v] if self.img_controls[k][1] else v 70 | 71 | for k, v in controls.items() 72 | } 73 | 74 | keys_str = ",".join([f"{k}={v}" for k, v in real_keys.items()]) 75 | 76 | if payload: 77 | payload = str(base64.b64encode(bytes(payload, "utf-8")), "utf-8") 78 | 79 | # print("%r" % f"{ESC}_G{keys_str};{payload}{ESC}\\") 80 | return f"{self.esc}_G{keys_str};{payload}{self.esc}\\" 81 | 82 | 83 | def run_code(self, payload: str = "", timeout: int = 3, **controls: str 84 | ) -> None: 85 | code = self.get_code(payload, **controls) 86 | 87 | print(code) 88 | 89 | if controls.get("action", "transmit") not in self.actions_with_answer: 90 | return 91 | 92 | signal.alarm(timeout) 93 | 94 | # Catch responses kitty print on stdin: 95 | chars = [] 96 | while True: 97 | with self.cbreak(): 98 | char = sys.stdin.read(1) 99 | chars.append(char) 100 | if char == "\\": 101 | break 102 | 103 | signal.alarm(0) # Cancel alarm 104 | 105 | answer = "".join(chars) 106 | 107 | if answer and ";OK" not in answer: 108 | raise KittyAnswerError(code, answer) 109 | 110 | 111 | def detect_support(self) -> bool: 112 | try: 113 | # Send an useless code that will force a response out of kitty, 114 | # if this is kitty. 115 | self.run_code(action="query", id=1) 116 | 117 | except KittyAnswerError: 118 | return True 119 | 120 | except KittyAnswerTimeout: 121 | pass 122 | 123 | return False 124 | 125 | 126 | # y then x for those because blessings does it like that for some reason 127 | def move_relative(self, y: int = 0, x: int = 0) -> str: 128 | cursor_y, cursor_x = self.get_location() 129 | return self.move(cursor_y + y, cursor_x + x) 130 | 131 | def move_relative_x(self, x: int = 0) -> str: 132 | cursor_y, cursor_x = self.get_location() 133 | return self.move(cursor_y, cursor_x + x) 134 | 135 | def move_relative_y(self, y: int = 0) -> str: 136 | cursor_y, cursor_x = self.get_location() 137 | return self.move(cursor_y + y, cursor_x) 138 | 139 | 140 | @contextmanager 141 | def location_relative(self, x: int = 0, y: int = 0) -> str: 142 | cursor_y, cursor_x = self.get_location() 143 | with self.location(x=cursor_x + x, y=cursor_y + y): 144 | yield 145 | 146 | 147 | def align(self, text: str, align: str = "left") -> str: 148 | if align == "left": 149 | return self.ljust(text) 150 | 151 | if align == "center": 152 | return self.center(text) 153 | 154 | if align == "right": 155 | return self.rjust(text) 156 | 157 | raise ValueError("Alignement must be 'left', 'center' or 'right'.") 158 | 159 | 160 | @staticmethod 161 | def print_esc(*args, **kwargs) -> None: 162 | print(*args, **kwargs, end="", sep="", flush=True) 163 | 164 | 165 | TERM = PixTerminal() 166 | 167 | 168 | def alarm_handler(*_): 169 | raise KittyAnswerTimeout() 170 | 171 | 172 | signal.signal(signal.SIGALRM, alarm_handler) 173 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 miruka 2 | # This file is part of pixcat, licensed under LGPLv3. 3 | 4 | "pixcat setuptools file" 5 | 6 | from setuptools import setup, find_packages 7 | 8 | from pixcat import __about__ 9 | 10 | 11 | def get_readme(): 12 | with open("README.md", "r") as readme: 13 | return readme.read() 14 | 15 | 16 | setup( 17 | name = __about__.__pkg_name__, 18 | version = __about__.__version__, 19 | 20 | author = __about__.__author__, 21 | author_email = __about__.__email__, 22 | license = __about__.__license__, 23 | 24 | description = __about__.__doc__, 25 | long_description = get_readme(), 26 | long_description_content_type = "text/markdown", 27 | 28 | python_requires = ">=3.6, <4", 29 | install_requires = [ 30 | "blessed", 31 | "dataclasses;python_version<'3.7'", 32 | "docopt", 33 | "pillow", 34 | "requests" 35 | ], 36 | 37 | include_package_data = True, 38 | packages = find_packages(), 39 | entry_points = { 40 | "console_scripts": [ 41 | f"{__about__.__pkg_name__}={__about__.__pkg_name__}.cli:main" 42 | ] 43 | }, 44 | 45 | url = "https://github.com/mirukan/pixcat", 46 | keywords = "kitty api cli terminal print display resize scale image " \ 47 | "picture graphic icat", 48 | 49 | classifiers=[ 50 | "Development Status :: 3 - Alpha", 51 | # "Development Status :: 4 - Beta", 52 | # "Development Status :: 5 - Production/Stable", 53 | 54 | "Intended Audience :: Developers", 55 | "Intended Audience :: End Users/Desktop", 56 | 57 | "Environment :: Console", 58 | 59 | "Topic :: Multimedia :: Graphics :: Viewers", 60 | "Topic :: Terminals", 61 | 62 | ("License :: OSI Approved :: " 63 | "GNU Lesser General Public License v3 or later (LGPLv3+)"), 64 | 65 | "Programming Language :: Python :: 3", 66 | "Programming Language :: Python :: 3 :: Only", 67 | "Programming Language :: Python :: 3.6", 68 | "Programming Language :: Python :: 3.7", 69 | 70 | "Natural Language :: English", 71 | 72 | "Operating System :: POSIX", 73 | ] 74 | ) 75 | --------------------------------------------------------------------------------