├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── i3situation ├── __init__.py ├── core │ ├── __init__.py │ ├── config.py │ ├── plugin_manager.py │ └── status.py ├── main.py ├── plugins │ ├── __init__.py │ ├── _plugin.py │ ├── battery.py │ ├── cmus.py │ ├── conky.py │ ├── date_time.py │ ├── reddit.py │ ├── run.py │ └── text.py └── unit_tests │ └── config.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | eggs 12 | parts 13 | bin 14 | var 15 | sdist 16 | develop-eggs 17 | .installed.cfg 18 | lib 19 | lib64 20 | __pycache__ 21 | 22 | # Installer logs 23 | pip-log.txt 24 | 25 | # Rope project 26 | .ropeproject 27 | 28 | # Vim swap files 29 | *.*.swp 30 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are always welcomed, so start sending some PRs! 4 | 5 | ## Getting Started 6 | 7 | Clone the repository: 8 | 9 | git clone https://github.com/HarveyHunt/i3situation.git 10 | 11 | Change to the develop branch: 12 | 13 | git checkout develop 14 | 15 | Hack away until your heart is content. 16 | 17 | ## Code Style 18 | 19 | I try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) as closely as sanely possible. 20 | 21 | Running a code linter, such as [PyFlakes](https://launchpad.net/pyflakes) is always a nice idea- try to minimise errors. 22 | 23 | The hard rules are as follows: 24 | 25 | * 4 spaces per tab 26 | * use_of_underscores_for_functions_variables_etc 27 | * Code should be pythonic. 28 | 29 | ## What comes after code? 30 | 31 | You have written an awesome new feature and want to get it merged straight away- have you forgotten something? 32 | 33 | Documentation is an important part of any project, i3situation is no different. Document all new features, as has been done 34 | in the README already. 35 | 36 | If you're feeling especially kind and in a Python mood, try to add some unit tests for your new feature- or even more parts of i3situation in general. 37 | 38 | ## Sending PRs 39 | 40 | Once you have made some cool changes, push to github and send a PR. 41 | 42 | Make sure that the PR is targeted at the develop branch, as packages are built from the master branch. 43 | 44 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/} 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 {http://www.gnu.org/licenses/}. 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 | i3-py3-status Copyright (C) 2013 HarveyHunt 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 | {http://www.gnu.org/licenses/}. 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 | {http://www.gnu.org/philosophy/why-not-lgpl.html}. 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | i3situation 2 | ============= 3 | 4 | A replacement for i3status written in Python 3 with support for huge 5 | customisability through plugins. 6 | 7 | Please feel free to send a pull request or request features by opening an issue. 8 | 9 | Contents 10 | ============ 11 | 12 | * [Installation](#installation) 13 | * [Configuring Plugins](#configuring-plugins) 14 | * [Plugins](#plugins) 15 | * [Creating A Plugin](#creating-a-plugin) 16 | * [Events](#events) 17 | * [Advanced Plugin Options](#advanced-plugin-options) 18 | 19 | Installation 20 | ============= 21 | 22 | If you're lucky enough to be using Arch Linux, i3situation is available from the [AUR](https://aur.archlinux.org/packages/i3situation-git/). 23 | 24 | i3situation is also available over at [PyPi](https://pypi.python.org/pypi/i3situation/1.0.1). 25 | 26 | If you want to install straight from this git repository, first clone it and then change 27 | into the cloned directory. 28 | 29 | git clone https://github.com/HarveyHunt/i3situation 30 | cd i3situation 31 | 32 | You then need to install i3situation using the setup.py file that is provided. 33 | 34 | sudo python setup.py install 35 | 36 | Next, use your editor of choice to create a configuration file. 37 | 38 | vim ~/.config/i3situation/config 39 | 40 | The minimum that you need to enter in order to run the application is as 41 | follows: 42 | 43 | [general] 44 | interval = 1 45 | logging_level = ERROR 46 | log_file = ~/.config/i3situation/log.txt 47 | 48 | You then need to change the status_command value in the bar section of your i3 49 | configuration to: 50 | 51 | status_command i3situation 52 | 53 | It is a good idea to run i3situation at this point, as it will handle copying over the 54 | plugins into your configuration directory. 55 | 56 | Configuring Plugins 57 | ============= 58 | Plugins are the way to get this application to output to i3bar and allow for large 59 | amounts of expandability. The configuration file is automatically reloaded when 60 | any changes occur to it. Changing the content of a plugin file will also cause 61 | a reload of all plugins and settings. 62 | 63 | __Note:__ When using the % symbol in the config file, it needs to be escaped with another %. 64 | 65 | Plugins are configured in the config file. You must first denote a new plugin 66 | config section by using a unique name for that instance of a plugin. For example: 67 | 68 | [my_time_plugin] 69 | 70 | Inside this section you need to say which plugin you wish to use (Note: the plugin 71 | field refers to the filename of the plugin less the .py extension). 72 | 73 | [my_time_plugin] 74 | plugin = date_time 75 | 76 | Each plugin needs to have an interval set. This interval refers to how often the 77 | plugin's displayed text is updated. 78 | 79 | [my_time_plugin] 80 | plugin = date_time 81 | interval = 1 82 | 83 | Each plugin has an on_click function already defined. This function allows the user to 84 | specify a shell command that should be executed each time a plugin's text area is clicked 85 | with a mouse button (of which there are three, defined [here](#events)). For example: 86 | 87 | [my_time_plugin] 88 | plugin = date_time 89 | interval = 1 90 | button1 = urxvt 91 | button2 = xterm 92 | 93 | You can then change the options for a plugin by defining them next. The available 94 | options can be seen in the plugin file in a dictionary- with the defaults next to it. 95 | 96 | A list of values should be comma separated and a boolean value can be written as: 97 | 98 | - on 99 | - True 100 | - true 101 | - off 102 | - False 103 | - false 104 | 105 | The example below illustrates using a comma separated list: 106 | 107 | [my_reddit_plugin] 108 | plugin = reddit 109 | interval = 30 110 | mode = subreddit 111 | subreddits = programming,linux 112 | 113 | You can also edit options that affect how the output is displayed (Note: the 114 | same options are available for all plugins). The following example illustrates 115 | changing the colour of the output: 116 | 117 | [my_reddit_plugin] 118 | plugin = reddit 119 | interval = 30 120 | mode = subreddit 121 | subreddits = programming,linux 122 | color = #808080 123 | 124 | The rest of the output options that can be edited are discussed in the Advanced Plugin 125 | Options section of this document. 126 | 127 | My personal i3situation configuration file can be found with my [dotfiles](https://github.com/HarveyHunt/dotfiles). 128 | 129 | Plugins 130 | ============ 131 | 132 | * [Cmus](#cmus) 133 | * [Date and Time](#date and time) 134 | * [Reddit](#reddit) 135 | * [Run](#run) 136 | * [Text](#text) 137 | * [Conky](#conky) 138 | * [Battery](#battery) 139 | 140 | ## Cmus 141 | A plugin to display information provided by Cmus (current song etc). 142 | 143 | Options: 144 | * **Format**: A string showing the format in which the output should be displayed. 145 | Keywords in the string will be replaced with data. Possible keywords can be found [here](i3situation/plugins/cmus.py). 146 | 147 | ``` 148 | format=artist -> title 149 | ``` 150 | 151 | ## Date and Time 152 | A plugin to display the current date and time. Has support for multiple time zones. 153 | 154 | Options: 155 | * **Time Zone**: The time zone that should be used when finding the time. By default, Python will work this out by itself. Setting a value for time_zone will override that. 156 | 157 | ``` 158 | time_zone=GMT 159 | ``` 160 | 161 | * **Long Format**: The text to display when there is a large amount of space. A full list of 162 | format options can be found [here](http://docs.python.org/3/library/time.html#time.strftime) 163 | 164 | ``` 165 | long_format=%d-%m-%Y %H:%M:%S 166 | ``` 167 | 168 | * **Short Format**: The text to be displayed when there is a smaller amount of bar space available. 169 | 170 | ``` 171 | short_format=%H:%M:%S 172 | ``` 173 | 174 | ##Reddit 175 | A plugin that can display information from Reddit, such as post titles and upvotes. 176 | 177 | Options: 178 | * **Mode**: The mode that the plugin shall operate in. Front page will display threads from the 179 | front page of Reddit or your personal front page (provided you have logged in). 180 | 181 | ``` 182 | mode=front 183 | ``` 184 | 185 | * **Subreddits**: The subreddits that should be displayed when the plugin is in subreddit mode. 186 | Should be in the form of a comma seperated list. 187 | 188 | ``` 189 | subreddits=vim,python 190 | ``` 191 | 192 | * **Username**: Your Reddit username. 193 | 194 | ``` 195 | username=segfaultless 196 | ``` 197 | 198 | * **Password**: Your Reddit password. 199 | 200 | ``` 201 | password=lamepassword 202 | ``` 203 | 204 | * **Limit**: The amount of threads that should be requested from Reddit in one go. 205 | 206 | ``` 207 | limit=25 208 | ``` 209 | 210 | * **Format**: The format that the plugin's output should be presented in. Keywords will 211 | be replaced with actual data. For a full list of keywords, look [here](i3situation/plugins/reddit.py) 212 | 213 | ``` 214 | format=subreddit title ups 215 | ``` 216 | 217 | * **Sort**: The method with which the Reddit threads are sorted. 218 | 219 | ``` 220 | sort=hot 221 | ``` 222 | 223 | * **Max Characters**: The maximum number of characters that a Reddit thread title is allowed to have. If the Reddit thread title is longer than this value, the thread will be removed from the queue. 224 | ``` 225 | max_chars=140 226 | ``` 227 | 228 | ## Run 229 | A plugin to run shell commands and send the output to i3bar. 230 | 231 | * **Command**: The command that is to be executed. 232 | 233 | ``` 234 | command=echo Hello 235 | ``` 236 | 237 | ## Text 238 | A simple plugin to output text. 239 | 240 | * **Text**: The text that will be displayed. 241 | 242 | ``` 243 | text=Hello World 244 | ``` 245 | 246 | ## Conky 247 | A plugin to allow conky's output to be displayed. It is required that you have a valid .conkyrc that outputs to ```stdout```, such as: 248 | 249 | ``` 250 | conky.config = { 251 | ... 252 | out_to_console = true, 253 | out_to_x = false, 254 | ... 255 | } 256 | ``` 257 | 258 | * **Command**: The conky command to be executed. 259 | 260 | ``` 261 | command=$uptime 262 | ``` 263 | 264 | * **Config**: The path to the conkyrc file that shall be used. 265 | 266 | ``` 267 | config=~/.conkyrc 268 | ``` 269 | 270 | ## Battery 271 | A plugin that displays information about the battery, such as charge level and status. 272 | 273 | * **format**: The format of the output. will be replaced by the battery's current status 274 | and will be replaced by the current charge level. 275 | 276 | ``` 277 | format=% 278 | ``` 279 | 280 | * **percentage**: Whether or not the charge should be calculated as a percentage. 281 | 282 | ``` 283 | percentage=True 284 | ``` 285 | 286 | * **low_threshold**: The value of charge below which the low_color will be displayed. Note: this value 287 | should be from 0 to 1 when percentage isn't set and 0 to 100 when it is set. 288 | 289 | ``` 290 | low_threshold=20 291 | ``` 292 | 293 | * **low_color**: The colour to be displayed when the battery charge level is classed as low. 294 | 295 | ``` 296 | low_color=#FF0000 297 | ``` 298 | 299 | * **discharging_color**: The colour to be displayed when the battery is discharging. 300 | 301 | ``` 302 | discharging_color=#FF6103 303 | ``` 304 | 305 | * **charging_color**: The colour to be displayed when the battery is charging. 306 | 307 | ``` 308 | charging_color=#00F000 309 | ``` 310 | 311 | * **full_color**: The colour to be displayed when the battery is full. 312 | 313 | ``` 314 | full_color=#FFFFFF 315 | ``` 316 | 317 | * **battery_path**: The path to the battery file- generally in the form /sys/class/power_supply/BATX. 318 | 319 | ``` 320 | battery_path=/sys/class/power_supply/BAT0 321 | ``` 322 | 323 | Creating a Plugin 324 | ============= 325 | 326 | Creating a plugin is a simple process, made easier by the Plugin base class. 327 | The first step is to create a python 328 | file in your plugin directory. Note: Files with a leading underscore will not 329 | be loaded as a plugin but can be 330 | used for library files. 331 | 332 | vim cool_feature.py 333 | 334 | The Plugin base class needs to be imported from the plugins folder. 335 | 336 | ```python 337 | from plugins._plugin import Plugin 338 | ``` 339 | 340 | You should then create a class that inherits the newly imported Plugin class. 341 | 342 | ```python 343 | from plugins._plugin import Plugin 344 | 345 | 346 | class cool_feature_plugin(Plugin): 347 | ``` 348 | 349 | The \_\_all\_\_ variable needs to be set to the name of your plugin class. 350 | 351 | ```python 352 | from plugins._plugin import Plugin 353 | 354 | __all__ = 'CoolFeaturePlugin' 355 | 356 | 357 | class CoolFeaturePlugin(Plugin): 358 | ``` 359 | 360 | The \_\_init\_\_ function needs to accept two arguments- self and config. The 361 | options that can be 362 | configured by the user need to be placed in a dictionary called self.options 363 | with the format: 364 | 365 | ```python 366 | {'option': 'default_value'} 367 | ``` 368 | 369 | Options that can be configured by the user should be declared before calling 370 | the super class' 371 | \_\_init\_\_ function. 372 | 373 | The super class' \_\_init\_\_ function must be passed two arguments- config and 374 | the user configurable 375 | options. There is only one compulsary option- interval. This refers to how 376 | often (in seconds) the 377 | main function of the plugin should be called. 378 | 379 | ```python 380 | from plugins._plugin import Plugin 381 | 382 | __all__ = 'CoolFeaturePlugin' 383 | 384 | 385 | class CoolFeaturePlugin(Plugin): 386 | 387 | def __init__(self, config): 388 | self.options = {'cool_option': 'cool_value', 'interval': 1} 389 | super().__init__(config, self.options) 390 | ``` 391 | 392 | All plugins must have a main() function that is called by the plugin loader. 393 | Within this function, 394 | program logic should be executed and it should return a dictionary to the main 395 | application. The 396 | Plugin base class provides a helper function called output that serves this 397 | purpose. Output should 398 | be passed a string as the first argument that represents a detailed output of 399 | the plugin and a shorter 400 | string as the second argument. It is perfectly acceptable to pass the same 401 | value to each argument. 402 | 403 | ```python 404 | from plugins._plugin import Plugin 405 | 406 | __all__ = 'CoolFeaturePlugin' 407 | 408 | 409 | class CoolFeaturePlugin(Plugin): 410 | 411 | def __init__(self, config): 412 | self.options = {'cool_option': 'cool_value', 'interval': 1} 413 | super().__init__(config, self.options) 414 | 415 | def main(self): 416 | return self.output('This is a fabulous plugin', 'Cool plugin') 417 | ``` 418 | 419 | Events 420 | ----------- 421 | 422 | It is also possible to create a function that gets executed whenever the plugin's output 423 | is clicked. The plugin must have an on_click() function that handles the event. The function 424 | must accept an event dictionary as an argument- the layout of which is below: 425 | 426 | ``` 427 | {'button': 1, 'name': 'time', 'y': 1196, 'x': 1846} 428 | ``` 429 | 430 | The button corresponds to which mouse button was used to click the text. The mouse buttons are 431 | numbered as follows: 432 | 433 | 1. Left Mouse Button 434 | 2. Middle Mouse Button 435 | 3. Right Mouse Button 436 | 437 | The x and y variables refer to the position that the text was clicked at. 438 | 439 | The name refers to the name of the plugin object that was clicked. 440 | 441 | It is possible to do many things once the text has been clicked, but please bear in mind that 442 | the on_click() code will be run in the same thread as the event handler. Therefore, it is important 443 | that any code in on_click() isn't too intensive. 444 | 445 | Adding an on_click() function to the cool_feature_plugin looks as follows: 446 | 447 | ```python 448 | from plugins._plugin import Plugin 449 | 450 | __all__ = 'CoolFeaturePlugin' 451 | 452 | 453 | class CoolFeaturePlugin(Plugin): 454 | 455 | def __init__(self, config): 456 | self.options = {'cool_option': 'cool_value', 'interval': 1} 457 | super().__init__(config, self.options) 458 | 459 | def main(self): 460 | return self.output('This is a fabulous plugin', 'Cool plugin') 461 | 462 | def on_click(self, event): 463 | if event['button'] == 1: 464 | self.output_options['color'] = '#FF0000' 465 | else: 466 | self.output_options['color'] = '#0000FF' 467 | ``` 468 | 469 | This is all the code required to create a plugin. There are lots of good 470 | examples of how to write 471 | plugins in this [project's plugin 472 | directory](https://github.com/harvey_hunt/i3situation/tree/master/i3situation/plugins) 473 | 474 | Advanced Plugin Options 475 | ============= 476 | 477 | It is also possible to manipulate many aspects of a plugin's output. The Plugin 478 | class provides 479 | a way to set the value of output options (blocks). Changing values in the 480 | following dictionary 481 | will affect the output options: 482 | 483 | ```python 484 | self.output_options['color'] = '#FF00FF' 485 | ``` 486 | 487 | The following is the internal representation of output options used in the 488 | Plugin class. 489 | 490 | ```python 491 | self.output_options = { 492 | 'color': None, 493 | 'min_width': None, 494 | 'align': None, 495 | 'name': None, 496 | 'urgent': None, 497 | 'separator': None, 498 | 'separator_block_width': None} 499 | ``` 500 | 501 | For a full explanation of each output option, please refer to section 2.2 of 502 | the excellent 503 | i3bar documentation: 504 | [i3Bar Protocol](http://i3wm.org/docs/i3bar-protocol.html) 505 | -------------------------------------------------------------------------------- /i3situation/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HarveyHunt/i3situation/3160a21006fcc6961f240988874e228a5ec6f18e/i3situation/__init__.py -------------------------------------------------------------------------------- /i3situation/core/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HarveyHunt/i3situation/3160a21006fcc6961f240988874e228a5ec6f18e/i3situation/core/__init__.py -------------------------------------------------------------------------------- /i3situation/core/config.py: -------------------------------------------------------------------------------- 1 | import os 2 | import errno 3 | import configparser 4 | 5 | 6 | class IncompleteConfigurationFile(ValueError): 7 | pass 8 | 9 | 10 | class Config(): 11 | """ 12 | Provides a simplified interface to the configuration of the application. 13 | 14 | Accepts a list of folder_locations that are then checked for validity. 15 | """ 16 | def __init__(self, folder_locations): 17 | for path in folder_locations: 18 | if os.path.isdir(path): 19 | self._folder_path = path 20 | break 21 | else: 22 | self._folder_path = folder_locations[0] 23 | self._touch_dir(self._folder_path) 24 | self.plugin_path = os.path.join(self._folder_path, 'plugins') 25 | if not os.path.exists(self.plugin_path): 26 | self._touch_dir(self.plugin_path) 27 | self.config_file_path = os.path.join(self._folder_path, 'config') 28 | if not os.path.exists(self.config_file_path): 29 | self.create_default_config() 30 | self.plugin, self.general = self.reload() 31 | 32 | def _touch_dir(self, path): 33 | """ 34 | A helper function to create a directory if it doesn't exist. 35 | 36 | path: A string containing a full path to the directory to be created. 37 | """ 38 | try: 39 | os.makedirs(path) 40 | except OSError as e: 41 | if e.errno != errno.EEXIST: 42 | raise 43 | 44 | def create_default_config(self): 45 | s = '[general]\ninterval = 1\nlogging_level = ERROR\n' \ 46 | 'log_file = ~/.config/i3situation/log.txt\ncolors = true' 47 | with open(self.config_file_path, 'w') as f: 48 | f.write(s) 49 | 50 | def reload(self): 51 | """ 52 | Reload the configuration from the file. This is in its own function 53 | so that it can be called at any time by another class. 54 | """ 55 | self._conf = configparser.ConfigParser() 56 | # Preserve the case of sections and keys. 57 | self._conf.optionxform = str 58 | self._conf.read(self.config_file_path) 59 | if 'general' not in self._conf.keys(): 60 | raise IncompleteConfigurationFile('Missing the general section') 61 | general = self._replace_data_types(dict(self._conf.items('general'))) 62 | self._conf.remove_section('general') 63 | plugin = [] 64 | for section in self._conf.sections(): 65 | plugin.append(dict(self._conf.items(section))) 66 | plugin[-1].update({'name': section}) 67 | plugin[-1] = self._replace_data_types(plugin[-1]) 68 | return (plugin, general) 69 | 70 | @staticmethod 71 | def _replace_data_types(dictionary): 72 | """ 73 | Replaces strings with appropriate data types (int, boolean). 74 | Also replaces the human readable logging levels with the integer form. 75 | 76 | dictionary: A dictionary returned from the config file. 77 | """ 78 | logging_levels = {'NONE': 0, 'NULL': 0, 'DEBUG': 10, 'INFO': 20, 79 | 'WARNING': 30, 'ERROR': 40, 'CRITICAL': 50} 80 | for k, v in dictionary.items(): 81 | if v in ['true', 'True', 'on']: 82 | dictionary[k] = True 83 | elif v in ['false', 'False', 'off']: 84 | dictionary[k] = False 85 | elif k == 'log_file' and '~' in v: 86 | dictionary[k] = v.replace('~', os.path.expanduser('~')) 87 | elif v in logging_levels: 88 | dictionary[k] = logging_levels[v] 89 | elif isinstance(v, str) and v.isnumeric(): 90 | dictionary[k] = int(v) 91 | elif ',' in v: 92 | dictionary[k] = [x.strip() for x in v.split(',')] 93 | return dictionary 94 | -------------------------------------------------------------------------------- /i3situation/core/plugin_manager.py: -------------------------------------------------------------------------------- 1 | import glob 2 | import shutil 3 | import imp 4 | import logging 5 | import time 6 | import os.path 7 | import threading 8 | import compileall 9 | 10 | 11 | class MissingPlugin(Exception): 12 | """ 13 | The plugin that has been mentioned in the configuration file doesn't appear 14 | in the application's plugin directory. 15 | """ 16 | pass 17 | 18 | 19 | class Thread(threading.Thread): 20 | """ 21 | A thread that runs a plugin's main function and mutates that outputdict 22 | in order to return the value of the plugin's main function. This is where 23 | a plugin's interval is taken into account. 24 | """ 25 | 26 | def __init__(self, func, interval, output_dict): 27 | """ 28 | func: The function that will be executed by the thread. It is always the 29 | main() function of a plugin. 30 | 31 | interval: How often the func is run. (Time in seconds). 32 | 33 | output_dict: A dictionary containing dictionaries. Is in the format: 34 | {plugin_name: {information about plugin}, ...} 35 | The information about plugin contains data such as the full_text and 36 | formatting options. 37 | """ 38 | super().__init__(group=None, daemon=True) 39 | self.func = func 40 | self.output_dict = output_dict 41 | self.interval = interval 42 | 43 | def run(self): 44 | """ 45 | Calls the main function of a plugin and mutates the output dict 46 | with its return value. Provides an easy way to change the output 47 | whilst not needing to constantly poll a queue in another thread and 48 | allowing plugin's to manage their own intervals. 49 | """ 50 | self.running = True 51 | while self.running: 52 | ret = self.func() 53 | self.output_dict[ret['name']] = ret 54 | time.sleep(self.interval) 55 | return 56 | 57 | def stop(self): 58 | """ 59 | Stop the thread from running. 60 | The thread doesn't stop immediately, it stops once the running 61 | variable is checked, after the thread's interval. 62 | """ 63 | self.running = False 64 | 65 | 66 | class ThreadManager(): 67 | """ 68 | Keeps track of threads and enables the creation and destruction of 69 | threads. 70 | 71 | The output_dict variable is a dictionary passed into the class that is then 72 | mutated by the threads in order to update the output of the application. 73 | This means that the main thread need only display the output and not poll 74 | for changes in the output data. It also means that queues are not needed. 75 | """ 76 | 77 | def __init__(self, output_dict): 78 | """ 79 | output_dict: Same as that used in the Thread class ^^^. 80 | """ 81 | self._thread_pool = [] 82 | self.output_dict = output_dict 83 | 84 | def add_thread(self, func, interval): 85 | """ 86 | Creates a thread, starts it and then adds it to the thread pool. 87 | 88 | Func: Same as in the Thread class. 89 | Interval: Same as in the Thread class. 90 | """ 91 | t = Thread(func, interval, self.output_dict) 92 | t.start() 93 | self._thread_pool.append(t) 94 | 95 | def kill_all_threads(self): 96 | """ 97 | Provides an easy way to graciously end all threads. 98 | """ 99 | for t in self._thread_pool: 100 | t.stop() 101 | self._thread_pool = [] 102 | 103 | 104 | class PluginLoader(): 105 | """ 106 | Loads classes from plugin files placed in the plugin directory. 107 | The plugin's class name must be the only part of the __all__ 108 | variable. Any files that should not be loaded as plugins require 109 | an underscore at the start of their filename, such as: 110 | _plugin.py 111 | """ 112 | def __init__(self, dir_path, config): 113 | self.dir_path = dir_path 114 | source_path = '/'.join(os.path.dirname(__file__).split('/')[0:-1]) 115 | source_path = os.path.join(source_path, 'plugins') 116 | if len(glob.glob(self.dir_path + '/*')) < len(glob.glob(source_path + '/*')) \ 117 | or os.path.getmtime(source_path) > os.path.getmtime(self.dir_path): 118 | shutil.rmtree(self.dir_path) 119 | shutil.copytree(source_path, self.dir_path) 120 | self._compile_files() 121 | self._config = config 122 | self.plugins = self.refresh_files() 123 | self.objects = self.load_objects() 124 | 125 | def _compile_files(self): 126 | """ 127 | Compiles python plugin files in order to be processed by the loader. 128 | It compiles the plugins if they have been updated or haven't yet been 129 | compiled. 130 | """ 131 | for f in glob.glob(os.path.join(self.dir_path, '*.py')): 132 | # Check for compiled Python files that aren't in the __pycache__. 133 | if not os.path.isfile(os.path.join(self.dir_path, f + 'c')): 134 | compileall.compile_dir(self.dir_path, quiet=True) 135 | logging.debug('Compiled plugins as a new plugin has been added.') 136 | return 137 | # Recompile if there are newer plugins. 138 | elif os.path.getmtime(os.path.join(self.dir_path, f)) > os.path.getmtime( 139 | os.path.join(self.dir_path, f + 'c')): 140 | compileall.compile_dir(self.dir_path, quiet=True) 141 | logging.debug('Compiled plugins as a plugin has been changed.') 142 | return 143 | 144 | def _load_compiled(self, file_path): 145 | """ 146 | Accepts a path to a compiled plugin and returns a module object. 147 | 148 | file_path: A string that represents a complete file path to a compiled 149 | plugin. 150 | """ 151 | name = os.path.splitext(os.path.split(file_path)[-1])[0] 152 | plugin_directory = os.sep.join(os.path.split(file_path)[0:-1]) 153 | compiled_directory = os.path.join(plugin_directory, '__pycache__') 154 | # Use glob to autocomplete the filename. 155 | compiled_file = glob.glob(os.path.join(compiled_directory, (name + '.*')))[0] 156 | plugin = imp.load_compiled(name, compiled_file) 157 | return plugin 158 | 159 | def load_objects(self): 160 | """ 161 | Matches the plugins that have been specified in the config file 162 | with the available plugins. Returns instantiated objects based upon 163 | the classes defined in the plugins. 164 | """ 165 | objects = [] 166 | for settings in self._config: 167 | if settings['plugin'] in self.plugins: 168 | module = self.plugins[settings['plugin']] 169 | # Trusts that the only item in __all__ is the name of the 170 | # plugin class. 171 | plugin_class = getattr(module, module.__all__) 172 | objects.append(plugin_class(settings)) 173 | logging.debug('Loaded a plugin object based upon {0}'.format( 174 | settings['plugin'])) 175 | else: 176 | logging.critical('Missing plugin {0} was not found in {1}'.format( 177 | settings['plugin'], self.dir_path)) 178 | raise MissingPlugin('The plugin {0} was not found in {1}'.format( 179 | settings['plugin'], self.dir_path)) 180 | return objects 181 | 182 | def refresh_files(self): 183 | """ 184 | Discovers the available plugins and turns each into a module object. 185 | This is a seperate function to allow plugins to be updated 186 | dynamically by other parts of the application. 187 | """ 188 | plugins = {} 189 | _plugin_files = glob.glob(os.path.join(self.dir_path, '[!_]*.pyc')) 190 | for f in glob.glob(os.path.join(self.dir_path, '[!_]*.py')): 191 | if not any(os.path.splitext(f)[0] == os.path.splitext(x)[0] 192 | for x in _plugin_files): 193 | logging.debug('Adding plugin {0}'.format(f)) 194 | _plugin_files.append(f) 195 | for f in _plugin_files: 196 | plugin = self._load_compiled(f) 197 | plugins[plugin.__name__] = plugin 198 | logging.debug('Loaded module object for plugin: {0}'.format(f)) 199 | return plugins 200 | -------------------------------------------------------------------------------- /i3situation/core/status.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import threading 3 | from collections import OrderedDict 4 | import logging 5 | import time 6 | import json 7 | import os 8 | from i3situation.core import plugin_manager 9 | from i3situation.core import config 10 | 11 | 12 | def setup_file_logger(filename, formatting, log_level): 13 | """ 14 | A helper function for creating a file logger. 15 | Accepts arguments, as it is used in Status and LoggingWriter. 16 | """ 17 | logger = logging.getLogger() 18 | # If a stream handler has been attached, remove it. 19 | if logger.handlers: 20 | logger.removeHandler(logger.handlers[0]) 21 | handler = logging.FileHandler(filename) 22 | logger.addHandler(handler) 23 | formatter = logging.Formatter(*formatting) 24 | handler.setFormatter(formatter) 25 | logger.setLevel(log_level) 26 | handler.setLevel(log_level) 27 | return logger 28 | 29 | 30 | class Status(): 31 | """ 32 | Handles the running of the status utility and acts as the glue for the 33 | application. 34 | """ 35 | def __init__(self): 36 | self.config = config.Config(self.discover_folder_path()) 37 | self.output_dict = OrderedDict() 38 | self._config_file_path = self.config.config_file_path 39 | self._plugin_path = self.config.plugin_path 40 | self._config_mod_time = os.path.getmtime(self._config_file_path) 41 | self._plugin_mod_time = os.path.getmtime(self._plugin_path) 42 | log_formatting = ('[%(asctime)s] - %(levelname)s - %(filename)s - ' 43 | '%(funcName)s - %(message)s', '%d/%m/%Y %I:%M:%S %p') 44 | self.logger = setup_file_logger(self.config.general['log_file'], 45 | log_formatting, self.config.general['logging_level']) 46 | 47 | # Redirect stderr so that it doesn't confuse i3bar by outputting to it. 48 | self.log_writer = self.LoggingWriter( 49 | self.config.general['log_file'], self.config.general['logging_level']) 50 | sys.stderr = self.log_writer 51 | logging.debug('Config loaded from {0}'.format(self._config_file_path)) 52 | logging.debug('Plugin path is located at {0}'.format(self._plugin_path)) 53 | logging.debug('Last config modification time is: {0}'.format(self._config_mod_time)) 54 | logging.debug('Last plugin directory modification time is: {0}'.format(self._plugin_mod_time)) 55 | self.output_to_bar(json.dumps({'version': 1, 'click_events': True}), False) 56 | self.output_to_bar('[', False) 57 | logging.debug('Sent initial JSON data to i3bar.') 58 | logging.debug('Beginning plugin loading process') 59 | self.loader = plugin_manager.PluginLoader( 60 | self._plugin_path, self.config.plugin) 61 | self.thread_manager = plugin_manager.ThreadManager(self.output_dict) 62 | # Event handling is done in another thread, so that the main thread 63 | # isn't stalled. 64 | self.event_thread = threading.Thread(target=self.handle_events) 65 | self.event_thread.start() 66 | 67 | def discover_folder_path(self): 68 | if os.environ.get('$XDG_CONFIG_HOME', None): 69 | folder_locations = [os.path.join(os.environ.get('$XDG_CONFIG_HOME'), 70 | 'i3situation'), '/etc/i3situation'] 71 | else: 72 | folder_locations = [os.path.join(os.path.expanduser('~'), '.config', 73 | 'i3situation'), '/etc/i3situation'] 74 | return folder_locations 75 | 76 | def output_to_bar(self, message, comma=True): 77 | """ 78 | Outputs data to stdout, without buffering. 79 | 80 | message: A string containing the data to be output. 81 | comma: Whether or not a comma should be placed at the end of the output. 82 | """ 83 | if comma: 84 | message += ',' 85 | sys.stdout.write(message + '\n') 86 | sys.stdout.flush() 87 | 88 | def reload(self): 89 | """ 90 | Reload the installed plugins and the configuration file. This is called 91 | when either the plugins or config get updated. 92 | """ 93 | logging.debug('Reloading config file as files have been modified.') 94 | self.config.plugin, self.config.general = self.config.reload() 95 | logging.debug('Reloading plugins as files have been modified.') 96 | self.loader = plugin_manager.PluginLoader( 97 | self._plugin_path, self.config.plugin) 98 | self._plugin_mod_time = os.path.getmtime(self._plugin_path) 99 | self._config_mod_time = os.path.getmtime(self._config_file_path) 100 | 101 | def run_plugins(self): 102 | """ 103 | Creates a thread for each plugin and lets the thread_manager handle it. 104 | """ 105 | for obj in self.loader.objects: 106 | # Reserve a slot in the output_dict in order to ensure that the 107 | # items are in the correct order. 108 | self.output_dict[obj.output_options['name']] = None 109 | self.thread_manager.add_thread(obj.main, obj.options['interval']) 110 | 111 | def run(self): 112 | """ 113 | Monitors if the config file or plugins are updated. Also outputs the 114 | JSON data generated by the plugins, without needing to poll the threads. 115 | """ 116 | self.run_plugins() 117 | while True: 118 | # Reload plugins and config if either the config file or plugin 119 | # directory are modified. 120 | if self._config_mod_time != os.path.getmtime(self._config_file_path) or \ 121 | self._plugin_mod_time != os.path.getmtime(self._plugin_path): 122 | self.thread_manager.kill_all_threads() 123 | self.output_dict.clear() 124 | self.reload() 125 | self.run_plugins() 126 | self.output_to_bar(json.dumps(self._remove_empty_output())) 127 | time.sleep(self.config.general['interval']) 128 | 129 | def _remove_empty_output(self): 130 | """ 131 | If plugins haven't been initialised and therefore not sending output or 132 | their output is None, there is no reason to take up extra room on the 133 | bar. 134 | """ 135 | output = [] 136 | for key in self.output_dict: 137 | if self.output_dict[key] is not None and 'full_text' in self.output_dict[key]: 138 | output.append(self.output_dict[key]) 139 | return output 140 | 141 | def handle_events(self): 142 | """ 143 | An event handler that processes events from stdin and calls the on_click 144 | function of the respective object. This function is run in another 145 | thread, so as to not stall the main thread. 146 | """ 147 | for event in sys.stdin: 148 | if event.startswith('['): 149 | continue 150 | name = json.loads(event.lstrip(','))['name'] 151 | for obj in self.loader.objects: 152 | if obj.output_options['name'] == name: 153 | obj.on_click(json.loads(event.lstrip(','))) 154 | 155 | class LoggingWriter(): 156 | """ 157 | A simple class that provides a file like interface to the logging 158 | utility. Allows stderr to be redirected to logging. 159 | """ 160 | def __init__(self, filename, logging_level): 161 | # FIXME: This formatting string overwrites the one defined 162 | # before, has been mentioned on the internet as being a bug 163 | # in th elogging module, will investigate later. 164 | formatting = ('[%(asctime)s] - %(levelname)s - %(filename)s -' 165 | ' %(threadName)s - %(funcName)s - %(message)s', 166 | '%d/%m/%Y %I:%M:%S %p') 167 | self.logger = setup_file_logger(filename, formatting, logging_level) 168 | self.logging_level = logging_level 169 | 170 | def write(self, message): 171 | """ 172 | Called once stderr is replaced and data needs to be written. 173 | """ 174 | if message != '\n': 175 | self.logger.log(self.logging_level, message) 176 | -------------------------------------------------------------------------------- /i3situation/main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | import logging 3 | from i3situation.core import status 4 | 5 | 6 | def main(): 7 | s = status.Status() 8 | logging.debug('Initialised Status object') 9 | s.run() 10 | 11 | if __name__ == '__main__': 12 | main() 13 | -------------------------------------------------------------------------------- /i3situation/plugins/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HarveyHunt/i3situation/3160a21006fcc6961f240988874e228a5ec6f18e/i3situation/plugins/__init__.py -------------------------------------------------------------------------------- /i3situation/plugins/_plugin.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | import json 3 | 4 | 5 | class Plugin(): 6 | """ 7 | A base class that should be inherited by all other plugins. 8 | It handles defaults, replacing options and managing lower level 9 | settings that a plugin developer need not bother with. 10 | 11 | config: A dictionary obtained from the config parser that has the 12 | user's configuration, as defined in their config file. 13 | """ 14 | def __init__(self, config): 15 | self.output_options = { 16 | 'color': None, 17 | 'min_width': None, 18 | 'align': None, 19 | 'name': None, 20 | 'urgent': None, 21 | 'separator': None, 22 | 'separator_block_width': None} 23 | # Replace default values with user defined ones. 24 | self.options.update(config) 25 | # Allow output options to be overwritten by the user. 26 | self.output_options.update((k, v) for k, v in config.items() if k in 27 | self.output_options) 28 | 29 | def output(self, full_text, short_text): 30 | """ 31 | Output all of the options and data for a segment. 32 | 33 | full_text: A string representing the data that should be output to i3bar. 34 | short_text: A more concise version of full_text, in case there is minimal 35 | room on the i3bar. 36 | """ 37 | full_text = full_text.replace('\n', '') 38 | short_text = short_text.replace('\n', '') 39 | self.output_options.update({'full_text': full_text, 'short_text': short_text}) 40 | self.output_options = {k: v for k, v in self.output_options.items() if v} 41 | return self.output_options 42 | 43 | def on_click(self, event): 44 | """ 45 | A function that should be overwritten by a plugin that wishes to react 46 | to events, if it wants to perform any action other than running the 47 | supplied command related to a button. 48 | 49 | event: A dictionary passed from i3bar (after being decoded from JSON) 50 | that has the folowing format: 51 | 52 | event = {'name': 'my_plugin', 'x': 231, 'y': 423} 53 | Note: It is also possible to have an instance key, but i3situation 54 | doesn't set it. 55 | """ 56 | if event['button'] == 1 and 'button1' in self.options: 57 | subprocess.call(self.options['button1'].split()) 58 | elif event['button'] == 2 and 'button2' in self.options: 59 | subprocess.call(self.options['button2'].split()) 60 | elif event['button'] == 3 and 'button3' in self.options: 61 | subprocess.call(self.options['button3'].split()) 62 | -------------------------------------------------------------------------------- /i3situation/plugins/battery.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | import os 3 | from i3situation.plugins._plugin import Plugin 4 | 5 | __all__ = 'BatteryPlugin' 6 | 7 | 8 | class BatteryPlugin(Plugin): 9 | """ 10 | Displays information about the battery, such as its current charge and 11 | current status (Discharging, Full, Charging). 12 | """ 13 | 14 | def __init__(self, config): 15 | self.options = {'format': '%', 16 | 'low_threshold': 20, 17 | 'low_color': '#FF0000', 18 | 'discharging_color': '#FF6103', 19 | 'charging_color': '#00F000', 20 | 'full_color': '#FFFFFF', 21 | 'percentage': True, 22 | 'battery_path': '/sys/class/power_supply/BAT0', 23 | 'interval': 30} 24 | 25 | super().__init__(config) 26 | 27 | def main(self): 28 | energy_now = int(self.get_battery_state('energy_now')) 29 | energy_full = int(self.get_battery_state('energy_full')) 30 | status = self.get_battery_state('status') 31 | 32 | charge = (energy_now / energy_full) * 100 if self.options['percentage'] else 1 33 | charge = int(charge) 34 | 35 | if charge > 100: 36 | charge = 100 37 | 38 | if charge < self.options['low_threshold']: 39 | self.output_options['color'] = self.options['low_color'] 40 | elif status == 'Full': 41 | self.output_options['color'] = self.options['charging_color'] 42 | elif status == 'Discharging': 43 | self.output_options['color'] = self.options['discharging_color'] 44 | elif status == 'Charging': 45 | self.output_options['color'] = self.options['charging_color'] 46 | 47 | output = self.options['format'].replace('', str(charge)) 48 | output = output.replace('', status) 49 | 50 | return self.output(output, output) 51 | 52 | def get_battery_state(self, prop): 53 | """ 54 | Return the first line from the file located at battery_path/prop as a 55 | string. 56 | """ 57 | with open(os.path.join(self.options['battery_path'], prop), 'r') as f: 58 | return f.readline().strip() 59 | -------------------------------------------------------------------------------- /i3situation/plugins/cmus.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | import datetime 3 | from i3situation.plugins._plugin import Plugin 4 | 5 | __all__ = 'CmusPlugin' 6 | 7 | 8 | class CmusPlugin(Plugin): 9 | 10 | def __init__(self, config): 11 | """ 12 | Possible format options are: 13 | 14 | status 15 | file 16 | duration 17 | position 18 | artist 19 | album 20 | title 21 | date 22 | genre 23 | tracknumber 24 | comment 25 | replaygain_track_gain 26 | aaa_mode 27 | continue 28 | play_library 29 | play_sorted 30 | replaygain 31 | replaygain_limit 32 | replaygain_preamp 33 | repeat 34 | repeat_current 35 | shuffle 36 | softvol 37 | vol_left 38 | vol_right 39 | """ 40 | self.options = {'interval': 1, 'format': 41 | 'artist - title - position/duration'} 42 | super().__init__(config) 43 | 44 | def main(self): 45 | """ 46 | A compulsary function that gets the output of the cmus-remote -Q command 47 | and converts it to unicode in order for it to be processed and finally 48 | output. 49 | """ 50 | try: 51 | # Setting stderr to subprocess.STDOUT seems to stop the error 52 | # message returned by the process from being output to STDOUT. 53 | cmus_output = subprocess.check_output(['cmus-remote', '-Q'], 54 | stderr=subprocess.STDOUT).decode('utf-8') 55 | except subprocess.CalledProcessError: 56 | return self.output(None, None) 57 | if 'duration' in cmus_output: 58 | status = self.convert_cmus_output(cmus_output) 59 | out_string = self.options['format'] 60 | for k, v in status.items(): 61 | out_string = out_string.replace(k, v) 62 | else: 63 | out_string = None 64 | return self.output(out_string, out_string) 65 | 66 | def convert_cmus_output(self, cmus_output): 67 | """ 68 | Change the newline separated string of output data into 69 | a dictionary which can then be used to replace the strings in the config 70 | format. 71 | 72 | cmus_output: A string with information about cmus that is newline 73 | seperated. Running cmus-remote -Q in a terminal will show you what 74 | you're dealing with. 75 | """ 76 | cmus_output = cmus_output.split('\n') 77 | cmus_output = [x.replace('tag ', '') for x in cmus_output if not x in ''] 78 | cmus_output = [x.replace('set ', '') for x in cmus_output] 79 | status = {} 80 | partitioned = (item.partition(' ') for item in cmus_output) 81 | status = {item[0]: item[2] for item in partitioned} 82 | status['duration'] = self.convert_time(status['duration']) 83 | status['position'] = self.convert_time(status['position']) 84 | return status 85 | 86 | def convert_time(self, time): 87 | """ 88 | A helper function to convert seconds into hh:mm:ss for better 89 | readability. 90 | 91 | time: A string representing time in seconds. 92 | """ 93 | time_string = str(datetime.timedelta(seconds=int(time))) 94 | if time_string.split(':')[0] == '0': 95 | time_string = time_string.partition(':')[2] 96 | return time_string 97 | -------------------------------------------------------------------------------- /i3situation/plugins/conky.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | from i3situation.plugins._plugin import Plugin 3 | 4 | __all__ = 'ConkyPlugin' 5 | 6 | 7 | class ConkyPlugin(Plugin): 8 | 9 | def __init__(self, config): 10 | self.options = {'command': '$uptime', 'interval': 1, 11 | 'config': '~/.conkyrc'} 12 | super().__init__(config) 13 | 14 | def main(self): 15 | try: 16 | out = subprocess.check_output(['conky', '-i', '1', '-t', 17 | self.options['command'], '-c', self.options['config']]).decode('utf8') 18 | except subprocess.CalledProcessError: 19 | out = 'A non-zero exit status was returned.' 20 | self.output_options['color'] = '#FF0000' 21 | except FileNotFoundError: 22 | out = 'Conky isn\'t installed.' 23 | self.output_options['color'] = '#FF0000' 24 | 25 | return self.output(out, out) 26 | -------------------------------------------------------------------------------- /i3situation/plugins/date_time.py: -------------------------------------------------------------------------------- 1 | import time 2 | import subprocess 3 | import os 4 | from i3situation.plugins._plugin import Plugin 5 | 6 | __all__ = 'DateTimePlugin' 7 | 8 | 9 | class DateTimePlugin(Plugin): 10 | 11 | def __init__(self, config): 12 | self.options = {'time_zone': None, 'long_format': '%d-%m-%Y %H:%M:%S', 13 | 'short_format': '%H:%M:%S', 'interval': 1, 'menu_command': ''} 14 | super().__init__(config) 15 | 16 | def main(self): 17 | cur = time.time() 18 | if self.options['time_zone']: 19 | os.environ['TZ'] = self.options['time_zone'] 20 | time.tzset() 21 | long_time = time.strftime(self.options['long_format'], time.localtime(cur)) 22 | short_time = time.strftime(self.options['short_format'], time.localtime(cur)) 23 | return self.output(long_time, short_time) 24 | -------------------------------------------------------------------------------- /i3situation/plugins/reddit.py: -------------------------------------------------------------------------------- 1 | import html.parser 2 | import webbrowser 3 | import requests 4 | from i3situation.plugins._plugin import Plugin 5 | 6 | __all__ = 'RedditPlugin' 7 | 8 | 9 | class RedditPlugin(Plugin): 10 | """ 11 | A plugin to display data from Reddit. The submissions on the front page can 12 | be displayed as well as the submissions on selected subreddits. The format 13 | options can contain the following keywords that will be replace at run time: 14 | 15 | link_flair_css_class 16 | approved_by 17 | num_reports 18 | num_comments 19 | author_flair_css_class 20 | link_flair_text 21 | ups 22 | author_flair_text 23 | permalink 24 | selftext 25 | domain 26 | subreddit_id 27 | over_18 28 | secure_media 29 | name 30 | media 31 | clicked 32 | score 33 | is_self 34 | stickied 35 | distinguished 36 | media_embed 37 | subreddit 38 | edited 39 | selftext_html 40 | banned_by 41 | likes 42 | created_utc 43 | hidden 44 | url 45 | id 46 | downs 47 | thumbnail 48 | author 49 | secure_media_embed 50 | title 51 | saved 52 | """ 53 | 54 | def __init__(self, config): 55 | self.options = {'mode': 'front', 'color': '#FFFFFF', 'interval': 30, 56 | 'subreddits': ['vim', 'python'], 'username': None, 57 | 'password': None, 'limit': 25, 'format': '[subreddit] title ↑ups', 58 | 'sort': 'hot', 'max_chars': 140} 59 | super().__init__(config) 60 | if isinstance(self.options['subreddits'], str): 61 | self.options['subreddits'] = [self.options['subreddits']] 62 | self.h = html.parser.HTMLParser() 63 | self.client = requests.session() 64 | self.client.headers.update({'user-agent': 'i3situation reddit plugin'}) 65 | 66 | def main(self): 67 | """ 68 | Generates an output string by replacing the keywords in the format 69 | string with the corresponding values from a submission dictionary. 70 | """ 71 | self.manage_submissions() 72 | out_string = self.options['format'] 73 | 74 | # Pop until we get something which len(title) <= max-chars 75 | length = float('inf') 76 | while length > self.options['max_chars']: 77 | self.selected_submission = self.submissions.pop() 78 | length = len(self.selected_submission['title']) 79 | 80 | for k, v in self.selected_submission.items(): 81 | out_string = out_string.replace(k, self.h.unescape(str(v))) 82 | return self.output(out_string, out_string) 83 | 84 | def login(self): 85 | """ 86 | Logs into Reddit in order to display a personalised front page. 87 | """ 88 | data = {'user': self.options['username'], 'passwd': 89 | self.options['password'], 'api_type': 'json'} 90 | response = self.client.post('http://www.reddit.com/api/login', data=data) 91 | self.client.modhash = response.json()['json']['data']['modhash'] 92 | 93 | def manage_submissions(self): 94 | """ 95 | If there are no or only one submissions left, get new submissions. 96 | This function manages URL creation and the specifics for front page 97 | or subreddit mode. 98 | """ 99 | if not hasattr(self, 'submissions') or len(self.submissions) == 1: 100 | self.submissions = [] 101 | if self.options['mode'] == 'front': 102 | # If there are no login details, the standard front 103 | # page will be displayed. 104 | if self.options['password'] and self.options['username']: 105 | self.login() 106 | url = 'http://reddit.com/.json?sort={0}'.format(self.options['sort']) 107 | self.submissions = self.get_submissions(url) 108 | elif self.options['mode'] == 'subreddit': 109 | for subreddit in self.options['subreddits']: 110 | url = 'http://reddit.com/r/{0}/.json?sort={1}'.format( 111 | subreddit, self.options['limit']) 112 | self.submissions += self.get_submissions(url) 113 | else: 114 | return 115 | 116 | def get_submissions(self, url): 117 | """ 118 | Connects to Reddit and gets a JSON representation of submissions. 119 | This JSON data is then processed and returned. 120 | 121 | url: A url that requests for submissions should be sent to. 122 | """ 123 | response = self.client.get(url, params={'limit': self.options['limit']}) 124 | submissions = [x['data'] for x in response.json()['data']['children']] 125 | return submissions 126 | -------------------------------------------------------------------------------- /i3situation/plugins/run.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | from i3situation.plugins._plugin import Plugin 3 | 4 | __all__ = 'RunPlugin' 5 | 6 | 7 | class RunPlugin(Plugin): 8 | """ 9 | A plugin that runs arbitrary shell commands and outputs them to the bar. 10 | USE WITH CAUTION. 11 | """ 12 | 13 | def __init__(self, config): 14 | self.options = {'command': 'echo No command', 15 | 'interval': 1} 16 | super().__init__(config) 17 | 18 | def main(self): 19 | shell_output = subprocess.check_output(self.options['command'].split(' '), 20 | stderr=subprocess.STDOUT).decode('utf-8') 21 | return self.output(shell_output, shell_output) 22 | -------------------------------------------------------------------------------- /i3situation/plugins/text.py: -------------------------------------------------------------------------------- 1 | from i3situation.plugins._plugin import Plugin 2 | 3 | __all__ = 'TextPlugin' 4 | 5 | 6 | class TextPlugin(Plugin): 7 | 8 | def __init__(self, config): 9 | self.options = {'text': '', 'interval': 1} 10 | super().__init__(config) 11 | 12 | def main(self): 13 | return self.output(self.options['text'], self.options['text']) 14 | -------------------------------------------------------------------------------- /i3situation/unit_tests/config.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import os 3 | import errno 4 | import configparser 5 | 6 | from i3situation.core import config 7 | 8 | 9 | class TestDataTypeReplacement(unittest.TestCase): 10 | 11 | def test_replace_data_types(self): 12 | self.assertEqual(config.Config._replace_data_types({'': 'true'})[''], 13 | True) 14 | self.assertEqual(config.Config._replace_data_types({'': 'True'})[''], 15 | True) 16 | self.assertEqual(config.Config._replace_data_types({'': 'on'})[''], 17 | True) 18 | 19 | self.assertEqual(config.Config._replace_data_types({'': 'false'})[''], 20 | False) 21 | self.assertEqual(config.Config._replace_data_types({'': 'False'})[''], 22 | False) 23 | self.assertEqual(config.Config._replace_data_types({'': 'off'})[''], 24 | False) 25 | 26 | self.assertEqual(config.Config._replace_data_types( 27 | {'log_file': '~'})['log_file'], os.path.expanduser('~')) 28 | 29 | self.assertEqual(config.Config._replace_data_types({'': '1'})[''], 30 | 1) 31 | 32 | self.assertEqual(config.Config._replace_data_types({'': '1, 2, 3'})[''], 33 | ['1', '2', '3']) 34 | 35 | for level, value in {'NONE': 0, 'NULL': 0, 'DEBUG': 10, 'INFO': 20, 36 | 'WARNING': 30, 'ERROR': 40, 'CRITICAL': 50}.items(): 37 | self.assertEqual(config.Config._replace_data_types({'': level})[''], 38 | value) 39 | 40 | 41 | class TestConfigIncorrectFile(unittest.TestCase): 42 | def setUp(self): 43 | if os.environ.get('$XDG_CONFIG_HOME', None): 44 | self.folder_location = [os.path.join(os.environ.get('$XDG_CONFIG_HOME'), 45 | 'i3situation', 'tests')] 46 | else: 47 | self.folder_location = [os.path.join(os.path.expanduser('~'), '.config', 48 | 'i3situation', 'tests')] 49 | 50 | def test_no_config(self): 51 | with self.assertRaises(TypeError): 52 | c = config.Config() 53 | 54 | def test_empty_config(self): 55 | self._create_config('') 56 | with self.assertRaises(config.IncompleteConfigurationFile): 57 | c = config.Config(self.folder_location) 58 | 59 | def test_wrong_permissions(self): 60 | with self.assertRaises(PermissionError): 61 | c = config.Config('/root/') 62 | 63 | def test_wrong_path(self): 64 | with self.assertRaises(OSError): 65 | c = config.Config(os.path.join(os.path.expanduser('~'), 66 | 'i3situation-test')) 67 | 68 | def test_missing_header(self): 69 | self._create_config('WRONGDATA') 70 | with self.assertRaises(configparser.MissingSectionHeaderError): 71 | c = config.Config(self.folder_location) 72 | 73 | def test_incomplete_header(self): 74 | self._create_config('[gener]') 75 | with self.assertRaises(config.IncompleteConfigurationFile): 76 | c = config.Config(self.folder_location) 77 | 78 | def test_default_general_config(self): 79 | default_general_config = config.Config._replace_data_types({'interval': 80 | '1', 'logging_level': 'ERROR', 'log_file': 81 | '~/.config/i3situation/log.txt', 'colors': 'True'}) 82 | self._create_default_config() 83 | conf = config.Config(self.folder_location) 84 | self.assertEqual(conf.general, default_general_config) 85 | 86 | def _create_config(self, config_string): 87 | def _touch_dir(self, path): 88 | """ 89 | A helper function to create a directory if it doesn't exist. 90 | 91 | path: A string containing a full path to the directory to be created. 92 | """ 93 | try: 94 | os.makedirs(path) 95 | except OSError as e: 96 | if e.errno != errno.EEXIST: 97 | raise 98 | _touch_dir(self, self.folder_location[0]) 99 | with open(os.path.join(self.folder_location[0], 'config'), 'w') as f: 100 | f.write(config_string) 101 | 102 | def _create_default_config(self): 103 | s = '[general]\ninterval = 1\nlogging_level = ERROR\n' \ 104 | 'log_file = ~/.config/i3situation/log.txt\ncolors = true' 105 | self._create_config(s) 106 | 107 | 108 | if __name__ == '__main__': 109 | unittest.main() 110 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | import os 3 | from setuptools import setup 4 | from setuptools import find_packages 5 | 6 | 7 | def read(fname): 8 | try: 9 | return open(os.path.join(os.path.dirname(__file__), fname)).read() 10 | except IOError: 11 | return "" 12 | 13 | setup(name='i3situation', 14 | packages=find_packages(), 15 | version='1.0.5', 16 | description='A replacement for i3status that allows for the use of plugins.', 17 | author='Harvey Hunt', 18 | url='https://github.com/HarveyHunt/i3situation', 19 | author_email='harveyhuntnexus@gmail.com', 20 | license="GPLv3", 21 | keywords="python3 i3situation i3 i3wm i3status i3bar json", 22 | install_requires=['requests'], 23 | long_description=read('README.md'), 24 | entry_points={'console_scripts': ['i3situation=i3situation.main:main']}) 25 | --------------------------------------------------------------------------------