├── .gitignore ├── .travis.yml ├── CHANGELOG.txt ├── LICENSE ├── MANIFEST.in ├── Makefile ├── README.rst ├── coverage.rc ├── gitcheck ├── __init__.py └── gitcheck.py ├── mygitcheck.py.sample ├── pep8.rc ├── requirements ├── base.txt └── test.txt ├── setup.py └── tests.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .gitignore support plugin (hsz.mobi) 2 | ### Python template 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | env/ 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | downloads/ 17 | eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | 45 | # Translations 46 | *.mo 47 | *.pot 48 | 49 | # Django stuff: 50 | *.log 51 | 52 | # Sphinx documentation 53 | docs/_build/ 54 | 55 | # PyBuilder 56 | target/ 57 | 58 | # PyCharm/IDEA files 59 | .idea 60 | *.iml 61 | 62 | # Virtualenvs 63 | venv/ 64 | pyvenv/ -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | python: 4 | - "2.7" 5 | 6 | install: 7 | - pip install . 8 | - pip install -r requirements/test.txt 9 | 10 | script: 11 | - make test 12 | 13 | after_success: 14 | - coveralls -------------------------------------------------------------------------------- /CHANGELOG.txt: -------------------------------------------------------------------------------- 1 | Changelog 2 | ========= 3 | 4 | Version 0.3.22 (2015-05-05) 5 | -------------------------- 6 | * Check git repositories from an docker container 7 | * Fix PEP8 coding style 8 | * Add travis CI unit intégration test 9 | * First unittest implementation 10 | * Update the setup.py package 11 | 12 | Version 0.3.21 (2015-03-15) 13 | -------------------------- 14 | * Verbose mode when sending an email 15 | * Replaced configobj parameters by a simple JSON file 16 | * Add a global variables 17 | * Add a debug mode for issue 18 | * Add Python 3 support 19 | * Added -u flag for untracked files to be inclused in the 'to commit' 20 | * Find current branch even if it's not at the top of the list 21 | * Display repositories in alphabetical order 22 | * Show the name of the repository whose remotes are being updated 23 | * Highlight with magenta a repo that has no changes but doesn't have remote either 24 | * Fix failure on bare repositories 25 | 26 | 27 | 28 | Version 0.3.14 (2014-11-04) 29 | -------------------------- 30 | * changed the output to show the repository name instead of the absolute path 31 | * Add followlinks to find repository in symlinks 32 | * Fix whitespace errors 33 | * Fix error when repository path contains one or more spaces 34 | * Update the code for windows compatibility 35 | * Send an email with HTML report 36 | 37 | 38 | Version 0.3 (2014-01-15) 39 | -------------------------- 40 | 41 | * Add and delete status 42 | * Only show updated state 43 | * Ignore untracked file 44 | * First version with check remote status 45 | * Show who files not pushed in remote repository 46 | * Add support pull check 47 | * Add the possibility to ignore branches based on a regex 48 | * Show pull needed 49 | * Add a watch mode and bell on push/pull needed 50 | * Added functionality for selecting dir to check 51 | 52 | 53 | Version 0.0.1 (2013-04-16) 54 | -------------------------- 55 | 56 | * First version 57 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 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 | {project} Copyright (C) {year} {fullname} 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.rst 2 | include LICENSE 3 | include CHANGELOG.txt 4 | include tests.py -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BASEDIR=$(CURDIR) 2 | DISTDIR=$(BASEDIR)/dist 3 | BUILDDIR=$(BASEDIR)/build 4 | PACKAGE='gitcheck' 5 | 6 | test: pep8 coverage 7 | 8 | build: 9 | @echo 'Running build' 10 | @python setup.py build 11 | 12 | deploy: 13 | @echo 'Upload to PyPi' 14 | @python setup.py sdist upload 15 | @echo 'Done' 16 | 17 | dist: 18 | @echo 'Generating a distributable python package' 19 | @python setup.py sdist 20 | @echo 'Done' 21 | 22 | install: 23 | @echo 'Running install' 24 | @python setup.py install 25 | 26 | 27 | pep8: 28 | @pep8 $(PACKAGE) --config=pep8.rc 29 | @echo 'PEP8: OK' 30 | 31 | coverage: 32 | @echo 'Running test suite with coverage' 33 | @coverage erase 34 | @coverage run --rcfile=coverage.rc tests.py 35 | @coverage html 36 | @coverage report --rcfile=coverage.rc 37 | 38 | clean: 39 | @rm -fr $(DISTDIR) 40 | @rm -fr $(BUILDDIR) 41 | 42 | .PHONY: help doc build test dist install clean 43 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. image:: https://travis-ci.org/badele/gitcheck.svg?branch=unittest 2 | :target: https://travis-ci.org/badele/gitcheck 3 | 4 | 5 | gitcheck 6 | ======== 7 | 8 | When working simultaneously on several git repositories, it is easy to 9 | loose the overview on the advancement of your work. This is why I 10 | decided to write gitcheck, a tool which reports the status of the 11 | repositories it finds in a file tree. This report can of course be 12 | displayed on the terminal but also be sent by email. 13 | 14 | Now you can also check your host git from an docker container. See the docker section 15 | 16 | 17 | 18 | Installation 19 | ------------ 20 | 21 | :: 22 | 23 | pip install git+git://github.com/badele/gitcheck.git 24 | 25 | 26 | Examples 27 | -------- 28 | 29 | Simple report 30 | ~~~~~~~~~~~~~ 31 | 32 | In a simple invocation, gitcheck shows for each repository found in 33 | the file tree rooted at the current working directory if they have 34 | changes to be committed or commits to be pushed. 35 | 36 | .. code:: bash 37 | 38 | $ gitcheck.py 39 | 40 | .. figure:: http://bruno.adele.im/static/gitcheck.png 41 | :alt: Gitcheck simple report 42 | 43 | Gitcheck simple report 44 | 45 | Detailed report 46 | ~~~~~~~~~~~~~~~ 47 | 48 | This invocation is substantially identical to the previous one, but 49 | the generated report also enumerates modified files and pending 50 | commits. 51 | 52 | .. code:: bash 53 | 54 | $ gitcheck.py -v 55 | 56 | .. figure:: http://bruno.adele.im/static/gitcheck_verbose_v2.png 57 | :alt: Gitcheck detailed report 58 | 59 | Gitcheck detailed report 60 | 61 | Gitcheck customization 62 | ~~~~~~~~~~~~~~~~~~~~~~ 63 | 64 | You can customize the output color, the gitcheck try to find `~/mygitcheck.py` 65 | if it found, it is imported, see the `mygitcheck.py.sample` 66 | 67 | 68 | Docker container 69 | ~~~~~~~~~~~~~~~ 70 | 71 | You can check your git repositories from an docker container (from your host) 72 | 73 | From the host, you can use this command 74 | 75 | .. code:: bash 76 | 77 | $ docker run --rm -v `pwd`:/files:ro badele/alpine-gitcheck 78 | 79 | or 80 | 81 | .. code:: bash 82 | 83 | $ docker run --rm -v `pwd`:/files:ro badele/alpine-gitcheck cd /files && gitcheck OPTIONS 84 | 85 | You can also create a shell function into the host, exemple for ZSH 86 | 87 | .. code:: bash 88 | 89 | gitcheck (){ 90 | docker run --rm -v `pwd`:/files:ro badele/alpine-gitcheck 91 | } 92 | # 93 | $ gitcheck 94 | 95 | More info about the gitcheck container https://registry.hub.docker.com/u/badele/alpine-gitcheck/ 96 | 97 | 98 | Options 99 | ~~~~~~~ 100 | 101 | .. code:: plaintext 102 | 103 | -v, --verbose Show files & commits 104 | --debug Show debug message 105 | -r, --remote force remote update(slow) 106 | -u, --untracked Show untracked files 107 | -b, --bell bell on action needed 108 | -w , --watch= after displaying, wait and run again 109 | -i , --ignore-branch= ignore branches matching the regex 110 | -d , --dir= Search for repositories 111 | -m , --maxdepth= Limit the depth of repositories search 112 | -q, --quiet Display info only when repository needs action 113 | -e, --email Send an email with result as html, using mail.properties parameters 114 | --init-email Initialize mail.properties file (has to be modified by user using JSON Format) 115 | 116 | French version 117 | ~~~~~~~~~~~~~~ 118 | 119 | A French version of this document is available here: 120 | http://bruno.adele.im/projets/gitcheck/ 121 | -------------------------------------------------------------------------------- /coverage.rc: -------------------------------------------------------------------------------- 1 | # coverage.rc to control coverage.py 2 | [run] 3 | omit = /usr/share/* 4 | 5 | [report] 6 | # Regexes for lines to exclude from consideration 7 | exclude_lines = 8 | # Have to re-enable the standard pragma 9 | pragma: no cover 10 | 11 | # Don't complain about missing debug-only code: 12 | def __repr__ 13 | if self\.debug 14 | 15 | # Don't complain if tests don't hit defensive assertion code: 16 | raise AssertionError 17 | raise NotImplementedError 18 | 19 | # Don't complain if non-runnable code isn't run: 20 | if 0: 21 | if __name__ == .__main__.: 22 | 23 | ignore_errors = True 24 | 25 | -------------------------------------------------------------------------------- /gitcheck/__init__.py: -------------------------------------------------------------------------------- 1 | __author__ = 'badele' 2 | -------------------------------------------------------------------------------- /gitcheck/gitcheck.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | from __future__ import unicode_literals, absolute_import, division, print_function 4 | 5 | import os 6 | import re 7 | import sys 8 | import getopt 9 | import time 10 | import subprocess 11 | from subprocess import PIPE 12 | import smtplib 13 | from smtplib import SMTPException 14 | from email.mime.multipart import MIMEMultipart 15 | from email.mime.text import MIMEText 16 | import shlex 17 | 18 | from os.path import expanduser 19 | from time import strftime 20 | 21 | import json 22 | 23 | from colored import fg, bg, attr 24 | 25 | # Global vars 26 | argopts = {} 27 | colortheme = None 28 | #Load custom parameters from ~/mygitcheck.py 29 | configfile = expanduser('~/mygitcheck.py') 30 | if os.path.exists(configfile): 31 | sys.path.append(expanduser('~')) 32 | import mygitcheck as userconf 33 | 34 | # Try to load colortheme 35 | if hasattr(userconf, 'colortheme'): 36 | colortheme = userconf.colortheme 37 | if colortheme is None: 38 | # Default theme 39 | defaultcolor = attr('reset') + fg('white') 40 | colortheme = { 41 | 'default': defaultcolor, 42 | 'prjchanged': attr('reset') + attr('bold') + fg('deep_pink_1a'), 43 | 'prjremote': attr('reverse') + fg('light_cyan'), 44 | 'prjname': attr('reset') + fg('chartreuse_1'), 45 | 'reponame': attr('reset') + fg('light_goldenrod_2b'), 46 | 'branchname': defaultcolor, 47 | 'fileupdated': attr('reset') + fg('light_goldenrod_2b'), 48 | 'remoteto': attr('reset') + fg('deep_sky_blue_3b'), 49 | 'committo': attr('reset') + fg('violet'), 50 | 'commitinfo': attr('reset') + fg('deep_sky_blue_3b'), 51 | 'commitstate': attr('reset') + fg('deep_pink_1a'), 52 | 'bell': "\a", 53 | 'reset': "\033[2J\033[H" 54 | } 55 | 56 | 57 | class html: 58 | msg = "
    \n" 59 | topull = "" 60 | topush = "" 61 | strlocal = "" 62 | prjname = "" 63 | path = "" 64 | timestamp = "" 65 | 66 | 67 | def showDebug(mess, level='info'): 68 | if argopts.get('debugmod', False): 69 | print(mess) 70 | 71 | 72 | # Search all local repositories from current directory 73 | def searchRepositories(): 74 | showDebug('Beginning scan... building list of git folders') 75 | dirs = argopts.get('searchDir', [os.path.abspath(os.getcwd())]) 76 | repo = set() 77 | for curdir in dirs: 78 | if curdir[-1:] == '/': 79 | curdir = curdir[:-1] 80 | showDebug(" Scan git repositories from %s" % curdir) 81 | 82 | html.path = curdir 83 | startinglevel = curdir.count(os.sep) 84 | 85 | for directory, dirnames, filenames in os.walk(curdir): 86 | level = directory.count(os.sep) - startinglevel 87 | if argopts.get('depth', None) is None or level <= argopts.get('depth', None): 88 | if '.git' in dirnames: 89 | showDebug(" Add %s repository" % directory) 90 | repo.add(directory) 91 | 92 | showDebug('Done') 93 | return sorted(repo) 94 | 95 | 96 | # Check state of a git repository 97 | def checkRepository(rep, branch): 98 | aitem = [] 99 | mitem = [] 100 | ditem = [] 101 | gsearch = re.compile(r'^.?([A-Z]) (.*)') 102 | 103 | if re.match(argopts.get('ignoreBranch', r'^$'), branch): 104 | return False 105 | 106 | changes = getLocalFilesChange(rep) 107 | ischange = len(changes) > 0 108 | actionNeeded = False # actionNeeded is branch push/pull, not local file change. 109 | 110 | topush = "" 111 | topull = "" 112 | html.topush = "" 113 | html.topull = "" 114 | if branch != "": 115 | remotes = getRemoteRepositories(rep) 116 | hasremotes = bool(remotes) 117 | for r in remotes: 118 | count = len(getLocalToPush(rep, r, branch)) 119 | ischange = ischange or (count > 0) 120 | actionNeeded = actionNeeded or (count > 0) 121 | if count > 0: 122 | topush += " %s%s%s[%sTo Push:%s%s]" % ( 123 | colortheme['reponame'], 124 | r, 125 | colortheme['default'], 126 | colortheme['remoteto'], 127 | colortheme['default'], 128 | count 129 | ) 130 | html.topush += '%s[To Push:%s]' % ( 131 | r, 132 | count 133 | ) 134 | 135 | for r in remotes: 136 | count = len(getRemoteToPull(rep, r, branch)) 137 | ischange = ischange or (count > 0) 138 | actionNeeded = actionNeeded or (count > 0) 139 | if count > 0: 140 | topull += " %s%s%s[%sTo Pull:%s%s]" % ( 141 | colortheme['reponame'], 142 | r, 143 | colortheme['default'], 144 | colortheme['remoteto'], 145 | colortheme['default'], 146 | count 147 | ) 148 | html.topull += '%s[To Pull:%s]' % ( 149 | r, 150 | count 151 | ) 152 | if ischange or not argopts.get('quiet', False): 153 | # Remove trailing slash from repository/directory name 154 | if rep[-1:] == '/': 155 | rep = rep[:-1] 156 | 157 | # Do some magic to not show the absolute path as repository name 158 | # Case 1: script was started in a directory that is a git repo 159 | if rep == os.path.abspath(os.getcwd()): 160 | (head, tail) = os.path.split(rep) 161 | if tail != '': 162 | repname = tail 163 | # Case 2: script was started in a directory with possible subdirs that contain git repos 164 | elif rep.find(os.path.abspath(os.getcwd())) == 0: 165 | repname = rep[len(os.path.abspath(os.getcwd())) + 1:] 166 | # Case 3: script was started with -d and above cases do not apply 167 | else: 168 | repname = rep 169 | 170 | if ischange: 171 | prjname = "%s%s%s" % (colortheme['prjchanged'], repname, colortheme['default']) 172 | html.prjname = '%s' % (repname) 173 | elif not hasremotes: 174 | prjname = "%s%s%s" % (colortheme['prjremote'], repname, colortheme['default']) 175 | html.prjname = '%s' % (repname) 176 | else: 177 | prjname = "%s%s%s" % (colortheme['prjname'], repname, colortheme['default']) 178 | html.prjname = '%s' % (repname) 179 | 180 | # Print result 181 | if len(changes) > 0: 182 | strlocal = "%sLocal%s[" % (colortheme['reponame'], colortheme['default']) 183 | lenFilesChnaged = len(getLocalFilesChange(rep)) 184 | strlocal += "%sTo Commit:%s%s" % ( 185 | colortheme['remoteto'], 186 | colortheme['default'], 187 | lenFilesChnaged 188 | ) 189 | html.strlocal = ' Local[' 190 | html.strlocal += "To Commit:%s" % ( 191 | lenFilesChnaged 192 | ) 193 | strlocal += "]" 194 | html.strlocal += "]" 195 | else: 196 | strlocal = "" 197 | html.strlocal = "" 198 | 199 | if argopts.get('email', False): 200 | html.msg += "
  • %s/%s %s %s %s
    • \n" % (html.prjname, branch, html.strlocal, html.topush, html.topull) 201 | 202 | else: 203 | cbranch = "%s%s" % (colortheme['branchname'], branch) 204 | print("%(prjname)s/%(cbranch)s %(strlocal)s%(topush)s%(topull)s" % locals()) 205 | 206 | if argopts.get('verbose', False): 207 | if ischange > 0: 208 | filename = " |--Local" 209 | if not argopts.get('email', False): 210 | print(filename) 211 | html.msg += '
    • Local
    \n
      \n' 212 | for c in changes: 213 | filename = " |--%s%s%s %s%s" % ( 214 | colortheme['commitstate'], 215 | c[0], 216 | colortheme['fileupdated'], 217 | c[1], 218 | colortheme['default']) 219 | html.msg += '
    • [To Commit] %s
      • \n' % c[1] 220 | if not argopts.get('email', False): print(filename) 221 | html.msg += '
    \n' 222 | if branch != "": 223 | remotes = getRemoteRepositories(rep) 224 | for r in remotes: 225 | commits = getLocalToPush(rep, r, branch) 226 | if len(commits) > 0: 227 | rname = " |--%(r)s" % locals() 228 | html.msg += '
    • %(r)s
      • \n
    \n
      \n' % locals() 229 | if not argopts.get('email', False): print(rname) 230 | for commit in commits: 231 | pcommit = " |--%s[To Push]%s %s%s%s" % ( 232 | colortheme['committo'], 233 | colortheme['default'], 234 | colortheme['commitinfo'], 235 | commit, 236 | colortheme['default']) 237 | html.msg += '
    • [To Push] %s
      • \n' % commit 238 | if not argopts.get('email', False): print(pcommit) 239 | html.msg += '
    \n' 240 | 241 | if branch != "": 242 | remotes = getRemoteRepositories(rep) 243 | for r in remotes: 244 | commits = getRemoteToPull(rep, r, branch) 245 | if len(commits) > 0: 246 | rname = " |--%(r)s" % locals() 247 | html.msg += '
    • %(r)s
      • \n
    \n
      \n' % locals() 248 | if not argopts.get('email', False): print(rname) 249 | for commit in commits: 250 | pcommit = " |--%s[To Pull]%s %s%s%s" % ( 251 | colortheme['committo'], 252 | colortheme['default'], 253 | colortheme['commitinfo'], 254 | commit, 255 | colortheme['default']) 256 | html.msg += '
    • [To Pull] %s
      • \n' % commit 257 | if not argopts.get('email', False): print(pcommit) 258 | html.msg += '
    \n' 259 | 260 | return actionNeeded 261 | 262 | 263 | def getLocalFilesChange(rep): 264 | files = [] 265 | #curdir = os.path.abspath(os.getcwd()) 266 | snbchange = re.compile(r'^(.{2}) (.*)') 267 | onlyTrackedArg = "" if argopts.get('checkUntracked', False) else "uno" 268 | result = gitExec(rep, "status -s" + onlyTrackedArg) 269 | 270 | lines = result.split('\n') 271 | for l in lines: 272 | if not re.match(argopts.get('ignoreLocal', r'^$'), l): 273 | m = snbchange.match(l) 274 | if m: 275 | files.append([m.group(1), m.group(2)]) 276 | 277 | return files 278 | 279 | 280 | def hasRemoteBranch(rep, remote, branch): 281 | result = gitExec(rep, 'branch -r') 282 | return '%s/%s' % (remote, branch) in result 283 | 284 | 285 | def getLocalToPush(rep, remote, branch): 286 | if not hasRemoteBranch(rep, remote, branch): 287 | return [] 288 | result = gitExec(rep, "log %(remote)s/%(branch)s..%(branch)s --oneline" 289 | % locals()) 290 | 291 | return [x for x in result.split('\n') if x] 292 | 293 | 294 | def getRemoteToPull(rep, remote, branch): 295 | if not hasRemoteBranch(rep, remote, branch): 296 | return [] 297 | result = gitExec(rep, "log %(branch)s..%(remote)s/%(branch)s --oneline" 298 | % locals()) 299 | 300 | return [x for x in result.split('\n') if x] 301 | 302 | 303 | def updateRemote(rep): 304 | gitExec(rep, "remote update") 305 | 306 | 307 | # Get Default branch for repository 308 | def getDefaultBranch(rep): 309 | sbranch = re.compile(r'^\* (.*)', flags=re.MULTILINE) 310 | gitbranch = gitExec(rep, "branch" 311 | % locals()) 312 | 313 | branch = "" 314 | m = sbranch.search(gitbranch) 315 | if m: 316 | branch = m.group(1) 317 | 318 | return {branch} 319 | 320 | 321 | # Get all branches for repository 322 | def getAllBranches(rep): 323 | gitbranch = gitExec(rep, "branch" 324 | % locals()) 325 | 326 | branch = gitbranch.splitlines() 327 | 328 | return [b[2:] for b in branch] 329 | 330 | 331 | def getRemoteRepositories(rep): 332 | result = gitExec(rep, "remote" 333 | % locals()) 334 | 335 | remotes = [x for x in result.split('\n') if x] 336 | return remotes 337 | 338 | 339 | def gitExec(path, cmd): 340 | commandToExecute = "git -C \"%s\" %s" % (path, cmd) 341 | cmdargs = shlex.split(commandToExecute) 342 | showDebug("EXECUTE GIT COMMAND '%s'" % cmdargs) 343 | p = subprocess.Popen(cmdargs, stdout=PIPE, stderr=PIPE) 344 | output, errors = p.communicate() 345 | if p.returncode: 346 | print('Failed running %s' % commandToExecute) 347 | raise Exception(errors) 348 | return output.decode('utf-8') 349 | 350 | 351 | # Check all git repositories 352 | def gitcheck(): 353 | showDebug("Global Vars: %s" % argopts) 354 | 355 | repo = searchRepositories() 356 | actionNeeded = False 357 | 358 | if argopts.get('checkremote', False): 359 | for r in repo: 360 | print ("Updating %s remotes..." % r) 361 | updateRemote(r) 362 | 363 | if argopts.get('watchInterval', 0) > 0: 364 | print(colortheme['reset']) 365 | print(strftime("%Y-%m-%d %H:%M:%S")) 366 | 367 | showDebug("Processing repositories... please wait.") 368 | for r in repo: 369 | if (argopts.get('checkall', False)): 370 | branch = getAllBranches(r) 371 | else: 372 | branch = getDefaultBranch(r) 373 | for b in branch: 374 | if checkRepository(r, b): 375 | actionNeeded = True 376 | html.timestamp = strftime("%Y-%m-%d %H:%M:%S") 377 | html.msg += "
\n

Report created on %s

\n" % html.timestamp 378 | 379 | if actionNeeded and argopts.get('bellOnActionNeeded', False): 380 | print(colortheme['bell']) 381 | 382 | 383 | def sendReport(content): 384 | userPath = expanduser('~') 385 | filepath = r'%s\Documents\.gitcheck' % userPath 386 | filename = filepath + "//mail.properties" 387 | config = json.load(open(filename)) 388 | 389 | # Create message container - the correct MIME type is multipart/alternative. 390 | msg = MIMEMultipart('alternative') 391 | msg['Subject'] = "Gitcheck Report (%s)" % (html.path) 392 | msg['From'] = config['from'] 393 | msg['To'] = config['to'] 394 | 395 | # Create the body of the message (a plain-text and an HTML version). 396 | text = "Gitcheck report for %s created on %s\n\n This file can be seen in html only." % (html.path, html.timestamp) 397 | htmlcontent = "\n\n

Gitcheck Report

\n

%s

\n\n\n

%s

\n\n" % ( 398 | html.path, content 399 | ) 400 | # Write html file to disk 401 | f = open(filepath + '//result.html', 'w') 402 | f.write(htmlcontent) 403 | print ("File saved under %s\\result.html" % filepath) 404 | # Record the MIME types of both parts - text/plain and text/html. 405 | part1 = MIMEText(text, 'plain') 406 | part2 = MIMEText(htmlcontent, 'html') 407 | 408 | # Attach parts into message container. 409 | # According to RFC 2046, the last part of a multipart message, in this case 410 | # the HTML message, is best and preferred. 411 | msg.attach(part1) 412 | msg.attach(part2) 413 | try: 414 | print ("Sending email to %s" % config['to']) 415 | # Send the message via local SMTP server. 416 | s = smtplib.SMTP(config['smtp'], config['smtp_port']) 417 | # sendmail function takes 3 arguments: sender's address, recipient's address 418 | # and message to send - here it is sent as one string. 419 | s.sendmail(config['from'], config['to'], msg.as_string()) 420 | s.quit() 421 | except SMTPException as e: 422 | print("Error sending email : %s" % str(e)) 423 | 424 | 425 | def initEmailConfig(): 426 | 427 | config = { 428 | 'smtp': 'yourserver', 429 | 'smtp_port': 25, 430 | 'from': 'from@server.com', 431 | 'to': 'to@server.com' 432 | } 433 | userPath = expanduser('~') 434 | saveFilePath = r'%s\Documents\.gitcheck' % userPath 435 | if not os.path.exists(saveFilePath): 436 | os.makedirs(saveFilePath) 437 | filename = saveFilePath + '\mail.properties' 438 | json.dump(config, fp=open(filename, 'w'), indent=4) 439 | print('Please, modify config file located here : %s' % filename) 440 | 441 | 442 | def readDefaultConfig(): 443 | filename = expanduser('~/.gitcheck') 444 | if os.path.exists(filename): 445 | pass 446 | 447 | 448 | def usage(): 449 | print("Usage: %s [OPTIONS]" % (sys.argv[0])) 450 | print("Check multiple git repository in one pass") 451 | print("== Common options ==") 452 | print(" -v, --verbose Show files & commits") 453 | print(" --debug Show debug message") 454 | print(" -r, --remote force remote update (slow)") 455 | print(" -u, --untracked Show untracked files") 456 | print(" -b, --bell bell on action needed") 457 | print(" -w , --watch= after displaying, wait and run again") 458 | print(" -i , --ignore-branch= ignore branches matching the regex ") 459 | print(" -d , --dir= Search for repositories (can be used multiple times)") 460 | print(" -m , --maxdepth= Limit the depth of repositories search") 461 | print(" -q, --quiet Display info only when repository needs action") 462 | print(" -e, --email Send an email with result as html, using mail.properties parameters") 463 | print(" -a, --all-branch Show the status of all branches") 464 | print(" -l , --localignore= ignore changes in local files which match the regex ") 465 | print(" --init-email Initialize mail.properties file (has to be modified by user using JSON Format)") 466 | 467 | 468 | def main(): 469 | try: 470 | opts, args = getopt.getopt( 471 | sys.argv[1:], 472 | "vhrubw:i:d:m:q:e:al:", 473 | [ 474 | "verbose", "debug", "help", "remote", "untracked", "bell", "watch=", "ignore-branch=", 475 | "dir=", "maxdepth=", "quiet", "email", "init-email", "all-branch", "localignore=" 476 | ] 477 | ) 478 | except getopt.GetoptError as e: 479 | if e.opt == 'w' and 'requires argument' in e.msg: 480 | print("Please indicate nb seconds for refresh ex: gitcheck -w10") 481 | else: 482 | print(e.msg) 483 | sys.exit(2) 484 | 485 | readDefaultConfig() 486 | for opt, arg in opts: 487 | if opt in ["-v", "--verbose"]: 488 | argopts['verbose'] = True 489 | elif opt in ["--debug"]: 490 | argopts['debugmod'] = True 491 | elif opt in ["-r", "--remote"]: 492 | argopts['checkremote'] = True 493 | elif opt in ["-u", "--untracked"]: 494 | argopts['checkUntracked'] = True 495 | elif opt in ["-b", "--bell"]: 496 | argopts['bellOnActionNeeded'] = True 497 | elif opt in ["-w", "--watch"]: 498 | try: 499 | argopts['watchInterval'] = float(arg) 500 | except ValueError: 501 | print("option %s requires numeric value" % opt) 502 | sys.exit(2) 503 | elif opt in ["-i", "--ignore-branch"]: 504 | argopts['ignoreBranch'] = arg 505 | elif opt in ["-l", "--localignore"]: 506 | argopts['ignoreLocal'] = arg 507 | elif opt in ["-d", "--dir"]: 508 | dirs = argopts.get('searchDir', []) 509 | if (dirs == []): 510 | argopts['searchDir'] = dirs 511 | dirs.append(arg) 512 | elif opt in ["-m", '--maxdepth']: 513 | try: 514 | argopts['depth'] = int(arg) 515 | except ValueError: 516 | print("option %s requires int value" % opt) 517 | sys.exit(2) 518 | elif opt in ["-q", "--quiet"]: 519 | argopts['quiet'] = True 520 | elif opt in ["-e", "--email"]: 521 | argopts['email'] = True 522 | elif opt in ["-a", "--all-branch"]: 523 | argopts['checkall'] = True 524 | elif opt in ["--init-email"]: 525 | initEmailConfig() 526 | sys.exit(0) 527 | elif opt in ["-h", "--help"]: 528 | usage() 529 | sys.exit(0) 530 | # else: 531 | # print "Unhandled option %s" % opt 532 | # sys.exit(2) 533 | 534 | while True: 535 | try: 536 | gitcheck() 537 | 538 | if argopts.get('email', False): 539 | sendReport(html.msg) 540 | 541 | except (KeyboardInterrupt, SystemExit): 542 | raise 543 | except Exception as e: 544 | print ("Unexpected error:", str(e)) 545 | 546 | if argopts.get('watchInterval', 0) > 0: 547 | time.sleep(argopts.get('watchInterval', 0)) 548 | else: 549 | break 550 | 551 | if __name__ == "__main__": 552 | try: 553 | main() 554 | except KeyboardInterrupt: 555 | sys.exit(0) 556 | -------------------------------------------------------------------------------- /mygitcheck.py.sample: -------------------------------------------------------------------------------- 1 | from colored import fg, bg, attr 2 | from colored import colored as cobj 3 | 4 | # In developpement mode, for use 5 | # python ~/mygitcheck.py 6 | # python ~/mygitcheck.py | grep magenta 7 | 8 | defaultcolor = attr('reset') + fg('white') 9 | colortheme = { 10 | 'default': defaultcolor, 11 | 'prjchanged': attr('reset') + attr('bold') + fg('deep_pink_1a'), 12 | 'prjremote': attr('reverse') + fg('light_cyan'), 13 | 'prjname': attr('reset') + fg('chartreuse_1'), 14 | 'reponame': attr('reset') + fg('light_goldenrod_2b'), 15 | 'branchname': defaultcolor, 16 | 'fileupdated': attr('reset') + fg('light_goldenrod_2b'), 17 | 'remoteto': attr('reset') + fg('deep_sky_blue_3b'), 18 | 'committo': attr('reset') + fg('violet'), 19 | 'commitinfo': attr('reset') + fg('deep_sky_blue_3b'), 20 | 'commitstate': attr('reset') + fg('deep_pink_1a'), 21 | 'bell': "\a", 22 | 'reset': "\033[2J\033[H" 23 | } 24 | 25 | 26 | def searchKeyByValue(search): 27 | """Search keyname by value""" 28 | c = cobj(0) 29 | for key, value in c.paint.iteritems(): 30 | if value == str(search): 31 | return key 32 | 33 | def searchMaxColorName(): 34 | """Search Max length colorname""" 35 | c = cobj(0) 36 | maxi = 0 37 | for key, value in c.paint.iteritems(): 38 | lencolor = len(str(key)) 39 | maxi = max(lencolor, maxi) 40 | 41 | print "Lencolor: %s" % maxi 42 | 43 | if __name__ == "__main__": 44 | #searchMaxColorName() 45 | for idx in range(0, 255): 46 | print "%s%19s %s%s%s%s" % ( 47 | attr('reset') + fg(idx), 48 | searchKeyByValue(idx), 49 | 'Normal', 50 | attr('reset') + fg(idx) + attr('bold') + 'Bold', 51 | attr('reset') + fg(idx) + attr('underlined') + 'Underline', 52 | attr('reset') + fg(idx) + attr('reverse') + 'Reverse', 53 | ) -------------------------------------------------------------------------------- /pep8.rc: -------------------------------------------------------------------------------- 1 | [pep8] 2 | ignore = E401,E221,E701,E202 3 | max-line-length = 140 4 | 5 | -------------------------------------------------------------------------------- /requirements/base.txt: -------------------------------------------------------------------------------- 1 | colored==1.2.1 -------------------------------------------------------------------------------- /requirements/test.txt: -------------------------------------------------------------------------------- 1 | -r base.txt 2 | pep8==1.4.6 3 | coveralls==0.3 4 | gitpython==1.0.1 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | import re 5 | from setuptools import setup 6 | 7 | PYPI_RST_FILTERS = ( 8 | # Replace code-blocks 9 | (r'\.\.\s? code-block::\s*(\w|\+)+', '::'), 10 | # Replace image 11 | (r'\.\.\s? image::.*', ''), 12 | # Remove travis ci badge 13 | (r'.*travis-ci\.org/.*', ''), 14 | # Remove pypip.in badges 15 | (r'.*pypip\.in/.*', ''), 16 | (r'.*crate\.io/.*', ''), 17 | (r'.*coveralls\.io/.*', ''), 18 | ) 19 | 20 | 21 | def rst(filename): 22 | ''' 23 | Load rst file and sanitize it for PyPI. 24 | Remove unsupported github tags: 25 | - code-block directive 26 | - travis ci build badge 27 | ''' 28 | content = open(filename).read() 29 | for regex, replacement in PYPI_RST_FILTERS: 30 | content = re.sub(regex, replacement, content) 31 | return content 32 | 33 | 34 | setup( 35 | name='gitcheck', 36 | version='0.3.22', 37 | description='Check multiple git repository in one pass', 38 | long_description=rst('README.rst') + rst('CHANGELOG.txt'), 39 | classifiers=[ 40 | 'Development Status :: 5 - Production/Stable', 41 | 'Environment :: Console', 42 | 'Intended Audience :: Developers', 43 | 'License :: OSI Approved :: GNU General Public License (GPL)', 44 | 'Natural Language :: English', 45 | 'Operating System :: OS Independent', 46 | 'Programming Language :: Python', 47 | 'Programming Language :: Python :: 2', 48 | 'Programming Language :: Python :: 2.7', 49 | 'Programming Language :: Python :: 3', 50 | 'Programming Language :: Python :: 3.3', 51 | 'Programming Language :: Python :: 3.4', 52 | 'Programming Language :: Python :: Implementation :: CPython', 53 | 'Topic :: Software Development', 54 | 'Topic :: Software Development :: Version Control', 55 | 'Topic :: Utilities', 56 | ], 57 | author='Bruno Adele', 58 | author_email='bruno@adele.im', 59 | license='GPL', 60 | url='https://github.com/badele/gitcheck', 61 | setup_requires=[ 62 | 'gitpython', 63 | ], 64 | tests_require=[], 65 | test_suite='tests', 66 | py_modules=['gitcheck.gitcheck',], 67 | entry_points={ 68 | 'console_scripts': ['gitcheck = gitcheck.gitcheck:main'] 69 | } 70 | ) 71 | -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | __authors__ = 'Bruno Adelé ' 5 | __copyright__ = 'Copyright (C) 2015 Bruno Adelé' 6 | __description__ = """Unittest""" 7 | __license__ = 'GPLv3' 8 | 9 | import os 10 | import sys 11 | import shutil 12 | from cStringIO import StringIO 13 | 14 | import unittest 15 | import git 16 | 17 | from gitcheck import gitcheck 18 | 19 | GITROOT = '/tmp/gitcheck-unittest' 20 | 21 | 22 | def setUpModule(): 23 | # Get projects 24 | get_github_projects("gitcheck", "https://github.com/badele/gitcheck.git") 25 | get_github_projects("serialkiller", "https://github.com/badele/serialkiller.git") 26 | get_github_projects("fabrecipes", "https://github.com/badele/fabrecipes.git") 27 | 28 | 29 | def get_github_projects(projectname, projecturl): 30 | # Preparing the git directory 31 | gitdir = "%s/%s" % (GITROOT, projectname) 32 | 33 | if os.path.exists(gitdir): 34 | shutil.rmtree(gitdir) 35 | os.makedirs(gitdir) 36 | os.chdir(GITROOT) 37 | 38 | # Get a git projects 39 | print "Get git %s project" % projectname 40 | git.Git().clone(projecturl) 41 | 42 | 43 | class TestPackages(unittest.TestCase): 44 | def setUp(self): 45 | # Redirect stdout 46 | self.output = StringIO() 47 | self.saved_stdout = sys.stdout 48 | sys.stdout = self.output 49 | 50 | 51 | def tearDown(self): 52 | # Reset stdout 53 | self.output.close() 54 | sys.stdout = self.saved_stdout 55 | 56 | 57 | def test_searchRepositories(self): 58 | os.chdir(GITROOT) 59 | repos = gitcheck.searchRepositories() 60 | 61 | self.assertEqual(repos[0], '%s/fabrecipes' % GITROOT) 62 | self.assertEqual(repos[1], '%s/gitcheck' % GITROOT) 63 | self.assertEqual(repos[2], '%s/serialkiller' % GITROOT) 64 | 65 | def test_gitcheck(self): 66 | os.chdir(GITROOT) 67 | 68 | defaulttheme = "" 69 | gitcheck.colortheme = { 70 | 'default': defaulttheme, 71 | 'prjchanged': defaulttheme, 72 | 'prjremote': defaulttheme, 73 | 'prjname': defaulttheme, 74 | 'reponame': defaulttheme, 75 | 'branchname': defaulttheme, 76 | 'fileupdated': defaulttheme, 77 | 'remoteto': defaulttheme, 78 | 'committo': defaulttheme, 79 | 'commitinfo': defaulttheme, 80 | 'commitstate': defaulttheme, 81 | 'bell': defaulttheme, 82 | 'reset': defaulttheme, 83 | } 84 | 85 | gitcheck.gitcheck() 86 | 87 | output = sys.stdout.getvalue().strip() 88 | lines = output.split('\n') 89 | 90 | self.assertEqual(lines[0], 'fabrecipes/master ') 91 | self.assertEqual(lines[1], 'gitcheck/master ') 92 | self.assertEqual(lines[2], 'serialkiller/master') 93 | 94 | if __name__ == "__main__": 95 | unittest.main(verbosity=2) 96 | --------------------------------------------------------------------------------