├── .github └── workflows │ └── test.yml ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── Makefile ├── Pipfile ├── Pipfile.lock ├── README.md ├── billwarrior ├── __init__.py ├── config.py └── invoice.py ├── bin └── billwarrior ├── etc ├── billwarrior.ini └── latex │ ├── .gitignore │ ├── billwarrior_items.tex │ ├── invoice.cls │ └── invoice.tex ├── requirements.txt ├── setup.py └── tests ├── __init__.py ├── test_billwarrior.py ├── test_config.py ├── test_invoice.py └── testsupport.py /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: 4 | push: 5 | branches: 6 | - "master" 7 | pull_request: 8 | branches: 9 | - "master" 10 | 11 | jobs: 12 | tests: 13 | name: "Python ${{ matrix.python-version }}" 14 | runs-on: ubuntu-latest 15 | strategy: 16 | matrix: 17 | python-version: 18 | - "3.6" 19 | 20 | steps: 21 | - uses: "actions/checkout@v2" 22 | - uses: "actions/setup-python@v2" 23 | with: 24 | python-version: "${{ matrix.python-version }}" 25 | 26 | - name: "Run tests" 27 | run: | 28 | python -m pip install pipenv 29 | pipenv --python python3.6 install --dev 30 | pipenv run pytest tests 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/python 3 | 4 | ### Python ### 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 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .coverage 46 | .coverage.* 47 | .cache 48 | nosetests.xml 49 | coverage.xml 50 | *.cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | 63 | # Flask stuff: 64 | instance/ 65 | .webassets-cache 66 | 67 | # Scrapy stuff: 68 | .scrapy 69 | 70 | # Sphinx documentation 71 | docs/_build/ 72 | 73 | # PyBuilder 74 | target/ 75 | 76 | # Jupyter Notebook 77 | .ipynb_checkpoints 78 | 79 | # pyenv 80 | .python-version 81 | 82 | # celery beat schedule file 83 | celerybeat-schedule 84 | 85 | # SageMath parsed files 86 | *.sage.py 87 | 88 | # Environments 89 | .env 90 | .venv 91 | env/ 92 | venv/ 93 | ENV/ 94 | env.bak/ 95 | venv.bak/ 96 | 97 | # Spyder project settings 98 | .spyderproject 99 | .spyproject 100 | 101 | # Rope project settings 102 | .ropeproject 103 | 104 | # mkdocs documentation 105 | /site 106 | 107 | # mypy 108 | .mypy_cache/ 109 | 110 | ### Python Patch ### 111 | .venv/ 112 | 113 | ### Python.VirtualEnv Stack ### 114 | # Virtualenv 115 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 116 | [Bb]in 117 | [Ii]nclude 118 | [Ll]ib 119 | [Ll]ib64 120 | [Ll]ocal 121 | [Ss]cripts 122 | pyvenv.cfg 123 | pip-selfcheck.json 124 | 125 | 126 | # End of https://www.gitignore.io/api/python 127 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | init: 2 | pipenv install --dev 3 | 4 | test: 5 | pipenv run py.test tests 6 | 7 | .PHONY: 8 | init test 9 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | timew-report = "<1.3" 8 | 9 | [dev-packages] 10 | pytest = "*" 11 | 12 | [requires] 13 | python_version = "3.6" 14 | -------------------------------------------------------------------------------- /Pipfile.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_meta": { 3 | "hash": { 4 | "sha256": "9041881b029e904d14ec563c5cdde0731eb0ffbc0f28bf37dc5ff30dd22e3556" 5 | }, 6 | "pipfile-spec": 6, 7 | "requires": { 8 | "python_version": "3.6" 9 | }, 10 | "sources": [ 11 | { 12 | "name": "pypi", 13 | "url": "https://pypi.org/simple", 14 | "verify_ssl": true 15 | } 16 | ] 17 | }, 18 | "default": { 19 | "python-dateutil": { 20 | "hashes": [ 21 | "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86", 22 | "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9" 23 | ], 24 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 25 | "version": "==2.8.2" 26 | }, 27 | "six": { 28 | "hashes": [ 29 | "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926", 30 | "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254" 31 | ], 32 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 33 | "version": "==1.16.0" 34 | }, 35 | "timew-report": { 36 | "hashes": [ 37 | "sha256:cc3d07f8dcc7862c7d4759f61a3cbd2ccafbc22de9724fb9702edb6eb0e624fd" 38 | ], 39 | "index": "pypi", 40 | "version": "==1.0.2" 41 | } 42 | }, 43 | "develop": { 44 | "attrs": { 45 | "hashes": [ 46 | "sha256:149e90d6d8ac20db7a955ad60cf0e6881a3f20d37096140088356da6c716b0b1", 47 | "sha256:ef6aaac3ca6cd92904cdd0d83f629a15f18053ec84e6432106f7a4d04ae4f5fb" 48 | ], 49 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", 50 | "version": "==21.2.0" 51 | }, 52 | "importlib-metadata": { 53 | "hashes": [ 54 | "sha256:b618b6d2d5ffa2f16add5697cf57a46c76a56229b0ed1c438322e4e95645bd15", 55 | "sha256:f284b3e11256ad1e5d03ab86bb2ccd6f5339688ff17a4d797a0fe7df326f23b1" 56 | ], 57 | "markers": "python_version < '3.8'", 58 | "version": "==4.8.1" 59 | }, 60 | "iniconfig": { 61 | "hashes": [ 62 | "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3", 63 | "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32" 64 | ], 65 | "version": "==1.1.1" 66 | }, 67 | "packaging": { 68 | "hashes": [ 69 | "sha256:7dc96269f53a4ccec5c0670940a4281106dd0bb343f47b7471f779df49c2fbe7", 70 | "sha256:c86254f9220d55e31cc94d69bade760f0847da8000def4dfe1c6b872fd14ff14" 71 | ], 72 | "markers": "python_version >= '3.6'", 73 | "version": "==21.0" 74 | }, 75 | "pluggy": { 76 | "hashes": [ 77 | "sha256:4224373bacce55f955a878bf9cfa763c1e360858e330072059e10bad68531159", 78 | "sha256:74134bbf457f031a36d68416e1509f34bd5ccc019f0bcc952c7b909d06b37bd3" 79 | ], 80 | "markers": "python_version >= '3.6'", 81 | "version": "==1.0.0" 82 | }, 83 | "py": { 84 | "hashes": [ 85 | "sha256:21b81bda15b66ef5e1a777a21c4dcd9c20ad3efd0b3f817e7a809035269e1bd3", 86 | "sha256:3b80836aa6d1feeaa108e046da6423ab8f6ceda6468545ae8d02d9d58d18818a" 87 | ], 88 | "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", 89 | "version": "==1.10.0" 90 | }, 91 | "pyparsing": { 92 | "hashes": [ 93 | "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1", 94 | "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b" 95 | ], 96 | "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", 97 | "version": "==2.4.7" 98 | }, 99 | "pytest": { 100 | "hashes": [ 101 | "sha256:131b36680866a76e6781d13f101efb86cf674ebb9762eb70d3082b6f29889e89", 102 | "sha256:7310f8d27bc79ced999e760ca304d69f6ba6c6649c0b60fb0e04a4a77cacc134" 103 | ], 104 | "index": "pypi", 105 | "version": "==6.2.5" 106 | }, 107 | "toml": { 108 | "hashes": [ 109 | "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", 110 | "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f" 111 | ], 112 | "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", 113 | "version": "==0.10.2" 114 | }, 115 | "typing-extensions": { 116 | "hashes": [ 117 | "sha256:49f75d16ff11f1cd258e1b988ccff82a3ca5570217d7ad8c5f48205dd99a677e", 118 | "sha256:d8226d10bc02a29bcc81df19a26e56a9647f8b0a6d4a83924139f4a8b01f17b7", 119 | "sha256:f1d25edafde516b146ecd0613dabcc61409817af4766fbbcfb8d1ad4ec441a34" 120 | ], 121 | "markers": "python_version < '3.8'", 122 | "version": "==3.10.0.2" 123 | }, 124 | "zipp": { 125 | "hashes": [ 126 | "sha256:957cfda87797e389580cb8b9e3870841ca991e2125350677b2ca83a0e99390a3", 127 | "sha256:f5812b1e007e48cff63449a5e9f4e7ebea716b4111f9c4f9a645f91d579bf0c4" 128 | ], 129 | "markers": "python_version >= '3.6'", 130 | "version": "==3.5.0" 131 | } 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Billwarrior 2 | ============ 3 | An extension for the venerable CLI timetracker, 4 | [Timewarrior](https://timewarrior.net/). Use Billwarrior to generate invoices in LaTeX 5 | from your Timewarrior reports. 6 | 7 | Trey Hunner's basic [Invoice](https://www.latextemplates.com/template/invoice) LaTeX template 8 | (CC BY-NC-SA 3.0) is included in the `etc/latex/` directory. 9 | 10 | Installation 11 | ------------- 12 | By cloning the repository: 13 | 14 | ```shell 15 | git clone http://github.com/sw00/billwarrior.git 16 | cd billwarrior 17 | python setup.py install 18 | ``` 19 | 20 | `setup.py` will create a directory `$HOME/.config/billwarrior/` and copy `billwarrior.ini` 21 | as well as LaTeX files there. 22 | 23 | 24 | Usage 25 | ------ 26 | 27 | Edit `$HOME/.config/billwarrior/billwarrior.ini` to add the categories of invoice items you'd 28 | like to generate invoices for. For example: 29 | 30 | ```ini 31 | [categories] 32 | dev.tags = coding, dev, pairing 33 | dev.text = Software Development Services 34 | dev.rate = 44.85 35 | 36 | consulting.tags = meeting, workshop, ceremony 37 | consulting.text = Consulting Services 38 | consulting.rate = 85.50 39 | 40 | nonbillable.tags = pingpong, travel, lunch 41 | nonbillable.text = Nonbillable Time 42 | nonbillable.rate = 0.0 43 | 44 | invisible.tags = invisible 45 | invisible.rate = -1 46 | ``` 47 | 48 | 1. Copy the `bin/billwarrior` script into your Timewarrior extensions directory and ensure 49 | that it's 50 | it executable 51 | 52 | 2. Run a report and pipe output to the `billwarrior_items.tex` file that's imported by 53 | `invoice.tex` 54 | 55 | 3. Run `pdflatex`(or `xelatex`, whatever your preference) against `invoice.tex` 56 | 57 | ```shell 58 | cp bin/billwarrior $TIMEWARRIORDB/extensions/billwarrior 59 | chmod +x $TIMEWARRIORDB/extensions/billwarrior 60 | timew report billwarrior > ~/.config/billwarrior/latex/billwarrior_items.tex 61 | cd ~/.config/billwarrior/latex && pdflatex invoice.tex 62 | ``` 63 | 64 | Additional Notes 65 | ---------------- 66 | * It's up to you to customise the LaTeX template (`invoice.tex` and `invoice.cls`). 67 | 68 | * Billwarrior is strict. It won't run if it encounters a time interval with tags that 69 | isn't configured to map to a category in `billwarrior.ini`. So make sure you give 70 | `timew` the appropriate filters. 71 | 72 | TODO/Issues 73 | ----- 74 | 75 | - [ ] Automated build (GH Actions). 76 | 77 | - [ ] Make line items' LaTeX output configurable. 78 | 79 | - [ ] Smarter `setup.py install` to detect Timewarrior extensions path and install itself. 80 | 81 | - [ ] Upload/distribute to the cheese shop and support installation via `pip install` 82 | -------------------------------------------------------------------------------- /billwarrior/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sw00/billwarrior/985cc55aac2bb8efc22a1411cff7894eea30ab5e/billwarrior/__init__.py -------------------------------------------------------------------------------- /billwarrior/config.py: -------------------------------------------------------------------------------- 1 | import configparser 2 | import os 3 | 4 | INI_FILE_PATH = os.path.join( 5 | os.getenv("HOME"), ".config", "billwarrior", "billwarrior.ini" 6 | ) 7 | 8 | 9 | class BillWarriorConfig(object): 10 | def __init__(self): 11 | parser = configparser.ConfigParser() 12 | 13 | with open(INI_FILE_PATH, "r") as f: 14 | parser.read_string(f.read()) 15 | 16 | self.categories_section = parser["categories"] 17 | self.__categories = set( 18 | [option.split(".")[0] for option in parser.options("categories")] 19 | ) 20 | 21 | @property 22 | def categories(self): 23 | return self.__categories 24 | 25 | def text_for(self, category_name): 26 | return self.categories_section.get("{}.text".format(category_name)) 27 | 28 | def rate_for(self, category_name): 29 | return self.categories_section.getfloat("{}.rate".format(category_name)) 30 | 31 | def category_of(self, tag_name): 32 | for category in self.__categories: 33 | category_tags = self.categories_section.get("{}.tags".format(category)) 34 | tags = [t.replace(",", "").strip() for t in category_tags.split(",")] 35 | if tag_name in tags: 36 | return category 37 | -------------------------------------------------------------------------------- /billwarrior/invoice.py: -------------------------------------------------------------------------------- 1 | from datetime import timedelta 2 | 3 | from timewreport.interval import TimeWarriorInterval 4 | 5 | 6 | class Invoice(object): 7 | def __init__(self, intervals, config): 8 | self.config = config 9 | self.__items = [] 10 | 11 | sorted_intervals = self._sort_by_category(intervals) 12 | 13 | for category in sorted(sorted_intervals.keys(), key=config.text_for): 14 | intervals = sorted_intervals[category] 15 | days = set([interval.get_date().date() for interval in intervals]) 16 | intervals_by_day = { 17 | day: [i for i in intervals if i.get_date().date() == day] 18 | for day in days 19 | } 20 | 21 | self.__items.append( 22 | ItemCategory(config.text_for(category), intervals_by_day, config.rate_for(category)) 23 | ) 24 | 25 | def _sort_by_category(self, list_of_intervals): 26 | tags = set( 27 | [tag for interval in list_of_intervals for tag in interval.get_tags()] 28 | ) 29 | tag_mapping = {t: self.config.category_of(t) for t in tags} 30 | all_categories = set([c for c in tag_mapping.values()]) 31 | 32 | interval_categories = { 33 | IntervalContainer(i): set( 34 | [tag_mapping[t] for t in i.get_tags() if tag_mapping.get(t, None)] 35 | ) 36 | for i in list_of_intervals 37 | } 38 | 39 | no_category_list = [i for i, c in interval_categories.items() if len(c) == 0] 40 | ambiguous_list = [i for i, c in interval_categories.items() if len(c) > 1] 41 | 42 | if len(no_category_list) > 0: 43 | raise ValueError( 44 | "These intervals with the following tags don't belong to any category: {}".format( 45 | [i.get_tags() for i in no_category_list] 46 | ) 47 | ) 48 | 49 | if len(ambiguous_list) > 0: 50 | raise ValueError( 51 | "Intervals with the following tags belongs to more than one category: {}".format( 52 | [i.get_tags() for i in ambiguous_list] 53 | ) 54 | ) 55 | 56 | return { 57 | c: [i for i in list_of_intervals if c in interval_categories[i]] 58 | for c in all_categories 59 | if c 60 | } 61 | 62 | def items(self): 63 | return self.__items 64 | 65 | def __str__(self): 66 | return "\n".join([str(item) for item in self.__items]) 67 | 68 | 69 | class IntervalContainer(TimeWarriorInterval): 70 | def __new__(cls, interval): 71 | interval.__class__ = cls 72 | return interval 73 | 74 | def __init__(self, interval): 75 | pass 76 | 77 | def __hash__(self): 78 | return hash(repr(self)) 79 | 80 | 81 | class ItemCategory(object): 82 | def __init__(self, tag_name, intervals_by_day, unit_price): 83 | self.unit_price = unit_price 84 | self.header = ( 85 | " ".join([x for x in tag_name.split() if not x == ""]).strip().capitalize() 86 | ) 87 | self.line_items = [] 88 | 89 | if unit_price < 0: 90 | return 91 | 92 | for day, intervals in sorted(intervals_by_day.items(), key=lambda x: x[0]): 93 | self.line_items.append( 94 | LineItem( 95 | day, 96 | sum( 97 | [interval.get_duration() for interval in intervals], timedelta() 98 | ), 99 | unit_price, 100 | ) 101 | ) 102 | 103 | def __str__(self): 104 | if self.unit_price < 0: 105 | return "" 106 | return "".join( 107 | [ 108 | "\\feetype{%s}\n" % self.header, 109 | "".join(["%s\n" % item for item in self.line_items]), 110 | "\\subtotal\n", 111 | "%------------------------------------------------", 112 | ] 113 | ) 114 | 115 | 116 | class LineItem(object): 117 | def __init__(self, day, duration, unit_price): 118 | self.__day = day 119 | self.__duration = duration 120 | self.__unit_price = unit_price 121 | 122 | @property 123 | def date(self): 124 | return self.__day.strftime("%B %d, %Y") 125 | 126 | @property 127 | def duration(self): 128 | totsec = self.__duration.total_seconds() 129 | hours = totsec / 3600.0 130 | 131 | return "{:.2f}".format(hours) 132 | 133 | @property 134 | def unit_price(self): 135 | return "{:.2f}".format(self.__unit_price) 136 | 137 | def __str__(self): 138 | return "\\hourrow{%s}{%s}{%s}" % (self.date, self.duration, self.unit_price) 139 | -------------------------------------------------------------------------------- /bin/billwarrior: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import sys 3 | from billwarrior.invoice import Invoice 4 | from billwarrior.config import BillWarriorConfig 5 | from timewreport.parser import TimeWarriorParser 6 | 7 | parser = TimeWarriorParser(sys.stdin) 8 | invoice = Invoice(parser.get_intervals(), BillWarriorConfig()) 9 | 10 | print(invoice) 11 | -------------------------------------------------------------------------------- /etc/billwarrior.ini: -------------------------------------------------------------------------------- 1 | # Billwarrior config file 2 | 3 | [categories] 4 | # .text = Software Engineering (text displayed on invoice) 5 | # .tags = projectX, hydra corp, coding (comma-separated list of tags) 6 | # .rate = 22.19 (hourly rate) 7 | 8 | -------------------------------------------------------------------------------- /etc/latex/.gitignore: -------------------------------------------------------------------------------- 1 | *.log 2 | *.aux 3 | *.pdf 4 | -------------------------------------------------------------------------------- /etc/latex/billwarrior_items.tex: -------------------------------------------------------------------------------- 1 | \feetype{Miscellaneous} 2 | \hourrow{May 04, 2018}{4.11}{0.00} 3 | \hourrow{May 07, 2018}{3.23}{0.00} 4 | \hourrow{May 14, 2018}{0.59}{0.00} 5 | \hourrow{May 22, 2018}{1.10}{0.00} 6 | \hourrow{May 28, 2018}{2.82}{0.00} 7 | \hourrow{May 31, 2018}{3.58}{0.00} 8 | \hourrow{June 04, 2018}{1.55}{0.00} 9 | \hourrow{June 05, 2018}{2.34}{0.00} 10 | \subtotal 11 | %------------------------------------------------ 12 | \feetype{Software development} 13 | \hourrow{May 07, 2018}{3.57}{22.24} 14 | \hourrow{May 08, 2018}{6.72}{22.24} 15 | \hourrow{May 09, 2018}{7.12}{22.24} 16 | \hourrow{May 10, 2018}{8.61}{22.24} 17 | \hourrow{May 11, 2018}{7.90}{22.24} 18 | \hourrow{May 12, 2018}{1.37}{22.24} 19 | \hourrow{May 13, 2018}{2.07}{22.24} 20 | \hourrow{May 14, 2018}{5.67}{22.24} 21 | \hourrow{May 15, 2018}{5.37}{22.24} 22 | \hourrow{May 16, 2018}{5.96}{22.24} 23 | \hourrow{May 17, 2018}{5.83}{22.24} 24 | \hourrow{May 18, 2018}{5.19}{22.24} 25 | \hourrow{May 19, 2018}{3.19}{22.24} 26 | \hourrow{May 20, 2018}{5.54}{22.24} 27 | \hourrow{May 21, 2018}{7.02}{22.24} 28 | \hourrow{May 22, 2018}{6.03}{22.24} 29 | \hourrow{May 23, 2018}{2.05}{22.24} 30 | \hourrow{May 25, 2018}{8.17}{22.24} 31 | \hourrow{May 28, 2018}{5.07}{22.24} 32 | \hourrow{May 30, 2018}{5.30}{22.24} 33 | \hourrow{May 31, 2018}{2.64}{22.24} 34 | \hourrow{June 01, 2018}{2.67}{22.24} 35 | \hourrow{June 04, 2018}{3.83}{22.24} 36 | \hourrow{June 05, 2018}{4.49}{22.24} 37 | \subtotal 38 | %------------------------------------------------ 39 | -------------------------------------------------------------------------------- /etc/latex/invoice.cls: -------------------------------------------------------------------------------- 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2 | % Copyright (c) 2011 Trey Hunner % 3 | % % 4 | % Permission is hereby granted, free of charge, to any person obtaining % 5 | % a copy of this software and associated documentation files (the % 6 | % "Software"), to deal in the Software without restriction, including % 7 | % without limitation the rights to use, copy, modify, merge, publish, % 8 | % distribute, sublicense, and/or sell copies of the Software, and to % 9 | % permit persons to whom the Software is furnished to do so, subject to % 10 | % the following conditions: % 11 | % % 12 | % The above copyright notice and this permission notice shall be % 13 | % included in all copies or substantial portions of the Software. % 14 | % % 15 | % THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, % 16 | % EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF % 17 | % MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND % 18 | % NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE % 19 | % LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION % 20 | % OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION % 21 | % WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. % 22 | % % 23 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 24 | 25 | \ProvidesClass{invoice} 26 | 27 | \LoadClass[12pt]{article} 28 | 29 | \usepackage[letterpaper,hmargin=0.79in,vmargin=0.79in]{geometry} 30 | \usepackage[parfill]{parskip} % Do not indent paragraphs 31 | \usepackage{fp} % Fixed-point arithmetic 32 | \usepackage{calc} % Counters for totaling hours and cost 33 | \usepackage{longtable} 34 | 35 | \pagestyle{empty} % No page numbers 36 | \linespread{1.5} % Line spacing 37 | 38 | \setlength{\doublerulesep}{\arrayrulewidth} % Double rules look like one thick one 39 | 40 | % Command for setting a default hourly rate 41 | \newcommand{\feetype}[1]{ 42 | \textbf{#1} 43 | \\ 44 | } 45 | 46 | % Counters for totaling up hours and dollars 47 | \newcounter{hours} \newcounter{subhours} \newcounter{cost} \newcounter{subcost} 48 | \setcounter{hours}{0} \setcounter{subhours}{0} \setcounter{cost}{0} \setcounter{subcost}{0} 49 | 50 | % Formats inputed number with 2 digits after the decimal place 51 | \newcommand*{\formatNumber}[1]{\FPround{\cost}{#1}{2}\cost} % 52 | 53 | % Returns the total of counter 54 | \newcommand*{\total}[1]{\FPdiv{\t}{\arabic{#1}}{1000}\formatNumber{\t}} 55 | 56 | % Create an invoice table 57 | \newenvironment{invoiceTable}{ 58 | % Create a new row from title, unit quantity, unit rate, and unit name 59 | \newcommand*{\unitrow}[4]{% 60 | \addtocounter{cost}{1000 * \real{##2} * \real{##3}}% 61 | \addtocounter{subcost}{1000 * \real{##2} * \real{##3}}% 62 | ##1 & \formatNumber{##2} ##4 & \$\formatNumber{##3} & \$\FPmul{\cost}{##2}{##3}\formatNumber{\cost}% 63 | \\ 64 | } 65 | % Create a new row from title and expense amount 66 | \newcommand*{\feerow}[2]{% 67 | \addtocounter{cost}{1000 * \real{##2}}% 68 | \addtocounter{subcost}{1000 * \real{##2}}% 69 | ##1 & & \$\formatNumber{##2} & \$\FPmul{\cost}{##2}{1}\formatNumber{\cost}% 70 | \\ 71 | } 72 | 73 | \newcommand{\subtotalNoStar}{ 74 | {\bf Subtotal} & {\bf \total{subhours} hours} & & {\bf \$\total{subcost}} 75 | \setcounter{subcost}{0} 76 | \setcounter{subhours}{0} 77 | \\*[1.5ex] 78 | } 79 | \newcommand{\subtotalStar}{ 80 | {\bf Subtotal} & & & {\bf \$\total{subcost}} 81 | \setcounter{subcost}{0} 82 | \\*[1.5ex] 83 | } 84 | \newcommand{\subtotal}{ 85 | \hline 86 | \@ifstar 87 | \subtotalStar% 88 | \subtotalNoStar% 89 | } 90 | 91 | % Create a new row from date and hours worked (use stored fee type and hourly rate) 92 | \newcommand*{\hourrow}[3]{% 93 | \addtocounter{hours}{1000 * \real{##2}}% 94 | \addtocounter{subhours}{1000 * \real{##2}}% 95 | \unitrow{##1}{##2}{##3}{hours}% 96 | } 97 | \renewcommand{\tabcolsep}{0.8ex} 98 | \setlength\LTleft{0pt} 99 | \setlength\LTright{0pt} 100 | \begin{longtable}{@{\extracolsep{\fill}\hspace{\tabcolsep}} l r r r } 101 | \hline 102 | {\bf Description of Services} & \multicolumn{1}{c}{\bf Quantity} & \multicolumn{1}{c}{\bf Unit Price} & \multicolumn{1}{c}{\bf Amount} \\* 103 | \hline\hline 104 | \endhead 105 | }{ 106 | \hline\hline\hline 107 | {\bf Balance Due} & & & {\bf \$\total{cost}} \\ 108 | \end{longtable} 109 | } 110 | -------------------------------------------------------------------------------- /etc/latex/invoice.tex: -------------------------------------------------------------------------------- 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2 | % Invoice Template 3 | % LaTeX Template 4 | % Version 1.0 (3/11/12) 5 | % 6 | % This template has been downloaded from: 7 | % http://www.LaTeXTemplates.com 8 | % 9 | % Original author: 10 | % Trey Hunner (http://www.treyhunner.com/) 11 | % 12 | % License: 13 | % CC BY-NC-SA 3.0 (http://creativecommons.org/licenses/by-nc-sa/3.0/) 14 | % 15 | % Important note: 16 | % This template requires the invoice.cls file to be in the same directory as 17 | % the .tex file. The invoice.cls file provides the style used for structuring the 18 | % document. 19 | % 20 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 21 | 22 | %---------------------------------------------------------------------------------------- 23 | % DOCUMENT CONFIGURATION 24 | %---------------------------------------------------------------------------------------- 25 | 26 | \documentclass{invoice} % Use the custom invoice class (invoice.cls) 27 | 28 | \def \tab {\hspace*{3ex}} % Define \tab to create some horizontal white space 29 | 30 | \begin{document} 31 | 32 | %---------------------------------------------------------------------------------------- 33 | % HEADING SECTION 34 | %---------------------------------------------------------------------------------------- 35 | 36 | \hfil{\Huge\bf Initech Inc.}\hfil % Company providing the invoice 37 | \bigskip\break % Whitespace 38 | \hrule % Horizontal line 39 | 40 | 123 Broadway \hfill (000) 111-1111 \\ % Your address and contact information 41 | City, State 12345 \hfill john@smith.com 42 | \\ \\ 43 | {\bf Invoice To:} \\ 44 | \tab James Smith \\ % Invoice recipient 45 | \tab Generic Corporation \\ % Recipient's company 46 | 47 | {\bf Date:} \\ 48 | \tab \today \\ % Invoice date 49 | 50 | %---------------------------------------------------------------------------------------- 51 | % TABLE OF EXPENSES 52 | %---------------------------------------------------------------------------------------- 53 | 54 | \begin{invoiceTable} 55 | \input{billwarrior_items} 56 | \end{invoiceTable} 57 | 58 | %---------------------------------------------------------------------------------------- 59 | 60 | \end{document} 61 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | python-dateutil==2.7.3 2 | six==1.11.0 3 | timew-report==1.0.2 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from setuptools import setup 4 | 5 | CONFIG_DIR = os.path.join(os.getenv("HOME"), ".config", "billwarrior") 6 | print("CONFIG_DIR: %s" % CONFIG_DIR) 7 | 8 | 9 | def readme(): 10 | with open("README.md", "r") as f: 11 | return f.read() 12 | 13 | 14 | setup( 15 | name="billwarrior", 16 | version="0.1.1", 17 | description="A Timewarrior report extension for creating invoices in LaTeX.", 18 | long_description=readme(), 19 | classifiers=[ 20 | "Development Status :: 2 - Pre-Alpha", 21 | "Environment :: Console", 22 | "Intended Audience :: End Users/Desktop", 23 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 24 | "Programming Language :: Python :: 3.6", 25 | "Topic :: Office/Business :: Financial", 26 | ], 27 | keywords="timewarrior timesheet invoice freelance contract report", 28 | url="http://github.com/sw00/billwarrior", 29 | author="Sett Wai", 30 | author_email="exec@sett.sh", 31 | license="GPLv3", 32 | packages=["billwarrior"], 33 | install_requires=["timew-report==1.0.2"], 34 | scripts=["bin/billwarrior"], 35 | data_files=[ 36 | (CONFIG_DIR, ["etc/billwarrior.ini"]), 37 | (os.path.join(CONFIG_DIR, "latex"), ["etc/latex/invoice.cls", "etc/latex/invoice.tex"]), 38 | ], 39 | zip_safe=False, 40 | ) 41 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sw00/billwarrior/985cc55aac2bb8efc22a1411cff7894eea30ab5e/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_billwarrior.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | import unittest 4 | from unittest import mock 5 | from io import StringIO 6 | 7 | 8 | from timewreport.parser import TimeWarriorParser 9 | 10 | from billwarrior.config import BillWarriorConfig 11 | from billwarrior.invoice import Invoice 12 | 13 | INI_FILE = """ 14 | [categories] 15 | billable.tags = coding, research, meeting 16 | billable.text = Software Engineering & Consulting 17 | billable.rate = 43.50 18 | 19 | expensed.tags = travel, flight, train 20 | expensed.text = Discounted time & expenses 21 | expensed.rate = 21.75 22 | 23 | nonbillable.tags = pingpong, lunch 24 | nonbillable.text = Miscelaneous activities 25 | nonbillable.rate = 0.0 26 | """ 27 | 28 | TIMEW_REPORT = """ 29 | [ 30 | {"start":"20180601T075048Z","end":"20180601T083639Z","tags":["travel","train"]}, 31 | {"start":"20180601T090520Z","end":"20180601T103037Z","tags":["meeting","client-side"]}, 32 | {"start":"20180601T123440Z","end":"20180601T144223Z","tags":["lunch"]}, 33 | {"start":"20180602T072333Z","end":"20180602T111036Z","tags":["coding","off-site"]}, 34 | {"start":"20180603T083437Z","end":"20180603T121520Z","tags":["coding","off-site"]}, 35 | {"start":"20180604T071523Z","end":"20180604T150143Z","tags":["travel","flight"]}, 36 | {"start":"20180605T071238Z","end":"20180605T102833Z","tags":["pingpong","lunch"]}, 37 | {"start":"20180606T083017Z","end":"20180606T123452Z","tags":["coding","on-site"]} 38 | ] 39 | """ 40 | 41 | EXPECTED_OUTPUT = """ 42 | \feetype{Billable} 43 | \hourrow{June 01, 2018}{1.42}{43.50} 44 | \hourrow{June 02, 2018}{3.78}{43.50} 45 | \hourrow{June 03, 2018}{3.67}{43.50} 46 | \hourrow{June 06, 2018}{4.07}{43.50} 47 | \subtotal 48 | %------------------------------------------------ 49 | \feetype{Expensed} 50 | \hourrow{June 01, 2018}{0.76}{21.75} 51 | \hourrow{June 04, 2018}{7.77}{21.75} 52 | \subtotal 53 | %------------------------------------------------ 54 | \feetype{Nonbillable} 55 | \hourrow{June 01, 2018}{2.12}{0.00} 56 | \hourrow{June 05, 2018}{3.26}{0.00} 57 | \subtotal 58 | %------------------------------------------------ 59 | """ 60 | 61 | 62 | class BillWarriorTest(unittest.TestCase): 63 | @unittest.skip 64 | def test_happy_path(self): 65 | with mock.patch("builtins.open", mock.mock_open(read_data=INI_FILE)): 66 | config = BillWarriorConfig() 67 | 68 | timewparser = TimeWarriorParser(StringIO(TIMEW_REPORT)) 69 | 70 | invoice = Invoice(timewparser.get_intervals(), config) 71 | 72 | self.assertEqual(str(invoice), EXPECTED_OUTPUT) 73 | -------------------------------------------------------------------------------- /tests/test_config.py: -------------------------------------------------------------------------------- 1 | import os 2 | import unittest 3 | from unittest.mock import mock_open, patch 4 | 5 | from billwarrior.config import BillWarriorConfig 6 | 7 | 8 | class BillWarriorConfigTest(unittest.TestCase): 9 | def setUp(self): 10 | self.raw_file_data = ( 11 | "[categories]" 12 | "\nbillable.tags = coding, research, meeting" 13 | "\nbillable.text = Software Engineering & Consulting" 14 | "\nbillable.rate = 43.50" 15 | "\nexpensed.tags = travel, flight, train" 16 | "\nexpensed.text = Discounted Travel Time" 17 | "\nexpensed.rate = 21.75" 18 | "\nnonbillable.tags = pingpong, lunch" 19 | "\nnonbillable.text = Miscellaneous activities" 20 | "\nnonbillable.rate = 0.0" 21 | ) 22 | 23 | def test_categories_should_parse_list_of_categories_from_ini_file(self): 24 | file_path = os.path.join( 25 | os.getenv("HOME"), ".config", "billwarrior", "billwarrior.ini" 26 | ) 27 | expected_categories = ["billable", "expensed", "nonbillable"] 28 | 29 | with patch( 30 | "builtins.open", mock_open(read_data=self.raw_file_data) 31 | ) as mocked_open: 32 | config = BillWarriorConfig() 33 | 34 | mocked_open.assert_called_once_with(file_path, "r") 35 | self.assertCountEqual(expected_categories, config.categories) 36 | 37 | def test_text_should_return_configured_text_for_category(self): 38 | with patch( 39 | "builtins.open", mock_open(read_data=self.raw_file_data) 40 | ) as mocked_open: 41 | config = BillWarriorConfig() 42 | 43 | expected = { 44 | "billable": "Software Engineering & Consulting", 45 | "expensed": "Discounted Travel Time", 46 | "nonbillable": "Miscellaneous activities", 47 | } 48 | 49 | for category_name, category_text in expected.items(): 50 | self.assertEqual(config.text_for(category_name), category_text) 51 | 52 | def test_rate_should_return_configured_rate_for_category(self): 53 | with patch( 54 | "builtins.open", mock_open(read_data=self.raw_file_data) 55 | ) as mocked_open: 56 | config = BillWarriorConfig() 57 | 58 | expected = {"billable": 43.50, "expensed": 21.75, "nonbillable": 0.0} 59 | 60 | for category_name, category_rate in expected.items(): 61 | self.assertEqual(config.rate_for(category_name), category_rate) 62 | 63 | def test_category_of_should_return_category_that_tag_belongs_to(self): 64 | with patch( 65 | "builtins.open", mock_open(read_data=self.raw_file_data) 66 | ) as mocked_open: 67 | config = BillWarriorConfig() 68 | 69 | expected = { 70 | "billable": ["coding", "research", "meeting"], 71 | "expensed": ["travel", "flight", "train"], 72 | "nonbillable": ["pingpong", "lunch"], 73 | } 74 | 75 | for category_name, tags in expected.items(): 76 | for tag in tags: 77 | self.assertEqual(config.category_of(tag), category_name) 78 | 79 | def test_category_of_should_return_None_when_tag_has_no_category(self): 80 | with patch("builtins.open", mock_open(read_data=self.raw_file_data)): 81 | config = BillWarriorConfig() 82 | 83 | category = config.category_of('unmapped tag') 84 | self.assertIsNone(category) 85 | 86 | 87 | -------------------------------------------------------------------------------- /tests/test_invoice.py: -------------------------------------------------------------------------------- 1 | import contextlib 2 | import os 3 | import time 4 | import unittest 5 | from datetime import datetime, timedelta, timezone 6 | from random import randint 7 | from unittest import mock 8 | 9 | import pytest 10 | from timewreport.interval import TimeWarriorInterval 11 | 12 | import tests.testsupport as tests 13 | from billwarrior.config import BillWarriorConfig 14 | from billwarrior.invoice import Invoice, ItemCategory, LineItem 15 | 16 | 17 | @contextlib.contextmanager 18 | def mock_tz(new_tz): 19 | old_tz = os.environ.get('TZ') 20 | os.environ['TZ'] = new_tz 21 | time.tzset() 22 | try: 23 | yield 24 | finally: 25 | if old_tz is not None: 26 | os.environ['TZ'] = old_tz 27 | else: 28 | del os.environ['TZ'] 29 | time.tzset() 30 | 31 | 32 | class BillWarriorConfigFake(BillWarriorConfig): 33 | def __init__(self): 34 | pass 35 | 36 | @classmethod 37 | def build(cls, tag_mapping={}, rate_mapping={}): 38 | def fake_text_for(category): 39 | return category 40 | 41 | def fake_category_of(tag): 42 | return tag_mapping.get(tag, None) 43 | 44 | def fake_rate_for(category): 45 | return rate_mapping.get(category, 0.0) 46 | 47 | billw_config = cls() 48 | billw_config.text_for = mock.MagicMock(side_effect=fake_text_for) 49 | billw_config.category_of = mock.MagicMock(side_effect=fake_category_of) 50 | billw_config.rate_for = mock.MagicMock(side_effect=fake_rate_for) 51 | 52 | return billw_config 53 | 54 | 55 | class InvoiceTest(unittest.TestCase): 56 | def test_creates_different_categories_from_interval_tags_and_mapping(self): 57 | a, b = ( 58 | tests.give_interval(tags=["videocall", "meeting"]), 59 | tests.give_interval(tags=["flight", "nyc"]), 60 | ) 61 | 62 | billw_config = BillWarriorConfigFake.build( 63 | {"meeting": "Consulting & Research", "flight": "Travel"} 64 | ) 65 | 66 | invoice = Invoice([a, b], billw_config) 67 | items = invoice.items() 68 | 69 | expected_a, expected_b = ( 70 | ItemCategory("Consulting & Research", {a.get_date().date(): [a]}, 0.0), 71 | ItemCategory("Travel", {b.get_date().date(): [b]}, 0.0), 72 | ) 73 | 74 | self.assertEqual(len(items), 2) 75 | self.assertEqual(str(expected_a), str(items[0])) 76 | self.assertEqual(str(expected_b), str(items[1])) 77 | 78 | def test_groups_intervals_of_same_category(self): 79 | with mock_tz('UTC'): 80 | same_day = datetime.today() 81 | a, b, c = ( 82 | tests.give_interval(same_day, tags=["on-site", "coding"]), 83 | tests.give_interval(same_day, tags=["coding", "off-site"]), 84 | tests.give_interval(tags=["coding", "cafe"]), 85 | ) 86 | 87 | billw_config = BillWarriorConfigFake.build({"coding": "Consulting & Research"}) 88 | 89 | invoice = Invoice([a, b, c], billw_config) 90 | items = invoice.items() 91 | 92 | expected = ItemCategory( 93 | "Consulting & Research", 94 | {same_day.date(): [a, b], c.get_date().date(): [c]}, 95 | 0.0, 96 | ) 97 | 98 | self.assertEqual(len(items), 1) # one category 99 | self.assertEqual(str(items[0]), str(expected)) 100 | 101 | def test_raises_exception_when_interval_sorts_into_more_than_one_category(self): 102 | a, b = ( 103 | tests.give_interval(tags=["videocall", "meeting"]), 104 | tests.give_interval(tags=["flight", "videocall", "other tag"]), 105 | ) 106 | 107 | a_category = "Consulting & Research" 108 | tag_mapping = { 109 | "meeting": a_category, 110 | "videocall": a_category, 111 | "flight": "Travel", 112 | } 113 | 114 | billw_config = BillWarriorConfigFake.build(tag_mapping) 115 | 116 | with self.assertRaisesRegex( 117 | ValueError, 118 | "Intervals with the following tags belongs to more than one category: .", 119 | ) as e: 120 | Invoice([a, b], billw_config) 121 | 122 | def test_raises_exception_when_an_interval_does_not_belong_to_any_category(self): 123 | a, b = ( 124 | tests.give_interval(tags=["meeting"]), 125 | tests.give_interval(tags=["coding", "stories"]), 126 | ) 127 | 128 | billw_config = BillWarriorConfigFake.build( 129 | {"flight": "Travel", "coding": "Software Development"} 130 | ) 131 | 132 | with self.assertRaisesRegex( 133 | ValueError, 134 | "These intervals with the following tags don't belong to any category: .", 135 | ) as e: 136 | Invoice([a, b], billw_config) 137 | 138 | def test_sets_unit_price_for_item_category(self): 139 | a, b = ( 140 | tests.give_interval(tags=["meeting"]), 141 | tests.give_interval(tags=["coding", "stories"]), 142 | ) 143 | 144 | category_a = "Consulting & Research" 145 | category_b = "Software Development" 146 | 147 | billw_config = BillWarriorConfigFake.build( 148 | {"meeting": category_a, "coding": category_b}, 149 | {category_a: 9.34, category_b: 12.02}, 150 | ) 151 | 152 | invoice = Invoice([a, b], billw_config) 153 | items = invoice.items() 154 | 155 | expected_a, expected_b = ( 156 | ItemCategory( 157 | "Consulting & Research", 158 | {a.get_date().date(): [a]}, 159 | billw_config.rate_for(category_a), 160 | ), 161 | ItemCategory( 162 | "Software Development", 163 | {b.get_date().date(): [b]}, 164 | billw_config.rate_for(category_b), 165 | ), 166 | ) 167 | 168 | self.assertEqual(len(items), 2) 169 | self.assertEqual(str(expected_a), str(items[0])) 170 | self.assertEqual(str(expected_b), str(items[1])) 171 | 172 | def test_alpha_orders_categories(self): 173 | a, b = ( 174 | tests.give_interval(tags=["meeting"]), 175 | tests.give_interval(tags=["coding", "stories"]), 176 | ) 177 | 178 | category_a = "Consulting & Research" 179 | category_b = "Software Development" 180 | 181 | billw_config = BillWarriorConfigFake.build( 182 | {"coding": category_b, "meeting": category_a}, 183 | {category_a: 12.02, category_b: 9.34}, 184 | ) 185 | 186 | invoice = Invoice([b, a], billw_config) 187 | items = invoice.items() 188 | 189 | expected_a, expected_b = ( 190 | ItemCategory( 191 | "Consulting & Research", 192 | {a.get_date().date(): [a]}, 193 | billw_config.rate_for(category_a), 194 | ), 195 | ItemCategory( 196 | "Software Development", 197 | {b.get_date().date(): [b]}, 198 | billw_config.rate_for(category_b), 199 | ), 200 | ) 201 | 202 | self.assertEqual(len(items), 2) 203 | self.assertEqual(str(expected_a), str(items[0])) 204 | self.assertEqual(str(expected_b), str(items[1])) 205 | 206 | def test_prints_invoice_categories_and_items(self): 207 | a, b = ( 208 | tests.give_interval(tags=["meeting"]), 209 | tests.give_interval(tags=["coding", "stories"]), 210 | ) 211 | 212 | category_a = "Consulting & Research" 213 | category_b = "Software Development" 214 | 215 | billw_config = BillWarriorConfigFake.build( 216 | {"meeting": category_a, "coding": category_b}, 217 | {category_a: 9.34, category_b: 12.02}, 218 | ) 219 | expected_a, expected_b = ( 220 | ItemCategory( 221 | "Consulting & Research", 222 | {a.get_date().date(): [a]}, 223 | billw_config.rate_for(category_a), 224 | ), 225 | ItemCategory( 226 | "Software Development", 227 | {b.get_date().date(): [b]}, 228 | billw_config.rate_for(category_b), 229 | ), 230 | ) 231 | 232 | invoice = Invoice([a, b], billw_config) 233 | printed_invoice = str(invoice) 234 | 235 | self.assertIn(str(expected_a), printed_invoice) 236 | self.assertIn(str(expected_b), printed_invoice) 237 | 238 | 239 | class ItemCategoryTest(unittest.TestCase): 240 | def test_header_should_display_formatted_tag_name_as_category_string(self): 241 | category = ItemCategory(" unclean tag name ", {}, 0.0) 242 | self.assertEqual(category.header, "Unclean tag name") 243 | 244 | def test_items_omitted_when_unit_price_is_negative(self): 245 | category = ItemCategory("invisible work", {}, -1) 246 | self.assertEqual(str(category), "") 247 | 248 | def test_line_items_should_be_populated_with_entries_per_day(self): 249 | with mock_tz('UTC'): 250 | a_day = datetime.today() 251 | entries = [ 252 | [tests.give_interval(a_day + timedelta(days=1))], 253 | [tests.give_interval(a_day + timedelta(days=2))], 254 | [tests.give_interval(a_day + timedelta(days=3))], 255 | ] 256 | intervals_by_day = {entry[0].get_date().date(): entry for entry in entries} 257 | 258 | category = ItemCategory("arbitray category", intervals_by_day, 0.0) 259 | 260 | self.assertEqual(len(category.line_items), len(entries)) 261 | 262 | def test_line_items_should_be_sorted_by_date(self): 263 | entries = [ 264 | [tests.give_interval()], 265 | [tests.give_interval()], 266 | [tests.give_interval()], 267 | ] 268 | dates = [entry[0].get_date().date() for entry in entries] 269 | 270 | category = ItemCategory("arbitray category", dict(zip(dates, entries)), 0.0) 271 | 272 | sorted_date_list = sorted([entry[0].get_date().date() for entry in entries]) 273 | self.assertListEqual( 274 | [ 275 | datetime.strptime(line_item.date, "%B %d, %Y").date() 276 | for line_item in category.line_items 277 | ], 278 | sorted_date_list, 279 | ) 280 | 281 | def test_str_should_display_header_line_items_and_subtotal_as_latex_output(self): 282 | a, b = tests.give_interval(), tests.give_interval() 283 | entries = {a.get_date().date(): [a], b.get_date().date(): [b]} 284 | 285 | category = ItemCategory("arbitrary category", entries, 0.0) 286 | 287 | expected = "".join( 288 | [ 289 | "\\feetype{%s}\n" % category.header, 290 | "".join( 291 | [ 292 | "%s\n" % LineItem(i.get_date(), i.get_duration(), 0.0) 293 | for i in sorted([a, b], key=lambda x: x.get_date()) 294 | ] 295 | ), 296 | "\\subtotal\n", 297 | "%------------------------------------------------", 298 | ] 299 | ) 300 | 301 | self.assertEqual(category.__str__(), expected) 302 | 303 | 304 | class LineItemTest(unittest.TestCase): 305 | def test_date_should_display_month_day_year_correctly_in_latex(self): 306 | day = datetime.today() 307 | line_item = LineItem(day, None, None) 308 | 309 | self.assertEqual(line_item.date, day.strftime("%B %d, %Y")) 310 | 311 | def test_duration_should_display_decimal_value_of_hours_worked(self): 312 | duration = timedelta( 313 | hours=8, minutes=51, seconds=59 314 | ) 315 | line_item = LineItem(datetime.today(), duration, None) 316 | 317 | totsec = duration.total_seconds() 318 | total = totsec / 3600.0 319 | 320 | self.assertEqual(line_item.duration, "{:.2f}".format(total)) 321 | 322 | def test_unit_price_should_be_displayed_as_is(self): 323 | unit_price = randint(0, 200) + randint(0, 99) * 0.1 324 | line_item = LineItem(datetime.today(), timedelta(), unit_price) 325 | 326 | self.assertEqual(line_item.unit_price, "{:.2f}".format(unit_price)) 327 | 328 | def test_str_should_display_full_line_item_as_latex_output(self): 329 | line_item = LineItem( 330 | datetime.today(), 331 | timedelta(0, randint(0, 8) * 3600), 332 | randint(0, 200) + randint(0, 99) * 0.1, 333 | ) 334 | 335 | self.assertEqual( 336 | line_item.__str__(), 337 | "\\hourrow{%s}{%s}{%s}" 338 | % (line_item.date, line_item.duration, line_item.unit_price), 339 | ) 340 | -------------------------------------------------------------------------------- /tests/testsupport.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime, timedelta 2 | from random import randint 3 | 4 | from timewreport.interval import TimeWarriorInterval 5 | 6 | DT_FORMAT = "%Y%m%dT%H%M%SZ" 7 | 8 | 9 | def give_interval(day=None, tags=[]): 10 | if day: 11 | start = day.replace(hour=randint(0, 12)) 12 | else: 13 | start = datetime.today().replace(day=randint(1, 28), month=randint(1, 12)) 14 | 15 | end = start + timedelta(0, randint(60 * 5, 60 * 60 * 2)) # up to 2h 16 | 17 | return TimeWarriorInterval(start.strftime(DT_FORMAT), end.strftime(DT_FORMAT), tags) 18 | --------------------------------------------------------------------------------