├── .gitignore ├── COPYING ├── README.md ├── get-pdfs-of-issues.py ├── github.py ├── make-estimation-spreadsheet.py ├── make-sprint-milestone-spreadsheets.py ├── requirements.txt └── set-estimates.py /.gitignore: -------------------------------------------------------------------------------- 1 | /images 2 | /pdfs 3 | *~ 4 | *.pyc 5 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Useful scripts for managing GitHub issues 2 | 3 | If GitHub issues play an important role in the way you manage 4 | projects, then some of these scripts might be of use to you. 5 | 6 | All of them rely on having a `~/.github-oauth-token.json` file 7 | with your GitHub OAuth token, like: 8 | 9 | ``` 10 | {"token": "your github oauth access token here"} 11 | ``` 12 | 13 | You can generate such a token from 14 | https://github.com/settings/tokens/new 15 | 16 | ## Remote collaborative estimation in a Google Spreadsheet 17 | 18 | ### make-estimation-spreadsheet.py 19 | 20 | At work we do estimation of the difficulty of issues in a Google 21 | Spreadsheet, where each developer has their own sheet within the 22 | spreadsheet. They put in a score (and optionally some notes) 23 | beside each of the open unestimated issues without looking at 24 | anyone else's sheet. Then we get together on a video call and 25 | all switch to the 'Consensus' sheet in the spreadsheet and 26 | discuss any issues where we've made different estimates. 27 | 28 | The procedure for doing this is to run a command like: 29 | 30 | ``` 31 | ./make-estimation-spreadsheet.py mysociety/pombola mark duncan liz 32 | ``` 33 | 34 | The first parameter is the name of the GitHub repository and the 35 | remaining parameters are names of the developers who'll be 36 | taking part in the estimation exercise. 37 | 38 | That command will generate a file called `estimates.xls`. 39 | 40 | Unfortunately, just uploading this to Google Docs via 41 | the obvious way doesn't seem to work; instead, you need to 42 | create an empty Google Spreadsheet first, and then go to 43 | "File > Import ...", select the 'Upload' tab, select the 44 | `estimates.xls` file, and then select "Replace spreadsheet". 45 | 46 | Then share that spreadsheet with your fellow developers, ideally 47 | giving them the URL for their personal sheet within the 48 | spreadsheet. 49 | 50 | (Incidentally, the scoring system we use for estimation of 51 | difficulty of issues is Mazz Mosley's, 52 | [as described by Anna Shipman](http://www.annashipman.co.uk/jfdi/how-to-estimate.html) 53 | which is based on how much you already know about how to do it 54 | rather than estimating hours, say.) 55 | 56 | ### set-estimates.py 57 | 58 | Once you've arrived at a consensus, you'll want to add those 59 | estimates to the GitHub issues as labels of the form 60 | `Difficulty 3`, `Difficulty 5`, etc. There's another script in 61 | this repository to help with this, called `set-estimates.py`. 62 | 63 | First, download just the 'Consensus' sheet of your estimation 64 | spreadsheet in Google Docs as a CSV file. You can do that by 65 | switching to that sheet and going to 66 | "File > Download > Comma-separated values". 67 | 68 | Then you can give the downloaded file as the second parameter to 69 | the script - the first should be the name of the repository on 70 | GitHub, e.g. 71 | 72 | ``` 73 | ./set-estimates.py mysociety/pombola "Pombola estimation - Consensus.csv" 74 | ``` 75 | 76 | ## Create a PDF file of every open issue in a respository 77 | 78 | ### get-pdfs-of-issues.py 79 | 80 | If you run this script against a repository, e.g. with: 81 | 82 | ``` 83 | ./get-pdfs-of-issues.py mysociety/yournextrepresentative 84 | ``` 85 | 86 | ... it's make a `pdfs` subdirectory and generate one PDF in 87 | there for each open issue in the repository. We found this 88 | useful for 89 | [printing out every open issue in a repository to triage them](http://longair.net/blog/2014/02/16/printing-out-github-issues-for-triage-or-estimation/). 90 | 91 | Note that pandoc needs a lot of texlive to be installed for it 92 | to generate PDFs - I needed to install the following: 93 | 94 | ``` 95 | sudo apt-get install \ 96 | texlive-fonts-recommended \ 97 | texlive-latex-base \ 98 | texlive-latex-extra \ 99 | texlive-latex-recommended \ 100 | texlive-xetex 101 | ``` 102 | 103 | Of course, some of these PDFs may be more than one page. To 104 | print out just the first page of each, 4 to an A4 side, I did 105 | this: 106 | 107 | ``` 108 | cd pdfs 109 | for i in *.pdf; do pdftk $i cat 1-1 output ${i%.pdf}-first-page.pdf; done 110 | pdftk *-first-page.pdf cat output all-first-pages.pdf 111 | pdfnup --nup 2x2 --outfile all-first-pages-4up.pdf --no-landscape all-first-pages.pdf 112 | ``` 113 | 114 | (`pdftk` is in the Debian package of the same name, and `pdfnup` 115 | is from `texlive-extra-utils`.) 116 | 117 | If you use Mac OS, then apparently this may be helpful as help 118 | on how to combine and print out the PDFs: 119 | https://support.apple.com/en-gb/ht4075 (Thanks to Tom Steinberg 120 | for that suggestion.) 121 | 122 | ## Spreadsheets for calculating sprint velocity / performance 123 | 124 | When we first started estimating, I was interested in how the 125 | points we estimated related to the amount of time in a sprint, 126 | so it was helpful to generate CSV files with details of the 127 | issues that were in each sprint (in the sense of being 128 | associated with the milestone representing the sprint in GitHub 129 | issues) and any other issues that were closed over the course of 130 | the sprint. 131 | 132 | This assumes that the following things are true: 133 | 134 | * You use labels for difficulty points as above (i.e. of the 135 | form `Difficulty N`_) 136 | * You have milestones that represent each sprint, with a title 137 | that begins with 'Sprint' 138 | * Each milestone has a due date set in GitHub issues for the end 139 | of the sprint. 140 | 141 | Then, supposing you have two weeks sprints, you can run: 142 | 143 | ``` 144 | ./make-sprint-milestone-spreadsheets.py mysociety/pombola 14 145 | ``` 146 | 147 | That should generate one CSV file for each sprint milestone in 148 | GitHub issues. 149 | 150 | --- 151 | 152 | Mark Longair 153 | -------------------------------------------------------------------------------- /get-pdfs-of-issues.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright 2014, 2015 Mark Longair 5 | # This script is distributed under the terms of the GNU General Public License. 6 | # See the COPYING file in this repository for the complete text of the license. 7 | 8 | from distutils import spawn 9 | import doctest 10 | import errno 11 | import hashlib 12 | from optparse import OptionParser 13 | import os 14 | from os.path import dirname, exists, isdir, join, realpath, relpath, splitext 15 | import re 16 | import requests 17 | import subprocess 18 | import sys 19 | import tempfile 20 | 21 | from github import standard_headers, get_issues 22 | 23 | if not spawn.find_executable('pandoc'): 24 | print >> sys.stderr, "pandoc couldn't be found on PATH" 25 | sys.exit(1) 26 | 27 | # This is a script that downloads all the GitHub issues in a 28 | # particular repository and generates a PDF for each one; the idea is 29 | # to produce easily printable versions of all the issues for a 30 | # repository. 31 | 32 | # To get pandoc to produce PDFs, I also needed to install: 33 | # 34 | # texlive-fonts-recommended 35 | # texlive-latex-base 36 | # texlive-latex-extra 37 | # texlive-latex-recommended 38 | # texlive-xetex 39 | 40 | cwd = os.getcwd() 41 | repo_directory = realpath(join(dirname(__file__))) 42 | images_directory = relpath(join(repo_directory, 'images'), cwd) 43 | pdfs_directory = relpath(join(repo_directory, 'pdfs'), cwd) 44 | 45 | def mkdir_p(d): 46 | try: 47 | os.makedirs(d) 48 | except OSError, e: 49 | if e.errno == errno.EEXIST and isdir(d): 50 | pass 51 | else: 52 | raise 53 | 54 | mkdir_p(images_directory) 55 | mkdir_p(pdfs_directory) 56 | 57 | def replace_image(match, download=True): 58 | """Rewrite an re match object that matched an image tag 59 | 60 | Download the image and return a version of the tag rewritten 61 | to refer to the local version. The local version is named 62 | after the MD5sum of the URL. 63 | 64 | >>> m = re.search(r'\!\[(.*?)\]\((.*?)\)', 65 | ... 'an image coming up ![caption](http://blah/a/foo.png)') 66 | >>> replace_image(m, download=False) 67 | '![caption](github-print-issues/images/b62082dd8a02ea495f5e3c293eb6ee67.png)' 68 | """ 69 | 70 | caption = match.group(1) 71 | url = match.group(2) 72 | hashed_url = hashlib.md5(url).hexdigest() 73 | extension = splitext(url)[1] 74 | if not extension: 75 | raise Exception, "No extension at the end of {0}".format(url) 76 | image_filename = join(images_directory, hashed_url) + extension 77 | if download: 78 | if not exists(image_filename): 79 | r = requests.get(url) 80 | with open(image_filename, 'w') as f: 81 | f.write(r.content) 82 | return "![{0}]({1})".format(caption, image_filename) 83 | 84 | def replace_images(md): 85 | """Rewrite a Markdown string to replace any images with local versions 86 | 87 | 'md' should be a GitHub Markdown string; the return value is a version 88 | of this where any references to images have been downloaded and replaced 89 | by a reference to a local copy. 90 | """ 91 | 92 | return re.sub(r'\!\[(.*?)\]\((.*?)\)', replace_image, md) 93 | 94 | def main(repo): 95 | 96 | for number, title, body, issue in get_issues(repo): 97 | 98 | pdf_filename = join(pdfs_directory, 99 | '{}.pdf'.format(number)) 100 | if exists(pdf_filename): 101 | continue 102 | 103 | ntf = tempfile.NamedTemporaryFile(suffix='.md', delete=False) 104 | md_filename = ntf.name 105 | 106 | if 'pull_request' in issue and issue['pull_request']['html_url']: 107 | continue 108 | 109 | print "Doing issue", number, title 110 | 111 | with open(md_filename, 'w') as f: 112 | f.write(u"# {0} {1}\n\n".format(number, title).encode('utf-8')) 113 | f.write("### Reported by {0}\n\n".format(issue['user']['login'])) 114 | # Increase the indent level of any Markdown heading 115 | body = re.sub(r'^(#+)', r'#\1', body or '') 116 | body = replace_images(body) 117 | body = body.encode('utf-8') 118 | f.write(body) 119 | f.write("\n\n") 120 | if issue['comments'] > 0: 121 | comments_request = requests.get(issue['comments_url'], 122 | headers=standard_headers) 123 | for comment in comments_request.json(): 124 | f.write("### Comment from {0}\n\n".format(comment['user']['login'])) 125 | comment_body = comment['body'] 126 | # Make sure any headings in comments are less 127 | # prominent than those we create around the comment. 128 | comment_body = re.sub(r'^(#+)', r'###\1', comment_body) 129 | comment_body = replace_images(comment_body) 130 | f.write(comment_body.encode('utf-8')) 131 | f.write("\n\n") 132 | 133 | subprocess.check_call(['pandoc', 134 | '--latex-engine=xelatex', 135 | '-f', 136 | 'markdown_github', 137 | md_filename, 138 | '-o', 139 | pdf_filename]) 140 | 141 | os.remove(ntf.name) 142 | 143 | 144 | usage = """Usage: %prog [options] REPOSITORY 145 | 146 | Repository should be username/repository from GitHub, e.g. mysociety/pombola""" 147 | parser = OptionParser(usage=usage) 148 | parser.add_option("-t", "--test", 149 | action="store_true", dest="test", default=False, 150 | help="Run doctests") 151 | 152 | (options, args) = parser.parse_args() 153 | 154 | if options.test: 155 | doctest.testmod() 156 | else: 157 | if len(args) != 1: 158 | parser.print_help() 159 | else: 160 | main(args[0]) 161 | -------------------------------------------------------------------------------- /github.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | from os.path import join 4 | 5 | import requests 6 | 7 | with open(join(os.environ['HOME'], '.github-oauth-token-new.json')) as f: 8 | token = json.load(f)['token'] 9 | 10 | standard_headers = {'User-Agent': 'github-issues-printer/1.0', 11 | 'Authorization': 'bearer {0}'.format(token)} 12 | 13 | def get_issues(repo, state='open'): 14 | page = 1 15 | while True: 16 | issues_url = 'https://api.github.com/repos/{0}/issues'.format(repo) 17 | r = requests.get(issues_url, 18 | params={'per_page': '100', 19 | 'page': str(page), 20 | 'state': state}, 21 | headers=standard_headers) 22 | if r.status_code != 200: 23 | raise Exception, "HTTP status {0} on fetching {1}".format( 24 | r.status_code, 25 | issues_url) 26 | 27 | issues_json = r.json() 28 | for issue in issues_json: 29 | number = issue['number'] 30 | title = issue['title'] 31 | body = issue['body'] 32 | yield number, title, body, issue 33 | 34 | page += 1 35 | if 'Link' not in r.headers: 36 | break 37 | if 'rel="next"' not in r.headers['Link']: 38 | break 39 | -------------------------------------------------------------------------------- /make-estimation-spreadsheet.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from collections import namedtuple 4 | import doctest 5 | from optparse import OptionParser 6 | import os 7 | from os.path import dirname, join, realpath 8 | import re 9 | from xlwt import Workbook, Formula 10 | 11 | from github import get_issues 12 | 13 | # This script generates an Excel spreadsheet with one sheet per 14 | # developer and a consensus sheet, designed to be uploaded to Google 15 | # Spreadsheets for making estimates independently. 16 | 17 | cwd = os.getcwd() 18 | repo_directory = realpath(join(dirname(__file__))) 19 | 20 | SheetInfo = namedtuple('SheetInfo', ['name', 'developer', 'sheet']) 21 | 22 | Issue = namedtuple('Issue', ['url', 'number', 'title']) 23 | 24 | # Algorithm from: http://stackoverflow.com/a/182924/223092 25 | alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" 26 | def column_number_to_letters(column_number): 27 | dividend = column_number 28 | result = '' 29 | while dividend > 0: 30 | modulus = (dividend - 1) % len(alphabet) 31 | result = alphabet[modulus] + result 32 | dividend = (dividend - modulus) / len(alphabet) 33 | return result 34 | 35 | def get_unestimated_open_issues(repo): 36 | 37 | results = [] 38 | row_index = 1 39 | 40 | for number, title, body, issue in get_issues(repo): 41 | if ('pull_request' in issue) and issue['pull_request']['html_url']: 42 | continue 43 | difficulty_label_names = [i['name'] for i in issue['labels'] 44 | if re.search(r'Difficulty ', i['name'])] 45 | if difficulty_label_names: 46 | continue 47 | row_index += 1 48 | results.append(Issue(issue['html_url'], number, title)) 49 | 50 | return results 51 | 52 | def main(repo, developers): 53 | 54 | basic_header = ['URL', 'Number', 'Title'] 55 | 56 | workbook = Workbook() 57 | sheets = [] 58 | 59 | for developer in developers: 60 | sheet_name = "{0} Estimates".format(developer) 61 | sheet = workbook.add_sheet(sheet_name) 62 | sheets.append(SheetInfo(sheet_name, developer, sheet)) 63 | 64 | consensus_sheet_name = "Consensus" 65 | consensus_sheet_info = SheetInfo( 66 | consensus_sheet_name, 67 | None, 68 | workbook.add_sheet(consensus_sheet_name) 69 | ) 70 | sheets.append(consensus_sheet_info) 71 | 72 | for sheet_info in sheets: 73 | sheet = sheet_info.sheet 74 | for column_index, column_header in enumerate(basic_header): 75 | sheet.write(0, column_index, column_header) 76 | if sheet_info.developer: 77 | sheet.write(0, len(basic_header), "{0} Estimate".format(sheet_info.developer)) 78 | sheet.write(0, len(basic_header) + 1, "{0} Notes".format(sheet_info.developer)) 79 | else: 80 | # If it's the consensus sheet, then add two columns for 81 | # each developer. 82 | column_index = len(basic_header) 83 | for developer in developers: 84 | sheet.write(0, column_index, "{0} Estimate".format(developer)) 85 | sheet.write(0, column_index + 1, "{0} Notes".format(developer)) 86 | column_index += 2 87 | sheet.write(0, column_index, "Consensus") 88 | 89 | for i, issue in enumerate(get_unestimated_open_issues(repo)): 90 | row_index = i + 1 91 | for sheet_info in sheets: 92 | for column_index in range(len(basic_header)): 93 | sheet_info.sheet.write(row_index, column_index, issue[column_index]) 94 | # In the Consensus sheet add a reference to each of the 95 | # developer sheets' estimate and notes columns. 96 | for i, sheet_info in enumerate(s for s in sheets if s.developer): 97 | fmt = "'{sheet}'!{column}{row}" 98 | for original_column_index in (len(basic_header) + i for i in range(2)): 99 | formula_text = fmt.format( 100 | sheet=sheet_info.name, 101 | column=column_number_to_letters(original_column_index + 1), 102 | row=row_index + 1) 103 | consensus_sheet_info.sheet.write( 104 | row_index, 105 | original_column_index + 2 * i, 106 | Formula(formula_text)) 107 | 108 | workbook.save('estimates.xls') 109 | 110 | usage = """Usage: %prog [options] REPOSITORY DEVELOPER_A DEVELOPER_B ... 111 | 112 | Repository should be username/repository from GitHub, e.g. mysociety/pombola""" 113 | parser = OptionParser(usage=usage) 114 | parser.add_option("-t", "--test", 115 | action="store_true", dest="test", default=False, 116 | help="Run doctests") 117 | 118 | (options, args) = parser.parse_args() 119 | 120 | if options.test: 121 | doctest.testmod() 122 | else: 123 | if len(args) < 2: 124 | parser.print_help() 125 | else: 126 | repository = args[0] 127 | developers = args[1:] 128 | main(repository, developers) 129 | -------------------------------------------------------------------------------- /make-sprint-milestone-spreadsheets.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from collections import defaultdict 4 | import csv 5 | import datetime 6 | import dateutil.parser 7 | import doctest 8 | from optparse import OptionParser 9 | import os 10 | from os.path import dirname, join, realpath 11 | import re 12 | import requests 13 | 14 | from github import standard_headers, get_issues 15 | 16 | # If you use milestones to group the issues that you hope to close 17 | # over the course of the sprint, and 'Difficulty N' labels to indicate 18 | # their relative complexity, this script will generate CSV files with 19 | # the issues for each sprint. 20 | 21 | cwd = os.getcwd() 22 | repo_directory = realpath(join(dirname(__file__))) 23 | 24 | def get_difficulty(issue): 25 | difficulty_label_names = [i['name'] for i in issue['labels'] 26 | if re.search(r'^Difficulty ', i['name'])] 27 | if len(difficulty_label_names) == 0: 28 | return None 29 | elif len(difficulty_label_names) == 1: 30 | label = difficulty_label_names[0] 31 | m = re.search(r'^Difficulty (\d+)', label) 32 | if not m: 33 | message = "Malformed Difficulty label: '{0}'".format(label) 34 | raise Exception, message 35 | return int(m.group(1), 10) 36 | else: 37 | raise Exception, "Found multiple Difficulty labels: '{0}'".format( 38 | difficulty_label_names) 39 | 40 | def issues_sort_key(issue): 41 | state_number = 0 if issue['state'] == 'closed' else 1 42 | closed_at = issue['closed_at'] 43 | return (state_number, closed_at) 44 | 45 | def main(repo, days_in_a_sprint): 46 | 47 | milestone_due_dates = {} 48 | milestone_start_dates = {} 49 | 50 | for milestone_status in ('open', 'closed'): 51 | milestones_url = 'https://api.github.com/repos/{0}/milestones'.format(repo) 52 | r = requests.get(milestones_url, 53 | params={'state': 'open'}, 54 | headers=standard_headers) 55 | if r.status_code != 200: 56 | raise Exception, "HTTP status {0} on fetching {1}".format( 57 | r.status_code, 58 | milestones_url) 59 | for milestone in r.json(): 60 | title = milestone['title'] 61 | if title.startswith('Sprint'): 62 | due_date = dateutil.parser.parse(milestone['due_on']) + \ 63 | datetime.timedelta(hours=4) 64 | start_date = due_date - datetime.timedelta(days=days_in_a_sprint) 65 | milestone_start_dates[title] = start_date 66 | milestone_due_dates[title] = due_date 67 | 68 | milestones = sorted(milestone_due_dates.keys()) 69 | 70 | issues_in_milestone = defaultdict(list) 71 | issues_not_in_milestone = defaultdict(list) 72 | 73 | for number, title, body, issue in get_issues(repo, state='all'): 74 | 75 | if ('pull_request' in issue) and issue['pull_request']['html_url']: 76 | continue 77 | 78 | issue['difficulty'] = get_difficulty(issue) 79 | 80 | print "considering issue:", number 81 | 82 | date_closed = issue['closed_at'] 83 | if date_closed is not None: 84 | date_closed = dateutil.parser.parse(date_closed) 85 | 86 | issue['closed_at'] = date_closed 87 | 88 | milestone = issue['milestone'] 89 | if milestone is not None: 90 | milestone = milestone['title'] 91 | 92 | if milestone in milestone_due_dates: 93 | issues_in_milestone[milestone].append(issue) 94 | elif date_closed: 95 | for possible_milestone in milestones: 96 | if date_closed > milestone_start_dates[possible_milestone] and \ 97 | date_closed <= milestone_due_dates[possible_milestone]: 98 | issues_not_in_milestone[possible_milestone].append(issue) 99 | 100 | for milestone in milestones: 101 | 102 | filename = milestone + ".csv" 103 | 104 | print "writing:", filename 105 | 106 | with open(filename, "w") as fp: 107 | writer = csv.writer(fp) 108 | writer.writerow(['OfficiallyInMilestone', 'State', 'URL', 'Number', 'Difficulty', 'Title']) 109 | in_milestone = sorted(issues_in_milestone[milestone], 110 | key=issues_sort_key) 111 | not_in_milestone = sorted(issues_not_in_milestone[milestone], 112 | key=issues_sort_key) 113 | for issue in in_milestone: 114 | writer.writerow([True, 115 | issue['state'], 116 | issue['html_url'], 117 | issue['number'], 118 | issue['difficulty'], 119 | issue['title']]) 120 | for issue in not_in_milestone: 121 | writer.writerow([False, 122 | issue['state'], 123 | issue['html_url'], 124 | issue['number'], 125 | issue['difficulty'], 126 | issue['title']]) 127 | 128 | usage = """Usage: %prog [options] REPOSITORY DAYS-IN-A-SPRINT 129 | 130 | Repository should be username/repository from GitHub, e.g. mysociety/pombola""" 131 | parser = OptionParser(usage=usage) 132 | parser.add_option("-t", "--test", 133 | action="store_true", dest="test", default=False, 134 | help="Run doctests") 135 | 136 | (options, args) = parser.parse_args() 137 | 138 | if options.test: 139 | doctest.testmod() 140 | else: 141 | if len(args) != 2: 142 | parser.print_help() 143 | else: 144 | main(args[0], int(args[1])) 145 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | argparse==1.2.1 2 | cffi==1.2.1 3 | cryptography==1.0.2 4 | enum34==1.0.4 5 | idna==2.0 6 | ipaddress==1.0.14 7 | ndg-httpsclient==0.4.0 8 | pyOpenSSL==0.15.1 9 | pyasn1==0.1.9 10 | pycparser==2.14 11 | requests==2.6.0 12 | six==1.9.0 13 | wsgiref==0.1.2 14 | xlwt==0.7.5 15 | -------------------------------------------------------------------------------- /set-estimates.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import csv 4 | import doctest 5 | import json 6 | from optparse import OptionParser 7 | import os 8 | from os.path import dirname, join, realpath 9 | import requests 10 | 11 | from github import standard_headers 12 | 13 | # This script takes a CSV file and uses the data in it to set labels 14 | # on tickets to indicate their difficulty. 15 | 16 | cwd = os.getcwd() 17 | repo_directory = realpath(join(dirname(__file__))) 18 | 19 | def main(repo, csv_file): 20 | 21 | with open(csv_file) as f: 22 | reader = csv.DictReader(f) 23 | for row in reader: 24 | issue_number = row['Number'] 25 | try: 26 | difficulty = int(row['Consensus'], 10) 27 | except ValueError: 28 | continue 29 | 30 | print "{0} => {1}".format(issue_number, difficulty) 31 | 32 | url_template = 'https://api.github.com/repos/{0}/issues/{1}/labels' 33 | url = url_template.format(repo, issue_number) 34 | labels = ["Difficulty " + str(difficulty)] 35 | print "url:", url 36 | print "labels:", labels 37 | r = requests.post(url, 38 | headers=standard_headers, 39 | data=json.dumps(labels)) 40 | print r.content 41 | 42 | usage = """Usage: %prog [options] REPOSITORY CSV-FILE 43 | 44 | REPOSITORY should be username/repository from GitHub, e.g. mysociety/pombola 45 | 46 | CSV-FILE should be have a "Consensus" column (with the estimated 47 | complexity as an integer) and a "Number" column with the issue number. 48 | """ 49 | parser = OptionParser(usage=usage) 50 | parser.add_option("-t", "--test", 51 | action="store_true", dest="test", default=False, 52 | help="Run doctests") 53 | 54 | (options, args) = parser.parse_args() 55 | 56 | if options.test: 57 | doctest.testmod() 58 | else: 59 | if len(args) != 2: 60 | parser.print_help() 61 | else: 62 | main(args[0], args[1]) 63 | --------------------------------------------------------------------------------