├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── Makefile ├── README.md ├── THANKS.md ├── pyproject.toml ├── requirements.txt ├── sample-todo.txt ├── todo-indicator ├── todo-indicator-shot.png └── todo_indicator ├── img ├── panel-icon-dark.svg └── panel-icon-light.svg ├── indicator.py ├── main.py └── todotxt ├── __init__.py ├── item.py ├── list.py ├── test_item.py └── test_list.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Swiped from: https://github.com/github/gitignore/blob/main/Python.gitignore 2 | examples/* 3 | TODO.md 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | *$py.class 9 | 10 | # C extensions 11 | *.so 12 | 13 | # Distribution / packaging 14 | .Python 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | downloads/ 19 | eggs/ 20 | .eggs/ 21 | lib/ 22 | lib64/ 23 | parts/ 24 | sdist/ 25 | var/ 26 | wheels/ 27 | share/python-wheels/ 28 | *.egg-info/ 29 | .installed.cfg 30 | *.egg 31 | MANIFEST 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .nox/ 47 | .coverage 48 | .coverage.* 49 | .cache 50 | nosetests.xml 51 | coverage.xml 52 | *.cover 53 | *.py,cover 54 | .hypothesis/ 55 | .pytest_cache/ 56 | cover/ 57 | 58 | # Translations 59 | *.mo 60 | *.pot 61 | 62 | # Django stuff: 63 | *.log 64 | local_settings.py 65 | db.sqlite3 66 | db.sqlite3-journal 67 | 68 | # Flask stuff: 69 | instance/ 70 | .webassets-cache 71 | 72 | # Scrapy stuff: 73 | .scrapy 74 | 75 | # Sphinx documentation 76 | docs/_build/ 77 | 78 | # PyBuilder 79 | .pybuilder/ 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # IPython 86 | profile_default/ 87 | ipython_config.py 88 | 89 | # pyenv 90 | # For a library or package, you might want to ignore these files since the code is 91 | # intended to run in multiple environments; otherwise, check them in: 92 | # .python-version 93 | 94 | # pipenv 95 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 96 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 97 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 98 | # install all needed dependencies. 99 | #Pipfile.lock 100 | 101 | # poetry 102 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 103 | # This is especially recommended for binary packages to ensure reproducibility, and is more 104 | # commonly ignored for libraries. 105 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 106 | #poetry.lock 107 | 108 | # pdm 109 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 110 | #pdm.lock 111 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 112 | # in version control. 113 | # https://pdm.fming.dev/#use-with-ide 114 | .pdm.toml 115 | 116 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 117 | __pypackages__/ 118 | 119 | # Celery stuff 120 | celerybeat-schedule 121 | celerybeat.pid 122 | 123 | # SageMath parsed files 124 | *.sage.py 125 | 126 | # Environments 127 | .env 128 | .venv 129 | env/ 130 | venv/ 131 | ENV/ 132 | env.bak/ 133 | venv.bak/ 134 | 135 | # Spyder project settings 136 | .spyderproject 137 | .spyproject 138 | 139 | # Rope project settings 140 | .ropeproject 141 | 142 | # mkdocs documentation 143 | /site 144 | 145 | # mypy 146 | .mypy_cache/ 147 | .dmypy.json 148 | dmypy.json 149 | 150 | # ruff! 151 | .ruff_cache/ 152 | 153 | # Pyre type checker 154 | .pyre/ 155 | 156 | # pytype static type analyzer 157 | .pytype/ 158 | 159 | # Cython debug symbols 160 | cython_debug/ 161 | 162 | # PyCharm 163 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 164 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 165 | # and can be added to the global gitignore or merged into this file. For a more nuclear 166 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 167 | #.idea/ 168 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## 0.7.0 - 2024-03-25 9 | 10 | ### Added 11 | 12 | - This changelog! It's never too late, right?! 13 | 14 | ### Changed 15 | 16 | - Show the list's actual filename in "Edit" menu item instead of hard-coded 17 | `todo.txt`. ([PR #6](https://github.com/keithfancher/Todo-Indicator/pull/6).) 18 | - Update module structure for proper packaging and installation. 19 | - Update build system and package metadata. 20 | - Documentation updates: bring things into the current century, mostly. 21 | 22 | ## 0.6.0 - 2022-10-17 23 | 24 | ### Added 25 | 26 | - Python 3 support. ([PR #5](https://github.com/keithfancher/Todo-Indicator/pull/5).) 27 | 28 | ### Fixed 29 | 30 | - A few under-the-hood updates to how we import our dependencies. Un-break 31 | things in more modern distros. 32 | 33 | ## 0.5.0 - 2014-04-30 34 | 35 | ## 0.4.0 - 2014-04-17 36 | 37 | ## 0.3.0 - 2013-03-01 38 | 39 | ## 0.2.0 - 2013-02-05 40 | 41 | ## 0.1.0 - 2012-10-07 42 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all format lint test build 2 | 3 | all: format lint 4 | 5 | format: 6 | @# Cannot yet sort imports as part of `format`. 7 | @# See: https://docs.astral.sh/ruff/formatter/#sorting-imports 8 | @echo "Formatting all python source files..." 9 | ruff check --select I --fix . 10 | ruff format . 11 | @echo "Done\n" 12 | 13 | lint: 14 | @echo "Linting all python source files..." 15 | ruff check 16 | @echo "Done\n" 17 | 18 | test: 19 | python -m unittest discover todo_indicator 20 | 21 | build: 22 | python -m build 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # todo-indicator 2 | 3 | An Ubuntu app indicator for [todo.txt](http://todotxt.org/)-style todo lists. 4 | 5 | ![todo-indicator indicating](https://raw.github.com/keithfancher/todo-indicator/master/todo-indicator-shot.png) 6 | 7 | 8 | ## Installation 9 | 10 | Install `todo-indicator` with `pip`: 11 | 12 | ```bash 13 | pip install todo-indicator 14 | ``` 15 | 16 | If you're using `pipx` (for example on Ubuntu 23.04 or greater), the simplest 17 | option is to install with the `--system-site-packages` argument: 18 | 19 | ```bash 20 | pipx install --system-site-packages todo-indicator 21 | ``` 22 | 23 | In either case, note that **todo-indicator has some system dependencies which 24 | `pip` can't easily satisfy**. The following should ensure you have everything 25 | you need: 26 | 27 | ```bash 28 | sudo apt install python3-pyinotify python3-gi gir1.2-appindicator3-0.1 29 | ``` 30 | 31 | (The above is verified working on Ubuntu 20.04 and 22.04. I can't speak for 32 | other versions or distros, but it will likely be something similar.) 33 | 34 | If you prefer to run `todo-indicator` in a virtual env (or if you're required 35 | to do so by `pipx`) and you do *not* want to use the `--system-site-packages` 36 | option, you'll need to `pip install` (or `pipx inject`) the required 37 | dependencies in your virtual env. Unfortunately, because of the `PyGObject` 38 | dependency, there are some extra steps involved with this. For more details, 39 | see the [Contributing](#contributing) section -- this is the same process 40 | you'd go through for local development. 41 | 42 | Note that you can also simply clone the repo and run the provided 43 | `todo-indicator` binary directly, without installing it. You'll still need to 44 | install the required dependencies as described above, however. 45 | 46 | 47 | ## Requirements 48 | 49 | * Python 3 50 | * The above-mentioned system dependencies 51 | * An app-indicator-aware system tray of some kind (you might need a plugin if 52 | you're running a non-Ubuntu distro) 53 | 54 | 55 | ## Usage 56 | 57 | Just run `todo-indicator`, passing the name of your `todo.txt` file as an 58 | argument, e.g.: 59 | 60 | ```bash 61 | todo-indicator ~/todo.txt 62 | ``` 63 | 64 | Click the indicator icon to see your list. If you finish one of your tasks, 65 | give yourself a pat on the back and click it! It'll be marked "done." 66 | 67 | 68 | ### Editing your list 69 | 70 | `todo-indicator`'s goal is to show you your list and let you check items off. 71 | Anything more complex than that, you'll want to use your trusty text editor. 72 | 73 | Click "Edit todo.txt" and your todo list will open in your text editor of 74 | choice. (Or your OS's text editor of choice, at least -- it uses `xdg-open`.) 75 | Once you've made your changes and saved the file, you should see your updates 76 | automatically reflected in the `todo-indicator` UI. (Thanks, `inotify`!) 77 | 78 | If for some reason the indicator doesn't update, click "Refresh". 79 | 80 | 81 | ### Command-line options 82 | 83 | Use `-e`/`--editor` to specify a text editor other than your default: 84 | 85 | ```bash 86 | todo-indicator -e gvim ~/todo.txt 87 | ``` 88 | 89 | `todo-indicator` assumes a dark-colored panel by default. If you use a 90 | light-colored panel, you can pass the `-i`/`--invert` option to invert the 91 | icon color: 92 | 93 | ```bash 94 | todo-indicator -i ~/todo.txt 95 | ``` 96 | 97 | 98 | ## Contributing 99 | 100 | Check the `Makefile` for some common operations like code formatting, linting, 101 | and running unit tests. 102 | 103 | If you install/run `todo-indicator` inside a virtual env (usually recommended 104 | for development), you'll need to install the dependencies from the 105 | `requirements.txt` file: 106 | 107 | ```bash 108 | pip install -r requirements.txt 109 | ``` 110 | 111 | This includes `PyGObject`, which itself needs some extra development 112 | dependencies to be installed on your system. See [the PyGObject 113 | docs](https://gnome.pages.gitlab.gnome.org/pygobject/getting_started.html#ubuntu-logo-ubuntu-debian-logo-debian) 114 | for more info. 115 | 116 | Alternatively, you can skip this step, install the "normal" system-level 117 | dependencies from the [Installation](#installation) section, and create your 118 | virtual env with the `--system-site-packages` option: 119 | 120 | ```bash 121 | python -m venv --system-site-packages .venv 122 | ``` 123 | 124 | This will allow your local, virtual env version of `todo-indicator` to import 125 | your system-level python libraries (in particular the `gi` package). 126 | -------------------------------------------------------------------------------- /THANKS.md: -------------------------------------------------------------------------------- 1 | # Thanks to: 2 | 3 | - Getting Things Gnome, whose wonderful panel icon I've appropriated 4 | - Andrew from webupd8.org, for hosting `todo-indicator` in the webupd8 PPA 5 | - Michael Mayer (@tenbaht), for his lovely python3 PR! 6 | - Anyone who filed a bug! 7 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["hatchling"] 3 | build-backend = "hatchling.build" 4 | 5 | [project] 6 | name = "todo-indicator" 7 | version = "0.7.0" 8 | description = "An Ubuntu app indicator for todo.txt-style todo lists" 9 | authors = [ 10 | {name="Keith Fancher"}, 11 | ] 12 | requires-python = ">= 3" 13 | dependencies = [ 14 | "pyinotify", 15 | ] 16 | readme = "README.md" 17 | keywords = ["todo.txt", "todo", "indicator", "appindicator"] 18 | classifiers = [ 19 | "Development Status :: 5 - Production/Stable", 20 | "Programming Language :: Python :: 3", 21 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 22 | "Operating System :: POSIX :: Linux", 23 | ] 24 | 25 | [project.urls] 26 | GitHub = "https://github.com/keithfancher/todo-indicator" 27 | 28 | [project.scripts] 29 | todo-indicator = "todo_indicator.main:main" 30 | 31 | [tool.hatch.build.targets.wheel] 32 | packages = ["todo_indicator"] 33 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | build==1.1.1 2 | PyGObject==3.48.1 3 | pyinotify==0.9.6 4 | ruff==0.3.4 5 | -------------------------------------------------------------------------------- /sample-todo.txt: -------------------------------------------------------------------------------- 1 | (A) Do that really important thing 2 | (D) Remember how Python works 3 | (A) This other important thing 4 | (B) Walk the cat 5 | 6 | Something with no priority! 7 | (C) Cook the dog 8 | x Be annoyed at GTK3 docs 9 | -------------------------------------------------------------------------------- /todo-indicator: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | 4 | # Copyright 2012-2014, 2022 Keith Fancher 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | 20 | from todo_indicator.main import main 21 | 22 | if __name__ == "__main__": 23 | main() 24 | -------------------------------------------------------------------------------- /todo-indicator-shot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keithfancher/todo-indicator/225a61def080e93ad8126471db0ff05b2812ea63/todo-indicator-shot.png -------------------------------------------------------------------------------- /todo_indicator/img/panel-icon-dark.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 19 | 21 | 22 | 24 | image/svg+xml 25 | 27 | 28 | 29 | 30 | 50 | 52 | 54 | 58 | 62 | 63 | 72 | 73 | 76 | 81 | 86 | 87 | 88 | -------------------------------------------------------------------------------- /todo_indicator/img/panel-icon-light.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 19 | 21 | 22 | 24 | image/svg+xml 25 | 27 | 28 | 29 | 30 | 50 | 52 | 54 | 58 | 62 | 63 | 72 | 74 | 78 | 82 | 83 | 92 | 102 | 103 | 107 | 111 | 112 | -------------------------------------------------------------------------------- /todo_indicator/indicator.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import os 18 | 19 | import gi 20 | import pyinotify 21 | 22 | # Required before importing `AppIndicator3` below: 23 | gi.require_version("AppIndicator3", "0.1") 24 | 25 | # Stop `ruff` from complaining about these imports not being at the top. They can't be :') 26 | # ruff: noqa: E402 27 | 28 | from gi.repository import AppIndicator3 as appindicator 29 | from gi.repository import GObject, Gtk 30 | 31 | from todo_indicator.todotxt.list import TodoTxtList 32 | 33 | IMG_PATH = os.path.dirname(os.path.realpath(__file__)) + "/img/" 34 | LIGHT_ICON = IMG_PATH + "panel-icon-light.svg" # Light icon for dark panel background 35 | DARK_ICON = IMG_PATH + "panel-icon-dark.svg" # Dark icon for light panel background 36 | DEFAULT_EDITOR = "xdg-open" 37 | 38 | 39 | class TodoTxtIndicator(object): 40 | def __init__(self, todo_filename, text_editor=None, invert_icon=False): 41 | """Sets the filename, loads the list of items from the file, builds the 42 | indicator, &c.""" 43 | if text_editor: 44 | self.text_editor = text_editor 45 | else: 46 | self.text_editor = DEFAULT_EDITOR 47 | 48 | if invert_icon: 49 | self.icon_path = DARK_ICON 50 | else: 51 | # Default to light icon, assuming dark panel background: 52 | self.icon_path = LIGHT_ICON 53 | 54 | # Initialize the main list object: 55 | self.todo_list = TodoTxtList(todo_filename) 56 | 57 | # Non-list menu items: 58 | self._setup_menu_items(todo_filename) 59 | 60 | # Necessary for threaded notifications: 61 | GObject.threads_init() 62 | 63 | # Does the GUI need to catch up with our list file? 64 | self.list_updated_flag = False 65 | 66 | # Creates self.ind, the main indicator object: 67 | self._build_indicator() 68 | 69 | # Starts up inotify, watches our list file: 70 | self._setup_inotify() 71 | 72 | # Add timeout function, allows threading to not fart all over itself. 73 | # Can't use Gobject.idle_add() since it rudely 100%s the CPU. 74 | GObject.timeout_add(500, self._update_if_todo_file_changed) 75 | 76 | def _setup_inotify(self): 77 | """Watch for modifications of the todo file with pyinotify. We have to 78 | watch the entire path, since inotify is very inconsistent about what 79 | events it catches for a single file.""" 80 | self.wm = pyinotify.WatchManager() 81 | self.notifier = pyinotify.ThreadedNotifier(self.wm, self._process_inotify_event) 82 | self.notifier.start() 83 | 84 | # The IN_MOVED_TO watch catches Dropbox updates, which don't trigger 85 | # normal IN_MODIFY events. 86 | todo_path = os.path.dirname(self.todo_list.todo_filename) 87 | self.wm.add_watch(todo_path, pyinotify.IN_MODIFY | pyinotify.IN_MOVED_TO) 88 | 89 | def _setup_menu_items(self, todo_filename): 90 | """Menu items (aside from the todo items themselves). An association of 91 | text and callback functions. Can't use a dict because we need to 92 | preserve order.""" 93 | self._menu_items = [ 94 | ("Edit " + todo_filename.split("/")[-1], self._edit_handler), 95 | ("Clear completed", self._clear_completed_handler), 96 | ("Refresh", self._refresh_handler), 97 | ("Quit", self._quit_handler), 98 | ] 99 | 100 | def _update_if_todo_file_changed(self): 101 | """This will be called by the main GTK thread every half second or so. 102 | If the self.list_updated_flag is False, it will immediately return. If 103 | it's True, it will rebuild the GUI with the updated list and reset the 104 | flag. This is necessary since threads + GTK are wonky as fuck.""" 105 | if self.list_updated_flag: 106 | self._build_indicator() # rebuild 107 | self.list_updated_flag = False # reset flag 108 | 109 | # If we don't explicitly return True here the callback will be removed 110 | # from the queue after one call and will never be called again. 111 | return True 112 | 113 | def _process_inotify_event(self, event): 114 | """This callback is typically an instance of the ProcessEvent class, 115 | but after digging through the pyinotify source it looks like it can 116 | also be a function? This makes things much easier in our case, avoids 117 | nested classes, etc. 118 | 119 | This function can't explicitly update the GUI since it's on a different 120 | thread, so it just flips a flag and lets another function called by the 121 | GTK main loop do the real work.""" 122 | if event.pathname == self.todo_list.todo_filename: 123 | self.list_updated_flag = True 124 | 125 | def _check_off_handler(self, menu_item): 126 | """Checks off the item in our list that matches the clicked label. If 127 | you have multiple todo items that are exactly the same, this will check 128 | them all off. Also, you're stupid for doing that.""" 129 | self.todo_list.mark_item_completed_with_full_text(menu_item.get_label()) 130 | self.todo_list.write_to_file() 131 | self._build_indicator() # rebuild! 132 | 133 | def _edit_handler(self, menu_item): 134 | """Opens the todo.txt file with selected editor.""" 135 | os.system(self.text_editor + " " + self.todo_list.todo_filename) 136 | 137 | def _clear_completed_handler(self, menu_item): 138 | """Remove checked off items, rebuild list menu.""" 139 | self.todo_list.remove_completed_items() 140 | self.todo_list.write_to_file() 141 | self._build_indicator() 142 | 143 | def _refresh_handler(self, menu_item): 144 | """Manually refreshes the list.""" 145 | self._build_indicator() # rebuild indicator 146 | 147 | def _quit_handler(self, menu_item): 148 | """Quits our fancy little program.""" 149 | self.notifier.stop() # stop watching the file! 150 | Gtk.main_quit() 151 | 152 | def _add_list_menu_items(self, menu): 153 | """Creates menu items for each of our todo list items. Pass it a GTK 154 | menu object, it returns that object with menu items added.""" 155 | for todo_item in sorted(self.todo_list.items): # Display items sorted 156 | menu_item = Gtk.MenuItem(str(todo_item)) 157 | if todo_item.is_completed: # gray out completed items 158 | menu_item.set_sensitive(False) 159 | menu_item.connect("activate", self._check_off_handler) 160 | menu_item.show() 161 | menu.append(menu_item) 162 | return menu 163 | 164 | def _build_indicator(self): 165 | """Builds the Indicator object.""" 166 | if not hasattr(self, "ind"): # self.ind needs to be created 167 | self.ind = appindicator.Indicator.new( 168 | "todo-txt-indicator", 169 | self.icon_path, 170 | appindicator.IndicatorCategory.OTHER, 171 | ) 172 | self.ind.set_status(appindicator.IndicatorStatus.ACTIVE) 173 | 174 | # Make sure the list is loaded: 175 | self.todo_list.reload_from_file() 176 | 177 | menu = Gtk.Menu() 178 | if self.todo_list.has_items(): 179 | # Create todo menu items, if they exist: 180 | menu = self._add_list_menu_items(menu) 181 | else: 182 | # If the list is empty, show helpful message: 183 | menu_item = Gtk.MenuItem("[ No items. Click 'Edit' to add some! ]") 184 | menu_item.set_sensitive(False) 185 | menu_item.show() 186 | menu.append(menu_item) 187 | 188 | # Add a separator: 189 | menu_item = Gtk.SeparatorMenuItem() 190 | menu_item.show() 191 | menu.append(menu_item) 192 | 193 | # Our menu: 194 | for text, callback in self._menu_items: 195 | menu_item = Gtk.MenuItem(text) 196 | menu_item.connect("activate", callback) 197 | menu_item.show() 198 | menu.append(menu_item) 199 | 200 | # Do it! 201 | self.ind.set_menu(menu) 202 | 203 | def main(self): 204 | """The indicator's main loop.""" 205 | Gtk.main() 206 | -------------------------------------------------------------------------------- /todo_indicator/main.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import argparse 18 | 19 | from todo_indicator.indicator import TodoTxtIndicator 20 | 21 | 22 | def get_args(): 23 | """Gets and parses command line arguments.""" 24 | parser = argparse.ArgumentParser() 25 | parser.add_argument( 26 | "-e", "--editor", action="store", help="your favorite text editor" 27 | ) 28 | parser.add_argument( 29 | "-i", 30 | "--invert", 31 | action="store_true", 32 | default=False, 33 | help="invert the panel icon color", 34 | ) 35 | parser.add_argument("todo_filename", action="store", help="your todo.txt file") 36 | return parser.parse_args() 37 | 38 | 39 | def main(): 40 | args = get_args() 41 | ind = TodoTxtIndicator(args.todo_filename, args.editor, args.invert) 42 | ind.main() 43 | -------------------------------------------------------------------------------- /todo_indicator/todotxt/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keithfancher/todo-indicator/225a61def080e93ad8126471db0ff05b2812ea63/todo_indicator/todotxt/__init__.py -------------------------------------------------------------------------------- /todo_indicator/todotxt/item.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import functools 18 | import re 19 | 20 | 21 | @functools.total_ordering 22 | class TodoTxtItem(object): 23 | def __init__(self, text=None, priority=None, is_completed=False): 24 | self.text = text 25 | self.priority = priority 26 | self.is_completed = is_completed 27 | 28 | def init_from_text(self, item_text): 29 | item_text = item_text.strip() 30 | 31 | # First get completion: 32 | if item_text[:2] == "x ": 33 | self.is_completed = True 34 | item_text = item_text[2:].strip() 35 | else: 36 | self.is_completed = False 37 | 38 | # Now get priority, if it exists: 39 | priority_regex = r"^\(([A-Z])\) " 40 | match = re.search(priority_regex, item_text) 41 | if match: 42 | self.priority = match.group(1) 43 | item_text = item_text[3:].strip() 44 | else: 45 | self.priority = None 46 | 47 | self.text = item_text 48 | 49 | def has_priority(self): 50 | """This is useful when sorting list items.""" 51 | return self.priority is not None 52 | 53 | def __str__(self): 54 | if self.is_completed: 55 | output = "x " 56 | else: 57 | output = "" 58 | 59 | if self.priority: 60 | output = output + "(" + self.priority + ") " 61 | 62 | return output + self.text 63 | 64 | def __eq__(self, other): 65 | return ( 66 | self.text == other.text 67 | and self.is_completed == other.is_completed 68 | and self.priority == other.priority 69 | ) 70 | 71 | def __lt__(self, other): 72 | # First sort by completion: 73 | if not self.is_completed and other.is_completed: 74 | return True 75 | if self.is_completed and not other.is_completed: 76 | return False 77 | 78 | # Then sort by whether an item is prioritized: 79 | if self.has_priority() and not other.has_priority(): 80 | return True 81 | if not self.has_priority() and other.has_priority(): 82 | return False 83 | 84 | if self.has_priority() and other.has_priority(): 85 | # Now we know both have priority, so sort by that next: 86 | if self.priority < other.priority: 87 | return True 88 | if self.priority > other.priority: 89 | return False 90 | 91 | # Priorities are equal, so sort by actual text: 92 | if self.text < other.text: 93 | return True 94 | 95 | # Otherwise this item is not less than t'other! 96 | return False 97 | -------------------------------------------------------------------------------- /todo_indicator/todotxt/list.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import os 18 | import sys 19 | 20 | from todo_indicator.todotxt.item import TodoTxtItem 21 | 22 | 23 | class TodoTxtList(object): 24 | def __init__(self, todo_filename=None, todo_text=None): 25 | """Can initialize from either a file, or from text directly.""" 26 | self.items = [] 27 | self.items_as_text = "" 28 | self.todo_filename = "" 29 | 30 | if todo_filename: 31 | self.init_from_file(todo_filename) 32 | elif todo_text: 33 | self.init_from_text(todo_text) 34 | 35 | def init_from_text(self, list_text): 36 | """Init the list object from a plaintext todo.txt list.""" 37 | todo_lines = list_text.split("\n") 38 | for todo_line in todo_lines: 39 | self.add_item(todo_line) 40 | 41 | def init_from_file(self, file_name): 42 | """Init the list object from the *filename* of a todo.txt list.""" 43 | self.todo_filename = os.path.abspath(file_name) # absolute path! 44 | 45 | try: 46 | with open(self.todo_filename, "r+") as f: 47 | todo_lines = f.read() 48 | except IOError: 49 | print("Error opening file:\n" + self.todo_filename) 50 | sys.exit(1) 51 | 52 | self.init_from_text(todo_lines) 53 | 54 | def reload_from_file(self): 55 | """Reload the list from already-set filename.""" 56 | if self.todo_filename: 57 | self.items = [] # Clear out existing items 58 | self.init_from_file(self.todo_filename) 59 | 60 | def add_item(self, item_text): 61 | """Turn a line of text into a TodoTxtItem object, then append it to our 62 | list of those objects.""" 63 | if item_text.strip(): 64 | new_list_item = TodoTxtItem() 65 | new_list_item.init_from_text(item_text) 66 | self.items.append(new_list_item) 67 | 68 | def num_items(self): 69 | return len(self.items) 70 | 71 | def has_items(self): 72 | return self.num_items() > 0 73 | 74 | def remove_item(self, item_text): 75 | """Remove item with matching item text.""" 76 | self.items = [x for x in self.items if x.text != item_text] 77 | 78 | def remove_completed_items(self): 79 | """Remove all completed items from todo list.""" 80 | self.items = [x for x in self.items if not x.is_completed] 81 | 82 | def mark_item_completed(self, item_text): 83 | """Mark item with matching text completed.""" 84 | for item in self.items: 85 | if item.text == item_text: 86 | item.is_completed = True 87 | 88 | def mark_item_completed_with_full_text(self, full_text): 89 | """Matches the full text of an item, which includes the priority and 90 | completion. This is useful/necessary for matching a list item with its 91 | menu item in the UI.""" 92 | for item in self.items: 93 | if str(item) == full_text: 94 | item.is_completed = True 95 | 96 | def sort_list(self): 97 | """Thank you for being magical, magic methods.""" 98 | self.items = sorted(self.items) 99 | 100 | def write_to_file(self): 101 | """Output the list to a file.""" 102 | try: 103 | with open(self.todo_filename, "w") as f: 104 | f.write(str(self)) 105 | except IOError: 106 | print("Error writing to file:\n" + self.todo_filename) 107 | sys.exit(1) 108 | 109 | def __str__(self): 110 | list_text = "" 111 | for item in self.items: 112 | list_text = list_text + str(item) + "\n" 113 | return list_text.strip() 114 | -------------------------------------------------------------------------------- /todo_indicator/todotxt/test_item.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import unittest 18 | 19 | from todo_indicator.todotxt.item import TodoTxtItem 20 | 21 | 22 | class TestTodoTxtItem(unittest.TestCase): 23 | def test_init_from_text_completion(self): 24 | completed_item = "x This is a completed item" 25 | completed_whitespace = " x Also completed " 26 | not_completed = "xNope, not even close" 27 | also_not_completed = " Nope, not even close" 28 | 29 | test_item = TodoTxtItem() 30 | test_item.init_from_text(completed_item) 31 | self.assertTrue(test_item.is_completed) 32 | self.assertEqual(test_item.text, "This is a completed item") 33 | 34 | test_item.init_from_text(completed_whitespace) 35 | self.assertTrue(test_item.is_completed) 36 | self.assertEqual(test_item.text, "Also completed") 37 | 38 | test_item.init_from_text(not_completed) 39 | self.assertFalse(test_item.is_completed) 40 | self.assertEqual(test_item.text, "xNope, not even close") 41 | 42 | test_item.init_from_text(also_not_completed) 43 | self.assertFalse(test_item.is_completed) 44 | self.assertEqual(test_item.text, "Nope, not even close") 45 | 46 | def test_init_from_text_priority(self): 47 | item_with_priority = "(A) This item is pretty important" 48 | item_with_priority2 = "(Z) Not so important" 49 | no_priority = "Just some item" 50 | no_priority2 = "(b) Only caps should work here" 51 | 52 | test_item = TodoTxtItem() 53 | test_item.init_from_text(item_with_priority) 54 | self.assertEqual(test_item.priority, "A") 55 | self.assertEqual(test_item.text, "This item is pretty important") 56 | 57 | test_item.init_from_text(item_with_priority2) 58 | self.assertEqual(test_item.priority, "Z") 59 | self.assertEqual(test_item.text, "Not so important") 60 | 61 | test_item.init_from_text(no_priority) 62 | self.assertEqual(test_item.priority, None) 63 | self.assertEqual(test_item.text, "Just some item") 64 | 65 | test_item.init_from_text(no_priority2) 66 | self.assertEqual(test_item.priority, None) 67 | self.assertEqual(test_item.text, "(b) Only caps should work here") 68 | 69 | def test_init_from_text_completion_and_priority(self): 70 | item = "x (R) Good thing I completed this" 71 | 72 | test_item = TodoTxtItem() 73 | test_item.init_from_text(item) 74 | 75 | self.assertTrue(test_item.is_completed) 76 | self.assertEqual(test_item.priority, "R") 77 | self.assertEqual(test_item.text, "Good thing I completed this") 78 | 79 | def test_to_string(self): 80 | test_item = TodoTxtItem("This is some task", "F", True) 81 | self.assertEqual(str(test_item), "x (F) This is some task") 82 | 83 | test_item = TodoTxtItem("This is some task", None, False) 84 | self.assertEqual(str(test_item), "This is some task") 85 | 86 | def test_from_string_back_to_string(self): 87 | original_item = "x (Z) Here we go again" 88 | some_whitespace = "x (B) This one is pretty weird" 89 | 90 | test_item = TodoTxtItem() 91 | test_item.init_from_text(original_item) 92 | self.assertEqual(original_item, str(test_item)) 93 | 94 | test_item.init_from_text(some_whitespace) 95 | self.assertEqual("x (B) This one is pretty weird", str(test_item)) 96 | 97 | def test_equality_check(self): 98 | item1 = TodoTxtItem("An item", "A", False) 99 | item2 = TodoTxtItem("An item", "A", False) 100 | self.assertEqual(item1, item2) 101 | 102 | def test_sort_by_priority(self): 103 | item1 = TodoTxtItem("An item", "A", False) 104 | item2 = TodoTxtItem("An item", "Z", False) 105 | self.assertTrue(item2 > item1) 106 | self.assertTrue(item2 >= item2) 107 | 108 | def test_sort_by_text(self): 109 | item1 = TodoTxtItem("aaaaa", "A", False) 110 | item2 = TodoTxtItem("zzzzz", "A", False) 111 | self.assertTrue(item1 < item2) 112 | self.assertTrue(item1 <= item2) 113 | 114 | 115 | if __name__ == "__main__": 116 | unittest.main() 117 | -------------------------------------------------------------------------------- /todo_indicator/todotxt/test_list.py: -------------------------------------------------------------------------------- 1 | # Copyright 2012-2014, 2022 Keith Fancher 2 | # 3 | # This program is free software: you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or 6 | # (at your option) any later version. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | 17 | import tempfile 18 | import unittest 19 | 20 | from todo_indicator.todotxt.list import TodoTxtList 21 | 22 | 23 | class TestTodoTxtList(unittest.TestCase): 24 | def test_init_from_text(self): 25 | todo_text = "(A) Item one\n(Z) Item two\nx Item three\n\n \n" 26 | test_list = TodoTxtList(None, todo_text) 27 | 28 | self.assertEqual(3, test_list.num_items()) 29 | 30 | self.assertEqual("Item one", test_list.items[0].text) 31 | self.assertEqual("A", test_list.items[0].priority) 32 | self.assertFalse(test_list.items[0].is_completed) 33 | 34 | self.assertEqual("Item two", test_list.items[1].text) 35 | self.assertEqual("Z", test_list.items[1].priority) 36 | self.assertFalse(test_list.items[1].is_completed) 37 | 38 | self.assertEqual("Item three", test_list.items[2].text) 39 | self.assertEqual(None, test_list.items[2].priority) 40 | self.assertTrue(test_list.items[2].is_completed) 41 | 42 | def test_init_from_file(self): 43 | file_name = "sample-todo.txt" 44 | test_list = TodoTxtList(file_name) 45 | 46 | self.assertEqual(7, test_list.num_items()) 47 | 48 | self.assertEqual("Do that really important thing", test_list.items[0].text) 49 | self.assertEqual("A", test_list.items[0].priority) 50 | self.assertFalse(test_list.items[0].is_completed) 51 | 52 | self.assertEqual("Remember how Python works", test_list.items[1].text) 53 | self.assertEqual("D", test_list.items[1].priority) 54 | self.assertFalse(test_list.items[1].is_completed) 55 | 56 | self.assertEqual("This other important thing", test_list.items[2].text) 57 | self.assertEqual("A", test_list.items[2].priority) 58 | self.assertFalse(test_list.items[2].is_completed) 59 | 60 | self.assertEqual("Walk the cat", test_list.items[3].text) 61 | self.assertEqual("B", test_list.items[3].priority) 62 | self.assertFalse(test_list.items[3].is_completed) 63 | 64 | self.assertEqual("Something with no priority!", test_list.items[4].text) 65 | self.assertEqual(None, test_list.items[4].priority) 66 | self.assertFalse(test_list.items[4].is_completed) 67 | 68 | self.assertEqual("Cook the dog", test_list.items[5].text) 69 | self.assertEqual("C", test_list.items[5].priority) 70 | self.assertFalse(test_list.items[5].is_completed) 71 | 72 | self.assertEqual("Be annoyed at GTK3 docs", test_list.items[6].text) 73 | self.assertEqual(None, test_list.items[6].priority) 74 | self.assertTrue(test_list.items[6].is_completed) 75 | 76 | def test_reload_from_file(self): 77 | test_list = TodoTxtList() # Start with an empty list 78 | test_list.reload_from_file() # Should do nothing 79 | 80 | test_list.todo_filename = "sample-todo.txt" 81 | test_list.reload_from_file() 82 | 83 | self.assertEqual(7, test_list.num_items()) 84 | 85 | self.assertEqual("Do that really important thing", test_list.items[0].text) 86 | self.assertEqual("A", test_list.items[0].priority) 87 | self.assertFalse(test_list.items[0].is_completed) 88 | 89 | self.assertEqual("Remember how Python works", test_list.items[1].text) 90 | self.assertEqual("D", test_list.items[1].priority) 91 | self.assertFalse(test_list.items[1].is_completed) 92 | 93 | self.assertEqual("This other important thing", test_list.items[2].text) 94 | self.assertEqual("A", test_list.items[2].priority) 95 | self.assertFalse(test_list.items[2].is_completed) 96 | 97 | self.assertEqual("Walk the cat", test_list.items[3].text) 98 | self.assertEqual("B", test_list.items[3].priority) 99 | self.assertFalse(test_list.items[3].is_completed) 100 | 101 | self.assertEqual("Something with no priority!", test_list.items[4].text) 102 | self.assertEqual(None, test_list.items[4].priority) 103 | self.assertFalse(test_list.items[4].is_completed) 104 | 105 | self.assertEqual("Cook the dog", test_list.items[5].text) 106 | self.assertEqual("C", test_list.items[5].priority) 107 | self.assertFalse(test_list.items[5].is_completed) 108 | 109 | self.assertEqual("Be annoyed at GTK3 docs", test_list.items[6].text) 110 | self.assertEqual(None, test_list.items[6].priority) 111 | self.assertTrue(test_list.items[6].is_completed) 112 | 113 | def test_has_items(self): 114 | test_list = TodoTxtList() 115 | self.assertFalse(test_list.has_items()) 116 | 117 | test_list = TodoTxtList(None, "An item") 118 | self.assertTrue(test_list.has_items()) 119 | 120 | def test_remove_item(self): 121 | todo_text = "(A) Item one\n(Z) Item two\nx Item three\n\n \n" 122 | test_list = TodoTxtList(None, todo_text) 123 | 124 | self.assertEqual(3, test_list.num_items()) 125 | test_list.remove_item("Item two") 126 | self.assertEqual(2, test_list.num_items()) 127 | 128 | self.assertEqual("Item one", test_list.items[0].text) 129 | self.assertEqual("A", test_list.items[0].priority) 130 | self.assertFalse(test_list.items[0].is_completed) 131 | 132 | self.assertEqual("Item three", test_list.items[1].text) 133 | self.assertEqual(None, test_list.items[1].priority) 134 | self.assertTrue(test_list.items[1].is_completed) 135 | 136 | def test_remove_completed_items(self): 137 | todo_text = "(A) Item one\n(Z) Item two\nx Item three\n\n \n" 138 | test_list = TodoTxtList(None, todo_text) 139 | 140 | self.assertEqual(3, test_list.num_items()) 141 | test_list.remove_completed_items() 142 | self.assertEqual(2, test_list.num_items()) 143 | 144 | self.assertEqual("Item one", test_list.items[0].text) 145 | self.assertEqual("A", test_list.items[0].priority) 146 | self.assertFalse(test_list.items[0].is_completed) 147 | 148 | self.assertEqual("Item two", test_list.items[1].text) 149 | self.assertEqual("Z", test_list.items[1].priority) 150 | self.assertFalse(test_list.items[1].is_completed) 151 | 152 | def test_mark_item_completed(self): 153 | todo_text = "(A) Item one\n(Z) Item two\nx Item three\n\n \n" 154 | test_list = TodoTxtList(None, todo_text) 155 | 156 | test_list.mark_item_completed("Item two") 157 | 158 | self.assertEqual("Item one", test_list.items[0].text) 159 | self.assertEqual("A", test_list.items[0].priority) 160 | self.assertFalse(test_list.items[0].is_completed) 161 | 162 | self.assertEqual("Item two", test_list.items[1].text) 163 | self.assertEqual("Z", test_list.items[1].priority) 164 | self.assertTrue(test_list.items[1].is_completed) 165 | 166 | self.assertEqual("Item three", test_list.items[2].text) 167 | self.assertEqual(None, test_list.items[2].priority) 168 | self.assertTrue(test_list.items[2].is_completed) 169 | 170 | def test_mark_item_completed_with_full_text(self): 171 | todo_text = "(A) Item one\n(Z) Item two\nx Item three\n\n \n" 172 | test_list = TodoTxtList(None, todo_text) 173 | 174 | test_list.mark_item_completed_with_full_text("(Z) Item two") 175 | 176 | self.assertEqual("Item one", test_list.items[0].text) 177 | self.assertEqual("A", test_list.items[0].priority) 178 | self.assertFalse(test_list.items[0].is_completed) 179 | 180 | self.assertEqual("Item two", test_list.items[1].text) 181 | self.assertEqual("Z", test_list.items[1].priority) 182 | self.assertTrue(test_list.items[1].is_completed) 183 | 184 | self.assertEqual("Item three", test_list.items[2].text) 185 | self.assertEqual(None, test_list.items[2].priority) 186 | self.assertTrue(test_list.items[2].is_completed) 187 | 188 | def test_sort_list(self): 189 | todo_text = "x (C) No biggie\n(Z) aaaaa\nNothing\n(B) hey hey\n(Z) bbbbb\n(A) aaaaa\nx Item three\n\nx (B) Done it\n" 190 | test_list = TodoTxtList(None, todo_text) 191 | 192 | test_list.sort_list() 193 | 194 | self.assertEqual(8, test_list.num_items()) 195 | 196 | self.assertEqual("aaaaa", test_list.items[0].text) 197 | self.assertEqual("A", test_list.items[0].priority) 198 | self.assertFalse(test_list.items[0].is_completed) 199 | 200 | self.assertEqual("hey hey", test_list.items[1].text) 201 | self.assertEqual("B", test_list.items[1].priority) 202 | self.assertFalse(test_list.items[1].is_completed) 203 | 204 | self.assertEqual("aaaaa", test_list.items[2].text) 205 | self.assertEqual("Z", test_list.items[2].priority) 206 | self.assertFalse(test_list.items[2].is_completed) 207 | 208 | self.assertEqual("bbbbb", test_list.items[3].text) 209 | self.assertEqual("Z", test_list.items[3].priority) 210 | self.assertFalse(test_list.items[3].is_completed) 211 | 212 | self.assertEqual("Nothing", test_list.items[4].text) 213 | self.assertEqual(None, test_list.items[4].priority) 214 | self.assertFalse(test_list.items[4].is_completed) 215 | 216 | self.assertEqual("Done it", test_list.items[5].text) 217 | self.assertEqual("B", test_list.items[5].priority) 218 | self.assertTrue(test_list.items[5].is_completed) 219 | 220 | self.assertEqual("No biggie", test_list.items[6].text) 221 | self.assertEqual("C", test_list.items[6].priority) 222 | self.assertTrue(test_list.items[6].is_completed) 223 | 224 | self.assertEqual("Item three", test_list.items[7].text) 225 | self.assertEqual(None, test_list.items[7].priority) 226 | self.assertTrue(test_list.items[7].is_completed) 227 | 228 | def test_to_text(self): 229 | test_list = TodoTxtList() 230 | 231 | # Empty list yields empty string: 232 | self.assertEqual("", str(test_list)) 233 | 234 | todo_text = "(A) Do one thing\n (B) Do another thing\n x One last thing" 235 | expected_output = "(A) Do one thing\n(B) Do another thing\nx One last thing" 236 | test_list.init_from_text(todo_text) 237 | self.assertEqual(expected_output, str(test_list)) 238 | 239 | def test_write_to_file(self): 240 | todo_text = "(A) Do one thing\n (B) Do another thing\n x One last thing" 241 | expected_output = "(A) Do one thing\n(B) Do another thing\nx One last thing" 242 | test_list = TodoTxtList(None, todo_text) 243 | 244 | # Write to a temporary output file: 245 | output_file = tempfile.NamedTemporaryFile(mode="w+") 246 | test_list.todo_filename = output_file.name 247 | test_list.write_to_file() 248 | 249 | # Now read the file in and see that it all matches up: 250 | self.assertEqual(expected_output, output_file.read()) 251 | 252 | 253 | if __name__ == "__main__": 254 | unittest.main() 255 | --------------------------------------------------------------------------------