├── .gitignore ├── .gitlab-ci.yml ├── LICENSE ├── MANIFESTS.in ├── README.md ├── config-example.yml ├── gitlab-project-export.py ├── gitlab-project-import.py ├── gitlab_export ├── __init__.py ├── config.py └── gitlab.py ├── requirements.txt └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | config.yaml 2 | # Byte-compiled / optimized / DLL files 3 | __pycache__/ 4 | *.py[cod] 5 | *$py.class 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | wheels/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | MANIFEST 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 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *.cover 46 | .hypothesis/ 47 | .pytest_cache/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | db.sqlite3 57 | 58 | # Flask stuff: 59 | instance/ 60 | .webassets-cache 61 | 62 | # Scrapy stuff: 63 | .scrapy 64 | 65 | # Sphinx documentation 66 | docs/_build/ 67 | 68 | # PyBuilder 69 | target/ 70 | 71 | # Jupyter Notebook 72 | .ipynb_checkpoints 73 | 74 | # pyenv 75 | .python-version 76 | 77 | # celery beat schedule file 78 | celerybeat-schedule 79 | 80 | # SageMath parsed files 81 | *.sage.py 82 | 83 | # Environments 84 | .env 85 | .venv 86 | env/ 87 | venv/ 88 | ENV/ 89 | env.bak/ 90 | venv.bak/ 91 | 92 | # Spyder project settings 93 | .spyderproject 94 | .spyproject 95 | 96 | # Rope project settings 97 | .ropeproject 98 | 99 | # mkdocs documentation 100 | /site 101 | 102 | # mypy 103 | .mypy_cache/ 104 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | .build_script: &build_job 2 | stage: build 3 | allow_failure: false 4 | only: 5 | - tags 6 | script: 7 | - pip install --upgrade setuptools wheel 8 | - python setup.py sdist bdist_wheel 9 | artifacts: 10 | paths: 11 | - dist/ 12 | 13 | stages: 14 | - build 15 | - publish 16 | 17 | build_python3: 18 | <<: *build_job 19 | image: python:3.6 20 | 21 | publish_package: 22 | stage: publish 23 | allow_failure: false 24 | only: 25 | - tags 26 | image: python:3.6 27 | script: 28 | - pip install --upgrade setuptools wheel twine 29 | - ls -l dist/* 30 | - twine upload dist/* 31 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /MANIFESTS.in: -------------------------------------------------------------------------------- 1 | include requirements.txt 2 | include config-example.yml 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gitlab-project-export 2 | 3 | Simple Python project for exporting gitlab projects with Export Project feature in GitLab API. 4 | 5 | Primarily useful for remote backup of projects in GitLab.com to private storage server. 6 | 7 | ## Breaking Changes 8 | 9 | ### 05-2020 10 | 11 | Code was modified to work with Python3, not longer compatible with Python2. 12 | 13 | ## Prerequisite 14 | 15 | * Configured Gitlab API Token, https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html 16 | 17 | ## Install 18 | 19 | Simply install via pip: 20 | 21 | `pip install gitlab-project-export` 22 | 23 | or 24 | 25 | `pip install git+https://github.com/rvojcik/gitlab-project-export` 26 | 27 | or clone the project and install manually: 28 | 29 | ```bash 30 | git clone https://github.com/rvojcik/gitlab-project-export 31 | cd gitlab-project-export/ 32 | sudo python3 setup.py install 33 | ``` 34 | 35 | or use it without installing to your environment (install only requirements): 36 | 37 | ```bash 38 | git clone https://github.com/rvojcik/gitlab-project-export 39 | cd gitlab-project-export/ 40 | pip install -f requirements.txt 41 | ``` 42 | 43 | ## Usage 44 | 45 | ```bash 46 | usage: gitlab-project-export.py [-h] [-c CONFIG] [-d] [-f] 47 | 48 | optional arguments: 49 | -h, --help show this help message and exit 50 | -c CONFIG config file 51 | -d Debug mode 52 | -f Force mode - overwrite backup file if exists 53 | -n Only print what would be done, without doing it 54 | ``` 55 | 56 | ```bash 57 | usage: gitlab-project-import.py [-h] [-c CONFIG] [-f FILEPATH] [-p PROJECT_PATH] [-d] 58 | 59 | optional arguments: 60 | -h, --help show this help message and exit 61 | -c CONFIG config file 62 | -f FILEPATH Path to gitlab exported project file 63 | -p PROJECT_PATH Project path 64 | -d Debug mode 65 | ``` 66 | 67 | Prepare and edit your config file 68 | 69 | `mv config-example.yml config.yml` 70 | 71 | Simply run the script with optional config parameter 72 | 73 | `./gitlab-project-export.py -c /path/to/config.yml` 74 | 75 | ## Configuration 76 | 77 | System uses simple yaml file as configuration. 78 | 79 | Example below 80 | 81 | ``` 82 | gitlab: - gitlab configuration 83 | access: 84 | gitlab_url: "https://gitlab.com" - GitLab url, official or your instance 85 | token: "MY_PERSONAL_SECRET_TOKEN" - personal access token 86 | projects: - list of projects to export 87 | - rvojcik/example-project 88 | 89 | backup: - backup configuration 90 | destination: "/data/backup" - base backup dir 91 | project_dirs: True - store projects in separate directories 92 | backup_name: "gitlab-com-{PROJECT_NAME}-{TIME}.tar.gz" - backup file template 93 | backup_time_format: "%Y%m%d" - TIME template, use whatever compatible with 94 | python datetime - date.strftime() 95 | retention_period: 3 - purge files in the destination older than the specified value (in days) 96 | ``` 97 | 98 | ### Backup use-case in cron 99 | 100 | Create cron file in `/etc/cron.d/gitlab-backup` 101 | 102 | With following content 103 | 104 | ```bash 105 | MAILTO=your_email@here.tld 106 | 107 | 0 1 * * * root /path/to/cloned-repo/gitlab-project-export.py -c /etc/gitlab-export/config.yml 108 | 109 | ``` 110 | 111 | ### Migration use-case 112 | 113 | First create two config files 114 | 115 | `config1.yml` for exporting our project from gitlab.com 116 | 117 | ``` 118 | gitlab: - gitlab configuration 119 | access: 120 | gitlab_url: "https://gitlab.com" - GitLab url, official or your instance 121 | token: "MY_PERSONAL_SECRET_TOKEN" - personal access token 122 | projects: - list of projects to export 123 | - rvojcik/project1 124 | - rvojcik/project2 125 | 126 | backup: - backup configuration 127 | destination: "/data/export-dir" - base backup dir 128 | backup_name: "gitlab-com-{PROJECT_NAME}-{TIME}.tar.gz" - backup file template 129 | backup_time_format: "%Y%m%d" - TIME template, use whatever compatible with 130 | python datetime - date.strftime() 131 | ``` 132 | 133 | and `config2.yml` where we need only gitlab access part for importing projects to private gitlab instance 134 | 135 | ``` 136 | gitlab: - gitlab configuration 137 | access: 138 | gitlab_url: "https://gitlab.privatedomain.tld" - GitLab url, official or your instance 139 | token: "MY_PERSONAL_SECRET_TOKEN" - personal access token 140 | ``` 141 | 142 | Now it's time to export our projects 143 | 144 | ```bash 145 | ./gitlab-project-export.py -c ./config1.yml -d 146 | ``` 147 | 148 | Your projects are now exported in `/data/export-dir` 149 | 150 | After that we use `gitlab-project-import.py` with `config2.yml` for importing into our pricate gitlab instance. 151 | 152 | ```bash 153 | ./gitlab-project-import.py -c ./config2.yml -f ./gitlab-com-rvojcik-project1-20181224.tar.gz -p "rvojcik/project1" 154 | ./gitlab-project-import.py -c ./config2.yml -f ./gitlab-com-rvojcik-project2-20181224.tar.gz -p "rvojcik/project2" 155 | ``` 156 | 157 | Done ;) 158 | -------------------------------------------------------------------------------- /config-example.yml: -------------------------------------------------------------------------------- 1 | # 2 | # Gitlab configuration 3 | # 4 | # It is possible to use globbing in project names 5 | # Example: 6 | # - group/* 7 | # - user/*/documentation 8 | gitlab: 9 | access: 10 | gitlab_url: "https://gitlab.com" 11 | token: "MY_PERSONAL_SECRET_TOKEN" 12 | # SSL verify 13 | # Corresponds to verify option in request doc: 14 | # https://2.python-requests.org/en/master/api/#requests.Session.merge_environment_settings 15 | # Can be boolean to control whether we verify the ssl server certificate or string in which case it must be a path to CA bundle 16 | # Default is True 17 | # If you set it to False, you will get urllib warnings. To supress them, set environment variable: 18 | # - export PYTHONWARNINGS="ignore:Unverified HTTPS request" 19 | ssl_verify: True 20 | projects: 21 | - rvojcik/example-project 22 | - rvojcik/group/* 23 | # Membership attribute used when searching for projects 24 | # If you want to export all projects from private gitlab instance 25 | # use False here. In big shared instances or gitlab.com, use True 26 | membership: True 27 | # Wait Between Exports 28 | # How many seconds to wait between projects to export. 29 | # This is due rate-limiting in gitlab.com 30 | # https://docs.gitlab.com/ee/user/project/settings/import_export.html#rate-limits 31 | # 32 | # If you break the limit, API responds with 429 for your IP address for a while. 33 | # 34 | # When you are using this in your private gitlab instance, you can set it to 0 35 | wait_between_exports: 303 36 | # Maximum Retries 37 | # Number of times to retry, if the export fails 38 | max_tries_number: 12 39 | # Whether to include archived projects 40 | include_archived: False 41 | # List of projects (or patterns) to exclude 42 | exclude_projects: 43 | - rvojcik/exclude-me 44 | - rvojcik/archived/* 45 | 46 | # 47 | # Backup configuration 48 | # 49 | backup: 50 | # Destination of the exports/backups 51 | destination: "/data/backup" 52 | 53 | # Create separate directory for every project 54 | project_dirs: False 55 | 56 | # Backup Name template 57 | # It is possible to use some placeholders in the name 58 | # {PROJECT_NAME} - Name of the project with full path 59 | # Path slashes are replaced with dashes. 60 | # Example: 61 | # rvojcik/project1 => rvojcik-project1 62 | # 63 | # {TIME} - Time of the export 64 | backup_name: "gitlab-com-{PROJECT_NAME}-{TIME}.tar.gz" 65 | 66 | # Time format template 67 | # Time is constructed by python strftime. 68 | # backup_time_format can be anything compatible with strftime 69 | # Blank spaces are replaced with underscores. 70 | # Example: 71 | # %Y%m%d %H%M => %Y%m%d_%H%M 72 | backup_time_format: "%Y%m%d" 73 | 74 | # Retention period (in days) 75 | # backup files older than this period will be deleted 76 | # retention_period can be any positive number 77 | # specify 0 if you want to skip the deletion 78 | retention_period: 0 79 | -------------------------------------------------------------------------------- /gitlab-project-export.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from __future__ import print_function 4 | import os 5 | import re 6 | import sys 7 | import time 8 | import argparse 9 | from datetime import datetime 10 | import requests 11 | from gitlab_export import config, gitlab 12 | 13 | # Find our libs 14 | sys.path.append(os.path.dirname(os.path.realpath(__file__))) 15 | 16 | 17 | return_code = 0 18 | 19 | if __name__ == '__main__': 20 | # Parsing arguments 21 | parser = argparse.ArgumentParser( 22 | description=""" 23 | GitLab Project Export is a 24 | small project using GitLab API for exporting whole gitlab 25 | project with wikis, issues etc. 26 | Good for migration or simple backup of your gitlab projects. 27 | """, 28 | epilog='Created by Robert Vojcik ') 29 | 30 | # Arguments 31 | parser.add_argument( 32 | '-c', dest='config', default='config.yaml', 33 | help='config file' 34 | ) 35 | parser.add_argument( 36 | '-d', dest='debug', default=False, action='store_const', 37 | const=True, help='Debug mode' 38 | ) 39 | parser.add_argument( 40 | '-f', dest='force', default=False, action='store_const', 41 | const=True, help='Force mode - overwrite backup file if exists' 42 | ) 43 | parser.add_argument( 44 | '-n', dest='noop', default=False, action='store_const', 45 | const=True, help='Only print what would be done, without doing it' 46 | ) 47 | 48 | args = parser.parse_args() 49 | 50 | if not os.path.isfile(args.config): 51 | print("Unable to find config file %s" % (args.config)) 52 | 53 | c = config.Config(args.config) 54 | token = c.config["gitlab"]["access"]["token"] 55 | gitlab_url = c.config["gitlab"]["access"]["gitlab_url"] 56 | ssl_verify = c.config["gitlab"]["access"]["ssl_verify"] 57 | 58 | # Check additional config 59 | wait_between_exports = c.config['gitlab'].get('wait_between_exports', 0) 60 | membership = c.config['gitlab'].get('membership', True) 61 | include_archived = c.config['gitlab'].get('include_archived', False) 62 | max_tries_number = c.config['gitlab'].get('max_tries_number', 12) 63 | retention_period = c.config['backup'].get('retention_period', 0) 64 | exclude_projects = c.config["gitlab"].get('exclude_projects', []) 65 | if not ((type(retention_period) == int or type(retention_period) == float) and (retention_period >= 0)): 66 | print("Invalid value for retention_period. ignoring") 67 | retention_period = 0 68 | 69 | # Init gitlab api object 70 | if args.debug: 71 | print("%s, token" % (gitlab_url)) 72 | gitlab = gitlab.Api(gitlab_url, token, ssl_verify) 73 | 74 | # Export each project 75 | export_projects = [] 76 | 77 | # Get All member projects from gitlab 78 | projects = gitlab.project_list(membership=str(membership), archived=str(include_archived)) 79 | if not projects: 80 | print("Unable to get projects for your account", file=sys.stderr) 81 | sys.exit(1) 82 | 83 | # Check projects against config 84 | # Create export_projects array 85 | for project_pattern in c.config["gitlab"]["projects"]: 86 | for gitlabProject in projects: 87 | if re.match(project_pattern, gitlabProject): 88 | export_projects.append(gitlabProject) 89 | 90 | # Remove any projects that are marked as excluded 91 | for ignored_project_pattern in exclude_projects: 92 | for gitlabProject in projects: 93 | if re.match(ignored_project_pattern, gitlabProject): 94 | if args.debug: 95 | print("Removing project '%s' from export (exclusion: '%s'): " % (str(gitlabProject), str(ignored_project_pattern))) 96 | export_projects.remove(gitlabProject) 97 | 98 | if args.debug: 99 | print("Projects to export: " + str(export_projects)) 100 | 101 | if args.noop: 102 | print("Not running actual export because of -n/--noop flag.") 103 | sys.exit(0) 104 | 105 | for project in export_projects: 106 | if args.debug: 107 | print("Exporting %s" % (project)) 108 | 109 | # Download project to our destination 110 | destination = c.config["backup"]["destination"] 111 | if c.config["backup"]["project_dirs"]: 112 | destination += "/" + project 113 | 114 | # Create directories 115 | if not os.path.isdir(destination): 116 | try: 117 | os.makedirs(destination) 118 | except Exception: 119 | print("Unable to create directories %s" % (destination), file=sys.stderr) 120 | sys.exit(1) 121 | 122 | if args.debug: 123 | print(" Destination %s" % (destination)) 124 | 125 | # Prepare actual date 126 | d = datetime.now() 127 | # File template from config 128 | file_tmpl = c.config["backup"]["backup_name"] 129 | # Projectname in dest_file 130 | dest_file = destination + "/" + file_tmpl.replace( 131 | "{PROJECT_NAME}", 132 | project.replace("/", "-") 133 | ) 134 | # Date in dest_file 135 | dest_file = dest_file.replace( 136 | "{TIME}", d.strftime(c.config["backup"]["backup_time_format"].replace(" ", "_"))) 137 | 138 | if args.debug: 139 | print(" Destination file %s" % (dest_file)) 140 | 141 | if os.path.isfile(dest_file): 142 | if not args.force: 143 | print("File %s already exists" % (dest_file), file=sys.stderr) 144 | return_code += 1 145 | continue 146 | else: 147 | print("File %s already exists - will be overwritten" % (dest_file)) 148 | os.remove(dest_file) 149 | 150 | # Purge old files, if applicable 151 | if retention_period > 0: 152 | if args.debug: 153 | print(" Purging files older than %.2f days in the folder %s" % (retention_period, destination)) 154 | 155 | now = time.time() 156 | for f in os.listdir(destination): 157 | if not f.endswith(".tar.gz"): 158 | continue 159 | 160 | f = os.path.join(destination, f) 161 | if os.path.isfile(f): 162 | if os.stat(f).st_mtime < now - (retention_period * 86400): 163 | if args.debug: 164 | print(" deleting backup %s" % (f)) 165 | os.remove(f) 166 | 167 | # Initiate export 168 | status = gitlab.project_export(project, max_tries_number) 169 | 170 | # Export successful 171 | if status: 172 | if args.debug: 173 | print("Success for %s" % (project)) 174 | # Get URL from gitlab object 175 | url = gitlab.download_url["api_url"] 176 | if args.debug: 177 | print(" URL: %s" % (url)) 178 | 179 | # Download file 180 | r = requests.get( 181 | url, 182 | allow_redirects=True, 183 | stream=True, 184 | verify=ssl_verify, 185 | headers={"PRIVATE-TOKEN": token}) 186 | 187 | if r.status_code >= 200 and r.status_code < 300: 188 | with open(dest_file, 'wb') as f: 189 | for chunk in r.iter_content(chunk_size=1024): 190 | if chunk: 191 | f.write(chunk) 192 | else: 193 | print( 194 | "Unable to download project %s. Got code %d: %s" % ( 195 | project, 196 | r.status_code, 197 | r.text), 198 | file=sys.stderr) 199 | return_code += 1 200 | 201 | else: 202 | # Export for project unsuccessful 203 | print("Export failed for project %s" % (project), file=sys.stderr) 204 | return_code += 1 205 | 206 | # If set, wait between exports 207 | if project != export_projects[-1]: 208 | if args.debug: 209 | print("Waiting between exports for %d seconds" % (wait_between_exports)) 210 | time.sleep(wait_between_exports) 211 | 212 | sys.exit(return_code) 213 | -------------------------------------------------------------------------------- /gitlab-project-import.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from __future__ import print_function 4 | import sys 5 | import os 6 | import argparse 7 | import yaml 8 | from datetime import date 9 | import requests 10 | # Find our libs 11 | sys.path.append(os.path.dirname(os.path.realpath(__file__))) 12 | from gitlab_export import config, gitlab 13 | 14 | 15 | return_code = 0 16 | 17 | if __name__ == '__main__': 18 | # Parsing arguments 19 | parser = argparse.ArgumentParser( 20 | description=""" 21 | GitLab Project Import is 22 | small project using Gitlab API for exporting whole gitlab 23 | project with wikis, issues etc. 24 | Good for migration or simple backup your gitlab projects. 25 | """, 26 | epilog='Created by Robert Vojcik ') 27 | 28 | # Arguments 29 | parser.add_argument( 30 | '-c', dest='config', default='config.yaml', 31 | help='config file') 32 | parser.add_argument( 33 | '-f', dest='filepath', default=False, 34 | help='Path to gitlab exported project file') 35 | parser.add_argument( 36 | '-p', dest='project_path', default=False, 37 | help='Project path') 38 | parser.add_argument( 39 | '-d', dest='debug', default=False, action='store_const', const=True, 40 | help='Debug mode') 41 | 42 | args = parser.parse_args() 43 | 44 | if not os.path.isfile(args.config): 45 | print("Unable to find config file %s" % (args.config)) 46 | 47 | c = config.Config(args.config) 48 | token = c.config["gitlab"]["access"]["token"] 49 | gitlab_url = c.config["gitlab"]["access"]["gitlab_url"] 50 | ssl_verify = c.config["gitlab"]["access"]["ssl_verify"] 51 | 52 | # Init gitlab api object 53 | if args.debug: 54 | print("%s, token" % (gitlab_url)) 55 | gitlab = gitlab.Api(gitlab_url, token, ssl_verify) 56 | 57 | # import project 58 | if args.project_path and args.filepath and os.path.isfile(args.filepath): 59 | if args.debug: 60 | print("Importing %s" % (args.project_path)) 61 | status = gitlab.project_import(args.project_path, args.filepath) 62 | 63 | # Import successful 64 | if status: 65 | print("Import success for %s" % (args.project_path)) 66 | sys.exit(0) 67 | else: 68 | print("Import was not successful") 69 | sys.exit(1) 70 | 71 | else: 72 | print("Error, you have to specify correct project_path and filepath") 73 | sys.exit(1) 74 | -------------------------------------------------------------------------------- /gitlab_export/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rvojcik/gitlab-project-export/eb2f4233699cf642da614413827f14c06d8ed16a/gitlab_export/__init__.py -------------------------------------------------------------------------------- /gitlab_export/config.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import yaml 3 | import os 4 | import sys 5 | 6 | 7 | class Config: 8 | '''Load configuration from yaml file''' 9 | 10 | def __init__(self, config_file): 11 | '''Init config object''' 12 | 13 | self.config_file = config_file 14 | self.config_open() 15 | self.config_load() 16 | self.config_process() 17 | self.config_close() 18 | 19 | def config_open(self): 20 | try: 21 | self.conf_fh = open(self.config_file, 'r') 22 | except IOError as e: 23 | print("({})".format(e)) 24 | sys.exit(1) 25 | 26 | def config_close(self): 27 | self.conf_fh.close() 28 | 29 | def config_process(self): 30 | """ Process configuration file, mainly to maintain backwards compatibility of new features """ 31 | ssl_verify_default = True 32 | # Set default if not exist 33 | if not self.config['gitlab']['access'].__contains__('ssl_verify'): 34 | self.config['gitlab']['access']['ssl_verify'] = ssl_verify_default 35 | 36 | # Better safe then sorry. If file or directory not exist set default 37 | if isinstance(self.config['gitlab']['access']['ssl_verify'], str): 38 | if not os.path.exists(self.config['gitlab']['access']['ssl_verify']): 39 | print("WARNING: provided path to ssl bundle not exist, setting to %s" % (str(ssl_verify_default)), file=sys.stderr) 40 | self.config['gitlab']['access']['ssl_verify'] = ssl_verify_default 41 | 42 | def config_load(self): 43 | self.config = yaml.load(self.conf_fh.read(), Loader=yaml.FullLoader) 44 | -------------------------------------------------------------------------------- /gitlab_export/gitlab.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import requests 3 | import urllib 4 | import sys 5 | import time 6 | import os 7 | import re 8 | 9 | 10 | class Api: 11 | '''Api class for gitlab''' 12 | 13 | def __init__(self, gitlab_url, token, ssl_verify=True): 14 | '''Init config object''' 15 | self.headers = {"PRIVATE-TOKEN": token} 16 | self.api_url = gitlab_url + "/api/v4" 17 | self.download_url = None 18 | self.project_array = False 19 | self.ssl_verify = ssl_verify 20 | 21 | def __api_export(self, project_url): 22 | '''Send export request to API''' 23 | self.download_url = None 24 | try: 25 | return requests.post( 26 | self.api_url + "/projects/" + 27 | project_url + "/export", 28 | headers=self.headers, 29 | verify=self.ssl_verify) 30 | except requests.exceptions.RequestException as e: 31 | print(e, file=sys.stderr) 32 | sys.exit(1) 33 | 34 | def __api_import(self, project_name, namespace, filename): 35 | '''Send import request to API''' 36 | data = { 37 | "path": project_name, 38 | "namespace": namespace, 39 | "overwrite": True} 40 | try: 41 | return requests.post( 42 | self.api_url + "/projects/import", 43 | data=data, 44 | files={"file": open(filename, 'rb')}, 45 | verify=self.ssl_verify, 46 | headers=self.headers) 47 | except requests.exceptions.RequestException as e: 48 | print(e, file=sys.stderr) 49 | sys.exit(1) 50 | 51 | def __api_status(self, project_url): 52 | '''Check project status''' 53 | return requests.get( 54 | self.api_url + "/projects/" + 55 | project_url + "/export", 56 | verify=self.ssl_verify, 57 | headers=self.headers) 58 | 59 | def __api_get(self, endpoint): 60 | ''' Get api endpoint data ''' 61 | try: 62 | return requests.get( 63 | self.api_url + endpoint, 64 | verify=self.ssl_verify, 65 | headers=self.headers) 66 | except requests.exceptions.RequestException as e: 67 | print(e, file=sys.stderr) 68 | sys.exit(1) 69 | 70 | def __api_post(self, endpoint, data): 71 | ''' POST api endpoint data ''' 72 | try: 73 | return requests.post( 74 | self.api_url + endpoint, 75 | data=data, 76 | verify=self.ssl_verify, 77 | headers=self.headers) 78 | except requests.exceptions.RequestException as e: 79 | print(e, file=sys.stderr) 80 | sys.exit(1) 81 | 82 | def __api_import_status(self, project_url): 83 | '''Check project import status''' 84 | return requests.get( 85 | self.api_url+"/projects/" + 86 | project_url + "/import", 87 | verify=self.ssl_verify, 88 | headers=self.headers) 89 | 90 | def project_list(self, path_glob="", membership="True", archived="False"): 91 | ''' List projects based on glob path ''' 92 | urlpath = '/projects?simple=True&membership=%s&archived=%s&per_page=50' % (membership, archived) 93 | page = 1 94 | output = [] 95 | if not self.project_array: 96 | while True: 97 | r = self.__api_get(urlpath + "&page=" + str(page)) 98 | if r.status_code == 200: 99 | json = r.json() 100 | if len(json) > 0: 101 | for project_data in r.json(): 102 | ppath = project_data["path_with_namespace"] 103 | output.append(ppath) 104 | page += 1 105 | else: 106 | break 107 | else: 108 | print("API returned %s" % (str(r.status_code)), file=sys.stderr) 109 | return False 110 | self.project_array = output 111 | 112 | # Compare glob to projects 113 | output = [] 114 | for project in self.project_array: 115 | if re.match(path_glob, project): 116 | output.append(project) 117 | 118 | return output 119 | 120 | def project_export(self, project_path, max_tries_number): 121 | ''' Export Gitlab project 122 | When project export is finished, store download URLs 123 | in objects variable download_url ready to be downloaded''' 124 | 125 | url_project_path = urllib.parse.quote(project_path, safe='') 126 | 127 | # Let's export project 128 | r = self.__api_export(url_project_path) 129 | if ((float(r.status_code) >= 200) and (float(r.status_code) < 300)): 130 | # Api good, check for status 131 | max_tries = max_tries_number 132 | s = "" 133 | status_export = False 134 | while max_tries != 0: 135 | # Decrement tries 136 | max_tries -= 1 137 | 138 | try: 139 | r = self.__api_status(url_project_path) 140 | except requests.exceptions.RequestException as e: 141 | print(e, file=sys.stderr) 142 | return False 143 | 144 | # Check API reply status 145 | if (r.status_code == requests.codes.ok): 146 | json = r.json() 147 | 148 | # Check export status 149 | if "export_status" in json.keys(): 150 | s = json["export_status"] 151 | # Export finished and _links appear in response 152 | if s == "finished" and "_links" in json.keys(): 153 | status_export = True 154 | break 155 | 156 | if s == "queued" or s == "finished" or s == "started" or s == "regeneration_in_progress": 157 | # Reset counter, we are waiting for export 158 | max_tries = max_tries_number 159 | else: 160 | s = "unknown" 161 | 162 | else: 163 | print("API not respond well with %s %s" % ( 164 | str(r.status_code), 165 | str(r.text)), 166 | file=sys.stderr) 167 | break 168 | 169 | # Wait litle bit 170 | time.sleep(5) 171 | 172 | if status_export: 173 | if "_links" in json.keys(): 174 | self.download_url = json["_links"] 175 | return True 176 | else: 177 | print("Unable to find download link in API response: %s" % (str(json))) 178 | return False 179 | else: 180 | print("Export failed, %s" % (str(r.text)), file=sys.stderr) 181 | return False 182 | 183 | else: 184 | print("API not respond well with %s %s" % ( 185 | str(r.status_code), 186 | str(r.text)), 187 | file=sys.stderr) 188 | return False 189 | 190 | def project_import(self, project_path, filepath): 191 | ''' Import project to GitLab from file''' 192 | url_project_path = urllib.parse.quote(project_path, safe='') 193 | project_name = os.path.basename(project_path) 194 | namespace = os.path.dirname(project_path) 195 | 196 | # Let's import project 197 | r = self.__api_import(project_name, namespace, filepath) 198 | if ((float(r.status_code) >= 200) and (float(r.status_code) < 300)): 199 | # Api good, check for status 200 | s = "" 201 | status_export = False 202 | while True: 203 | r = self.__api_import_status(url_project_path) 204 | 205 | # Check API reply status 206 | if (r.status_code == requests.codes.ok): 207 | json = r.json() 208 | 209 | # Check export status 210 | if "import_status" in json.keys(): 211 | s = json["import_status"] 212 | if s == "finished": 213 | status_import = True 214 | break 215 | elif s == "failed": 216 | status_import = False 217 | break 218 | else: 219 | s = "unknown" 220 | 221 | else: 222 | print("API not respond well with %s %s" % ( 223 | str(r.status_code), 224 | str(r.text)), 225 | file=sys.stderr) 226 | break 227 | 228 | # Wait litle bit 229 | time.sleep(1) 230 | 231 | if status_import: 232 | return True 233 | else: 234 | print("Import failed, %s" % (str(r.text)), file=sys.stderr) 235 | return False 236 | 237 | else: 238 | print("API not respond well with %s %s" % ( 239 | str(r.status_code), 240 | str(r.text)), 241 | file=sys.stderr) 242 | print(r.text, file=sys.stderr) 243 | return False 244 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyyaml 2 | requests 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from os.path import join as path_join, dirname 2 | from setuptools import setup, find_packages 3 | 4 | version = '0.1.2' 5 | 6 | with open("README.md", "r") as fh: 7 | long_description = fh.read() 8 | 9 | with open("requirements.txt", "r") as fh: 10 | install_reqs = fh.read().split() 11 | 12 | setup( 13 | name='gitlab-project-export', 14 | version=version, 15 | description=('Simple python project for exporting gitlab projects ' 16 | 'with Export Project feature in GitLab API.'), 17 | long_description=long_description, 18 | long_description_content_type="text/markdown", 19 | include_package_data=True, 20 | author='Robert Vojcik', 21 | author_email='robert@vojcik.net', 22 | url='https://github.com/rvojcik/gitlab-project-export', 23 | download_url='https://github.com/rvojcik/gitlab-project-export/archive/master.tar.gz', 24 | packages=find_packages(), 25 | install_requires = install_reqs, 26 | scripts=[ 27 | 'gitlab-project-export.py', 28 | 'gitlab-project-import.py', 29 | ], 30 | keywords=['gitlab-backup', 'gitlab-export', 'export', 'gitlab', 'backup'], 31 | classifiers=[ 32 | 'Development Status :: 4 - Beta', 33 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 34 | 'Programming Language :: Python', 35 | 'Programming Language :: Python :: 3', 36 | ], 37 | ) 38 | --------------------------------------------------------------------------------