├── .gitattributes ├── .gitignore ├── AUTHORS ├── LICENSE ├── MANIFEST.in ├── NEWS ├── README.md ├── bin └── git2effort ├── git2effort ├── __init__.py ├── _version.py ├── effort.py └── merging.py ├── requirements.txt ├── setup.cfg └── setup.py /.gitattributes: -------------------------------------------------------------------------------- 1 | tests/data/* linguist-vendored 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.pyo 3 | build 4 | dist 5 | perceval.egg-info 6 | __pycache__ 7 | 8 | # Eclipse's files and directories 9 | .project 10 | .pydevproject 11 | .settings 12 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Gregorio Robles 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include NEWS 3 | include LICENSE 4 | include AUTHORS 5 | -------------------------------------------------------------------------------- /NEWS: -------------------------------------------------------------------------------- 1 | # Releases 2 | 3 | ## git2effort 0.1.4 - (2020-05-06) 4 | 5 | ** Bugs fixed: ** 6 | * Dependency included in a correct way 7 | 8 | 9 | ## git2effort 0.1.3 - (2020-05-06) 10 | 11 | ** Bugs fixed: ** 12 | * Missing dependency added 13 | 14 | 15 | ## git2effort 0.1.2 - (2020-05-06) 16 | 17 | ** New features and improvements: ** 18 | * Added the possibility to have debug information 19 | * Documented and added logging and debugging info 20 | * Results per period shown in a tabular form 21 | 22 | 23 | ## git2effort 0.1.1 - (2020-05-04) 24 | 25 | ** New features and improvements: ** 26 | * Outputting more (and clearer) information 27 | * Addied threshold t and period p as input parameters 28 | * More details and examples in the README.md 29 | 30 | ** Bugs fixed: ** 31 | * --version now returns the current version 32 | 33 | 34 | ## git2effort 0.1 - (2020-05-03) 35 | 36 | ** New features and improvements: ** 37 | 38 | * Supports Python 3.4 and newer versions. 39 | * Initial release 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # git2effort [![PyPI version](https://badge.fury.io/py/git2effort.svg)](https://badge.fury.io/py/git2effort) 2 | 3 | Calculate development effort estimation from a Git repository. 4 | 5 | ## Usage 6 | 7 | ``` 8 | usage: git2effort [-g] [] | --help | --version 9 | 10 | optional arguments: 11 | -t THRESHOLD, --threshold THRESHOLD 12 | Threshold value (in commits) to determine if a 13 | developers is full-time devoted to the project. 14 | Default=75. 15 | -p PERIOD, --period PERIOD 16 | Length of the time period (in months). Default=6. 17 | 18 | optional arguments: 19 | -g, --debug set debug mode on 20 | -h, --help show this help message and exit 21 | -v, --version show version 22 | 23 | ``` 24 | 25 | ## Requirements 26 | 27 | * Python >= 3.4 28 | * perceval >= 0.12 29 | * tabulate >= 0.8.7 30 | 31 | Note that you should have also the following packages installed in your system: 32 | - git 33 | - build-essential 34 | 35 | ## Installation 36 | 37 | There are several ways for installing git2effort on your system: from packages 38 | or from the source code. 39 | 40 | ### Pip 41 | 42 | Perceval can be installed using [pip](https://pip.pypa.io/en/stable/), a tool 43 | for installing Python packages. To do it, run the next command: 44 | 45 | ``` 46 | $ pip3 install git2effort 47 | ``` 48 | 49 | ### Source code 50 | 51 | To install from the source code you will need to clone the repository first: 52 | 53 | ``` 54 | $ git clone https://github.com/gregoriorobles/git2effort.git 55 | ``` 56 | 57 | Then you can execute the following commands: 58 | ``` 59 | $ pip3 install -r requirements.txt 60 | $ pip3 install . 61 | ``` 62 | 63 | 64 | ## Understanding git2effort 65 | 66 | The threshold t determines what developers are considered full-time in a period 67 | of time p. So, if in p months a developer does t commits, the developer is 68 | full-time. If not, his/her contributions will be a fraction of that. 69 | 70 | The value of the threshold t depends on the project, in particular, on its 71 | process (e.g., if there is a review process in place, if there is commit 72 | squashing when merging). Below you can find a list of projects that can serve 73 | as an example. The t values given below are supported by feedback provided 74 | by the developers of these projects. In all cases, the period is 6 months (the default one for git2effort). 75 | 76 | ``` 77 | Example threshold t values (for a default period of 6 months): 78 | 12: Strong review process with commit squashing, like in OpenStack and Moodle 79 | 18: Review process with commit squashing, like in Linux and Webkit 80 | 30: Soft review process, like in Mediawiki 81 | 50: Strong pull-request-driven process, like in Ceph 82 | 75: Soft pull-request-driven process, like in git2effort 83 | 100: Non-engineered process 84 | ``` 85 | 86 | ### Example: Running git2effort on Perceval 87 | 88 | To estimate the effort for a Git repository, execute the next command. Take into 89 | account that Git has to be installed on your system. 90 | 91 | In the case of Perceval, we assume that it is a project that follows a strong 92 | pull-request-driven process, like the one in Ceph, so we choose a threshold 93 | value of 50: 94 | 95 | ``` 96 | $ git2effort --threshold=50 https://github.com/chaoss/grimoirelab-perceval.git 97 | ``` 98 | 99 | ### Example: Running git2effort on git2effort 100 | 101 | To estimate the effort for a Git repository, execute the next command. Take into 102 | account that Git has to be installed on your system. 103 | 104 | In the case of git2effort, we assume that it is a project that follows a soft 105 | pull-request-driven process, so we choose a threshold value of 75 (as this is 106 | the default one in git2effort we do not need to specify it): 107 | 108 | ``` 109 | $ git2effort https://github.com/gregoriorobles/git2effort 110 | ``` 111 | 112 | ## Research in Progress 113 | 114 | This is research in progress. If you have any comments or suggestions, please contact me (grex at gsyc.urjc.es). I will be more than happy to hear to your feedback. 115 | 116 | 117 | ## References 118 | 119 | If you use git2effort in your research papers, please refer to [Estimating development effort in free/open source software projects by mining software repositories: a case study of openstack](https://dl.acm.org/doi/abs/10.1145/2597073.2597107) -- [Pre-print](https://www.researchgate.net/publication/260953482_Estimating_Development_Effort_in_FreeOpen_Source_Software_Projects_by_Mining_Software_Repositories): 120 | 121 | ### APA style 122 | 123 | ``` 124 | Robles, G., González-Barahona, J. M., Cervigón, C., Capiluppi, A., & Izquierdo-Cortázar, D. (2014, May). Estimating development effort in free/open source software projects by mining software repositories: a case study of openstack. In Proceedings of the 11th Working Conference on Mining Software Repositories (pp. 222-231). 125 | ``` 126 | 127 | ### BibTeX 128 | 129 | ``` 130 | @inproceedings{robles2014estimating, 131 | title={Estimating development effort in free/open source software projects by mining software repositories: a case study of openstack}, 132 | author={Robles, Gregorio and Gonz{\'a}lez-Barahona, Jes{\'u}s M and Cervig{\'o}n, Carlos and Capiluppi, Andrea and Izquierdo-Cort{\'a}zar, Daniel}, 133 | booktitle={Proceedings of the 11th Working Conference on Mining Software Repositories}, 134 | pages={222--231}, 135 | year={2014} 136 | } 137 | ``` 138 | 139 | 140 | ## License 141 | 142 | Licensed under GNU General Public License (GPL), version 3 or later. 143 | -------------------------------------------------------------------------------- /bin/git2effort: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Copyright (C) 2020 Gregorio Robles 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | # Authors: 20 | # Gregorio Robles 21 | # 22 | 23 | import argparse 24 | import logging 25 | import sys 26 | 27 | import git2effort 28 | import git2effort.effort 29 | import git2effort._version 30 | 31 | 32 | GIT2EFFORT_USAGE_MSG = \ 33 | """%(prog)s [-g] [] | --help | --version""" 34 | 35 | GIT2EFFORT_DESC_MSG = \ 36 | """Calculate development effort estimation from a Git repository. 37 | 38 | optional arguments: 39 | -g, --debug set debug mode on 40 | -h, --help show this help message and exit 41 | -v, --version show version 42 | """ 43 | 44 | 45 | GIT2EFFORT_EPILOG_MSG = \ 46 | """Visit http://github.com/gregoriorobles/git2effort for further information.""" 47 | 48 | GIT2EFFORT_VERSION_MSG = \ 49 | """%(prog)s """ + git2effort._version.__version__ 50 | 51 | 52 | # Logging formats 53 | GIT2EFFORT_LOG_FORMAT = "[%(asctime)s] - %(message)s" 54 | GIT2EFFORT_DEBUG_LOG_FORMAT = "[%(asctime)s - %(name)s - %(levelname)s] - %(message)s" 55 | 56 | 57 | def main(): 58 | args = parse_args() 59 | 60 | configure_logging(args.debug) 61 | 62 | if args.period > 12: 63 | logging.error("Period cannot be greater than 12.") 64 | return 65 | 66 | logging.info("git2effort starting.") 67 | 68 | git2effort.effort.run(vars(args)) 69 | 70 | logging.info("git2effort finished.") 71 | 72 | 73 | def parse_args(): 74 | """Parse command line arguments""" 75 | 76 | parser = argparse.ArgumentParser(usage=GIT2EFFORT_USAGE_MSG, 77 | description=GIT2EFFORT_DESC_MSG, 78 | epilog=GIT2EFFORT_EPILOG_MSG, 79 | formatter_class=argparse.RawDescriptionHelpFormatter, 80 | add_help=False) 81 | 82 | parser.add_argument('-h', '--help', action='help', 83 | help=argparse.SUPPRESS) 84 | parser.add_argument('-v', '--version', action='version', 85 | version=GIT2EFFORT_VERSION_MSG, 86 | help=argparse.SUPPRESS) 87 | parser.add_argument('-g', '--debug', dest='debug', 88 | action='store_true', 89 | help=argparse.SUPPRESS) 90 | 91 | parser.add_argument("git_repository", help="URL of the Git repository you want to estimate development effort") 92 | 93 | parser.add_argument('-t', '--threshold', type=int, default=75, help='Threshold value (in commits) to determine if a developers is full-time devoted to the project. Default=75.') 94 | 95 | parser.add_argument('-p', '--period', type=int, default=6, help='Length of the time period (in months). Default=6.') 96 | 97 | if len(sys.argv) == 1: 98 | parser.print_help() 99 | sys.exit(1) 100 | 101 | return parser.parse_args() 102 | 103 | def configure_logging(debug=False): 104 | """Configure git2effort logging 105 | 106 | The function configures the log messages produced by git2effort. 107 | By default, log messages are sent to stderr. Set the parameter 108 | `debug` to activate the debug mode. 109 | 110 | :param debug: set the debug mode 111 | """ 112 | if not debug: 113 | logging.basicConfig(level=logging.INFO, 114 | format=GIT2EFFORT_LOG_FORMAT) 115 | logging.getLogger('requests').setLevel(logging.WARNING) 116 | logging.getLogger('urrlib3').setLevel(logging.WARNING) 117 | else: 118 | logging.basicConfig(level=logging.DEBUG, 119 | format=GIT2EFFORT_DEBUG_LOG_FORMAT) 120 | 121 | 122 | if __name__ == '__main__': 123 | try: 124 | main() 125 | except KeyboardInterrupt: 126 | s = "\n\nReceived Ctrl-C or other break signal. Exiting.\n" 127 | sys.stderr.write(s) 128 | sys.exit(0) 129 | -------------------------------------------------------------------------------- /git2effort/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Copyright (C) 2015-2020 Gregorio Robles 4 | # 5 | # This program is free software; you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation; either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | # Authors: 19 | # Gregorio Robles 20 | # 21 | 22 | __import__('pkg_resources').declare_namespace(__name__) 23 | -------------------------------------------------------------------------------- /git2effort/_version.py: -------------------------------------------------------------------------------- 1 | # Versions compliant with PEP 440 https://www.python.org/dev/peps/pep-0440 2 | __version__ = "0.1.4" 3 | -------------------------------------------------------------------------------- /git2effort/effort.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Copyright (C) 2020 Gregorio Robles 4 | # 5 | # This program is free software; you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation; either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | # Authors: 19 | # Gregorio Robles 20 | # 21 | 22 | import logging 23 | import tabulate 24 | 25 | from collections import defaultdict, Counter 26 | from datetime import datetime, timezone 27 | from perceval.backends.core.git import Git 28 | 29 | from .merging import simplemerge 30 | 31 | import sys 32 | 33 | 34 | def author_counting(authorsdict, period_length, active_days): 35 | """Given an authordict, and the specified period_length, returns a list with the number commits in each period. 36 | 37 | :param authorsdict: dictionary of authors (key: (name, email); value: list of commit dates) 38 | 39 | :param period_length: Length of the time period (in months) 40 | 41 | :param active_days: Boolean value that determines if we count commits on a same day just once 42 | 43 | :returns: list of Counter collections, which counts commits grouped by periods. 44 | """ 45 | logging.info("Applying effort estimation model.") 46 | author_counters = [] 47 | commits_same_day = 0 48 | for author in authorsdict: 49 | commit_days = [] 50 | dates = [] 51 | for date in authorsdict[author]: 52 | # print(date.month, int(round((date.month)/12)+1)) 53 | if not active_days or (date.year, date.month, date.day) not in commit_days: 54 | commit_days.append((date.year, date.month, date.day)) 55 | period = int(round((date.month-1)/(period_length*2))+1) 56 | dates.append(str(date.year) + "." + str(period)) 57 | else: 58 | commits_same_day += 1 59 | author_counters.append(Counter(dates)) 60 | if active_days: 61 | logging.info("Number of same author commits on the same day: " + str(commits_same_day)) 62 | return author_counters 63 | 64 | def project_period_effort(author_counter, threshold, period_length): 65 | """Given an author counter object (a list of Counters with the commits by periods) and the threshold, returns a dictionary with the total effort (value) for each period (key). 66 | 67 | :param author_counter: list of Counter collections, which counts commits grouped by periods. 68 | 69 | :param threshold: Threshold value (in commits) to determine if a developers is full-time devoted to the project. 70 | 71 | :param period_length: Length of the time period (in months) 72 | 73 | :returns: a tuple with: 74 | a dictionary with the total effort (value) for each period (key) 75 | a dictionary with the number of full_time developers (value) for each period (key) 76 | a dictionary with the number of non_full_time developers (value) for each period (key) 77 | """ 78 | effort_periods = defaultdict(int) 79 | full_time_periods = defaultdict(int) 80 | non_full_time_periods = defaultdict(int) 81 | for counter in author_counter: 82 | for period in counter: 83 | effort = round(counter[period]/threshold * period_length, 2) 84 | if effort > period_length: # saturation 85 | effort = period_length 86 | full_time_periods[period] += 1 87 | else: 88 | non_full_time_periods[period] += 1 89 | # print(period, counter[period], effort) 90 | effort_periods[period] += effort 91 | return (effort_periods, full_time_periods, non_full_time_periods) 92 | 93 | def project_period_maxeffort(author_counter, period_length): 94 | """Given an author counter object (a list of Counters with the commits by periods), returns a dictionary with the maximum possible effort (value) for each period (key). 95 | 96 | :param author_counter: list of Counter collections, which counts commits grouped by periods. 97 | 98 | :param period_length: Length of the time period (in months) 99 | 100 | :returns: dictionary with the maximum possible effort (value) for each period (key). 101 | """ 102 | effort_periods = defaultdict(int) 103 | for counter in author_counter: 104 | for period in counter: 105 | effort_periods[period] += period_length 106 | return effort_periods 107 | 108 | def pretty_print_period(period_length, first_commit, headers, *argv): 109 | """Given a dictionary with values for periods (key), the first commit and the period length, returns a line to be printed. A preprended line with the header (the periods) can be added, if desired. 110 | 111 | :param period_length: Length of the time period (in months) 112 | 113 | :param first_commit: datetime object of first commit 114 | 115 | :param headers: TODO 116 | 117 | :param *argv: TODO 118 | 119 | :returns: string 120 | """ 121 | period_lists = [] 122 | for year in range(first_commit.year, datetime.now().year+1): 123 | for period in range(int(12/period_length)): 124 | period = str(year) + "." + str(period+1) 125 | sublist = [period] 126 | for d in argv: 127 | sublist += [d[period]] 128 | period_lists.append(sublist) 129 | # TODO: remove the previous periods to first commit and the last periods in the future 130 | return tabulate.tabulate(period_lists, headers=["Period"] + headers) 131 | 132 | def run(args): 133 | """ 134 | """ 135 | repo_url = args['git_repository'] 136 | period_length = args['period'] 137 | threshold = args['threshold'] 138 | active_days = True 139 | 140 | # directory for letting Perceval clone the git repo 141 | # TODO: this is Linux-operating system specific. Should change 142 | repo_dir = '/tmp/' + repo_url.split('/')[-1] + '.git' 143 | 144 | first_commit = datetime.now(timezone.utc) 145 | authorDict = defaultdict(list) 146 | 147 | repo = Git(uri=repo_url, gitpath=repo_dir) 148 | 149 | for commit in repo.fetch(): 150 | commitdate = datetime.strptime(commit['data']['AuthorDate'], '%a %b %d %H:%M:%S %Y %z') 151 | if commitdate < first_commit: 152 | first_commit = commitdate 153 | authorDict[commit['data']['Author']].append(commitdate) 154 | logging.info("Authors found: " + str(len(authorDict))) 155 | 156 | simplemerge(authorDict) 157 | logging.info("Authors after merge: " + str(len(authorDict))) 158 | 159 | author_count = author_counting(authorDict, period_length, active_days) 160 | # print(author_count) 161 | (effort_periods, full_time_periods, non_full_time_periods) = project_period_effort(author_count, threshold, period_length) 162 | maxeffort_periods = project_period_maxeffort(author_count, period_length) 163 | 164 | # Printing results 165 | print() 166 | print("CONFIGURATIONS:") 167 | print(" Length of period (in months):", period_length) 168 | print(" Threshold t (in commits in a period):", threshold) 169 | print() 170 | print("RESULTS:") 171 | print(" First commit date:", first_commit, "--", round((datetime.now(timezone.utc)-first_commit).days/30, 2) , "months ago") 172 | print(" Maximum possible development effort (in person-months):", sum(maxeffort_periods.values())) 173 | print() 174 | print(pretty_print_period(period_length, first_commit, ["FT", "Non-FT", "Effort"], full_time_periods, non_full_time_periods, effort_periods)) 175 | print(" " * 8, "FT: Full-time developers") 176 | print() 177 | print(" ---> Estimated development effort (in person-months):", round(sum(effort_periods.values()), 2)) 178 | print() 179 | print("For more information, visit http://github.com/gregoriorobles/git2effort") 180 | print() 181 | 182 | -------------------------------------------------------------------------------- /git2effort/merging.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Copyright (C) 2020 Gregorio Robles 4 | # 5 | # This program is free software; you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation; either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | # Authors: 19 | # Gregorio Robles 20 | # 21 | 22 | import logging 23 | 24 | 25 | def same(authors): 26 | """Given a list of author (name, email) duples, returns a list with those having the same name ore same e-mail. 27 | 28 | :param authors: list of authors (name, email) 29 | For instance: [("John Smith", "jsmith@gmail.com"), ("John Smith", a@b.com")] 30 | 31 | :returns: a list of lists with authors having the same name or the same email 32 | In the previous example, returns [("John Smith", "jsmith@gmail.com"), ("John Smith", a@b.com")] 33 | """ 34 | return_list = [] 35 | tmp_list = [] # This list will contain triples of author, name and email 36 | name_set = set() 37 | email_set = set() 38 | for author in authors: 39 | name, email = author.split('<') 40 | email.replace('>', '') 41 | # FIXME: This requires refactoring, as we have the same algorithm twice 42 | if name in name_set: 43 | for other_author, other_name, _ in tmp_list: 44 | if other_name == name: 45 | return_list.append([other_author, author]) 46 | logging.debug("Authors merged: " + str(other_author) + " " + str(author)) 47 | else: 48 | name_set.add(name) 49 | if email in email_set: 50 | for other_author, _, other_email in tmp_list: 51 | if other_email == email: 52 | return_list.append([other_author, author]) 53 | logging.debug("Authors merged: " + str(other_author) + " " + str(author)) 54 | else: 55 | email_set.add(email) 56 | tmp_list.append([author, name, email]) 57 | return return_list 58 | 59 | def simplemerge(authorsdict): 60 | """Given an authordict 61 | key is the (name, email) tuple 62 | value is a list with all commit dates 63 | Returns an authordict but with authors with the same name or the same email merged. 64 | 65 | :param authorsdict: dictionary of authors (key: (name, email); value: list of commit dates) 66 | 67 | :returns: dictionary of authors (key: (name, email); value: list of commit dates); merged when name or email of other authors are the same 68 | """ 69 | logging.info("Looking for authors to merge.") 70 | same_authors = same(authorsdict.keys()) 71 | for match1, match2 in same_authors: 72 | authorsdict[match1] = authorsdict[match1] + authorsdict[match2] 73 | del(authorsdict[match2]) 74 | return authorsdict 75 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | tabulate>=0.8.7 2 | -e git+https://github.com/chaoss/grimoirelab-perceval/#egg=grimoirelab-perceval 3 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | 4 | [flake8] 5 | exclude = .git, .eggs, __pycache__, build, dist 6 | ignore = E129, E402, F841, C901, W504 7 | max-line-length = 90 8 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Copyright (C) 2020 Gregorio Robles 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | # Authors: 20 | # Gregorio Robles 21 | # 22 | 23 | import codecs 24 | import os.path 25 | import re 26 | import sys 27 | 28 | from setuptools import setup 29 | 30 | here = os.path.abspath(os.path.dirname(__file__)) 31 | readme_md = os.path.join(here, 'README.md') 32 | version_py = os.path.join(here, 'git2effort', '_version.py') 33 | 34 | # Get the package description from the README.md file 35 | with codecs.open(readme_md, encoding='utf-8') as f: 36 | long_description = f.read() 37 | 38 | with codecs.open(version_py, 'r', encoding='utf-8') as fd: 39 | version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', 40 | fd.read(), re.MULTILINE).group(1) 41 | 42 | setup(name="git2effort", 43 | description="Calculate development effort from a Git repository", 44 | long_description=long_description, 45 | long_description_content_type='text/markdown', 46 | url="https://github.com/gregoriorobles/git2effort", 47 | version=version, 48 | author="Gregorio Robles", 49 | author_email="grex@gsyc.urjc.es", 50 | license="GPLv3", 51 | classifiers=[ 52 | 'Development Status :: 2 - Pre-Alpha', 53 | 'Environment :: Console', 54 | 'Intended Audience :: Developers', 55 | 'Intended Audience :: Science/Research', 56 | 'Topic :: Software Development', 57 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 58 | 'Programming Language :: Python :: 3' 59 | ], 60 | keywords="effort development repositories analytics git github", 61 | packages=[ 62 | 'git2effort', 63 | ], 64 | namespace_packages=[ 65 | 'git2effort' 66 | ], 67 | setup_requires=[ 68 | 'wheel' 69 | ], 70 | install_requires=[ 71 | 'perceval>=0.12', 72 | 'tabulate>=0.8.7' 73 | ], 74 | scripts=[ 75 | 'bin/git2effort' 76 | ], 77 | zip_safe=False) 78 | --------------------------------------------------------------------------------