├── .gitignore ├── LICENSE ├── __init__.py ├── buildpkg-macos-arm64 ├── buildpkg.exe ├── buildpkg.py ├── figures ├── buildpkg.gif ├── logo.ico ├── logo.png └── logo2.png ├── readme.md ├── release.bat └── templates ├── ci_script_github ├── script_bspcfg └── script_scons ├── template-ci-github.yml ├── template-kconfig ├── template-package.json ├── template-readme-rtt.md ├── template-readme.md ├── template-sconscript-example.py └── template-sconscript.py /.gitignore: -------------------------------------------------------------------------------- 1 | /*.log 2 | /__pycache__ 3 | /build 4 | /dist 5 | /packages 6 | packages/*.* 7 | /Todo.txt 8 | /config.json 9 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/__init__.py -------------------------------------------------------------------------------- /buildpkg-macos-arm64: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/buildpkg-macos-arm64 -------------------------------------------------------------------------------- /buildpkg.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/buildpkg.exe -------------------------------------------------------------------------------- /buildpkg.py: -------------------------------------------------------------------------------- 1 | # -*- coding:utf-8 –*- 2 | # 3 | # ################################################################################ 4 | # @File: buildpkg.py 5 | # @Author: liu2guang 6 | # @Date: 2018-09-19 18:07:00 7 | # 8 | # _____ 9 | # / \ 10 | # vvvvvvv /|__/| 11 | # I /O,O | 12 | # I /_____ | /|/| 13 | # J|/^ ^ ^ \ | /00 | _//| 14 | # |^ ^ ^ ^ |W| |/^^\ | /oo | 15 | # \m___m__|_| \m_m_| \mm_| 16 | # 17 | # Quick build rt-thread pkg toolkits 18 | # --- liu2guang 19 | # 20 | # @LICENSE: GPLv3: https://github.com/rtpkgs/buildpkg/blob/master/LICENSE. 21 | # 22 | # Change Logs: 23 | # Date Author Notes 24 | # 2018-09-19 liu2guang The first version. 25 | # 2018-09-20 liu2guang To optimize the implementation. 26 | # 27 | # ################################################################################ 28 | 29 | # -------------------------------------------------------------------------------- 30 | # Import module 31 | # -------------------------------------------------------------------------------- 32 | import os, sys 33 | import logging 34 | import json 35 | import argparse 36 | import time 37 | import shutil 38 | import platform 39 | 40 | # -------------------------------------------------------------------------------- 41 | # Info and config 42 | # -------------------------------------------------------------------------------- 43 | _BUILDPKG_VERSION = "v0.2.1" 44 | _BUILDPKG_AUTHOR = "liu2guang" 45 | _BUILDPKG_LICENSE = "GPLv3" 46 | _BUILDPKG_RELEASE = True 47 | 48 | _BUILDPKG_CONTRIBUTORS = { 49 | "liu2guang" : "https://github.com/liu2guang", 50 | "balanceTWK": "https://github.com/balanceTWK" 51 | } 52 | _BUILDPKG_DEF_LOG_FORMAT = "[%(asctime)s %(filename)s L%(lineno).4d %(levelname)-8s]: %(message)s" 53 | _BUILDPKG_RUN_LOG_FORMAT = "[Buildpkg] %(message)s" 54 | _BUILDPKG_PKG_LOG_FORMAT = "[%(asctime)s %(filename)s L%(lineno).4d %(levelname)-8s]: %(message)s" 55 | 56 | _BUILDPKG_RUN_LOG_FILE = "buildpkg.log" 57 | _BUILDPKG_PKG_LOG_FILE = os.path.join("packages", "pkglist.log") 58 | 59 | # -------------------------------------------------------------------------------- 60 | # Variable: path/log 61 | # -------------------------------------------------------------------------------- 62 | _buildpkg_path = None # ./buildpkg/ 63 | _buildpkg_template_path = None # ./buildpkg/template/ 64 | _buildpkg_packages_path = None # ./buildpkg/template/ 65 | _buildpkg_packages_xxx_path = None # ./buildpkg/template/xxx 66 | _buildpkg_packages_xxx_example_path = None # ./buildpkg/template/xxx/example 67 | _buildpkg_packages_xxx_scripts_path = None # ./buildpkg/template/xxx/scripts 68 | 69 | _run_log = None # run buildpkg log 70 | _pkg_log = None # create the package record log 71 | 72 | _config = None 73 | _templates = None 74 | _config_default = """ 75 | { 76 | "username" : "None", 77 | "list_ignore_inc" : [".git", "example", "doc", "test"], 78 | "list_ignore_src" : ["test.c", "example.c"], 79 | 80 | "templates": 81 | { 82 | "readme_md" : "template-readme-rtt.md", 83 | "sconscript" : "template-sconscript.py", 84 | "sconscript_example": "template-sconscript-example.py", 85 | "ci_github" : "template-ci-github.yml", 86 | "kconfig" : "template-kconfig", 87 | "package_json" : "template-package.json" 88 | }, 89 | "pkg_def_version" : "v1.0.0", 90 | "commit_content" : "[builpkg] Use the buildpkg tool to quickly build ${pkgname}'s packages!" 91 | } 92 | """ 93 | 94 | # -------------------------------------------------------------------------------- 95 | # Shell cmd 96 | # -------------------------------------------------------------------------------- 97 | _parser = argparse.ArgumentParser( 98 | description = "Quick build rt-thread pkg toolkits %s!" % _BUILDPKG_VERSION, 99 | epilog = "You can find the latest version form https://github.com/rtpkgs/buildpkg" 100 | ) 101 | _parser.add_argument( "action" , type = str, help = "The action of build package by buildpkg", choices=["make", "update"]) 102 | _parser.add_argument( "pkgname" , type = str, help = "The package name to be make or update") 103 | _parser.add_argument( "pkgrepo" , type = str, help = "To make the package from the specified git repository", nargs = "?") 104 | _parser.add_argument("--version" , "-v" , type = str, help = "The package version to be make or update") 105 | _parser.add_argument("--license" , "-l" , type = str, help = "The package license to be make or update, one of: agpl3, apache, bsd2, bsd3, cddl, cc0, epl, gpl2, gpl3, lgpl, mit, mpl") 106 | _parser.add_argument("--submodule", "-s" , action = "store_true", help = "Add to the repository as a submodule") 107 | _args = _parser.parse_args() 108 | 109 | # -------------------------------------------------------------------------------- 110 | # Create log object 111 | # -------------------------------------------------------------------------------- 112 | def _create_log(log_name, log_path, level = logging.INFO, console = True, format = _BUILDPKG_DEF_LOG_FORMAT): 113 | path = os.path.dirname(os.path.abspath(log_path)) 114 | if os.path.exists(path) == False: 115 | os.makedirs(path) 116 | 117 | log = logging.getLogger(log_name) 118 | log.setLevel(logging.DEBUG) 119 | format = logging.Formatter(format) 120 | 121 | f = logging.FileHandler(log_path) 122 | f.setFormatter(format) 123 | f.setLevel(logging.DEBUG) 124 | log.addHandler(f) 125 | 126 | if console == True: 127 | c = logging.StreamHandler() 128 | c.setFormatter(format) 129 | c.setLevel(level) 130 | log.addHandler(c) 131 | 132 | return log 133 | 134 | # -------------------------------------------------------------------------------- 135 | # Save confg 136 | # -------------------------------------------------------------------------------- 137 | def _save_config(filename): 138 | if sys.version_info < (3, 0): 139 | with open(filename, "w") as _file: 140 | _file.write(json.dumps(_config, indent=4)) 141 | else: 142 | with open(filename, "w", encoding='utf-8') as _file: 143 | _file.write(json.dumps(_config, indent=4)) 144 | 145 | # -------------------------------------------------------------------------------- 146 | # Load confg 147 | # -------------------------------------------------------------------------------- 148 | def _load_config(filename): 149 | # 1. check if "filename" file exists 150 | if os.path.exists(filename) == False: 151 | with open(filename, 'w+') as file: 152 | file.write(_config_default) 153 | 154 | # 2. check that "filename" is illegal, Waiting for user processing 155 | try: 156 | with open(filename, 'r') as file: 157 | json.load(file) 158 | # json.load(file, encoding='utf-8') 159 | except ValueError: 160 | _run_log.info("\"config.json\" is not illegal, whether to regenerate the default configuration [Y/N]: ") 161 | option = input() 162 | if option == "Y" or option == "y" or option == "YES" or option == "Yes" or option == "yes" or option == "": 163 | _run_log.info("Y") 164 | with open(filename, 'w+') as file: 165 | file.write(_config_default) 166 | else: 167 | _run_log.info("N") 168 | _run_log.info("Please modify config.json correctly before running buildpkg.") 169 | sys.exit("sorry, goodbye!") 170 | 171 | _run_log.info("Fix the config.json file contents.") 172 | 173 | # 3. load config 174 | global _config 175 | global _templates 176 | 177 | with open(filename, 'r') as file: 178 | _config = json.load(file) 179 | _templates = _config["templates"] 180 | _run_log.debug("Buildpkg load config: \n" + json.dumps(_config, indent=4)) 181 | 182 | # 4. check that the user name is configured 183 | if _config["username"] == "None": 184 | _run_log.info("Please enter your github username: ") 185 | _config["username"] = input() 186 | if _config["username"] != "" and _config["username"] != "None": 187 | _save_config("config.json") 188 | 189 | _run_log.info("Update %s to config.json." % (_config["username"])) 190 | 191 | # -------------------------------------------------------------------------------- 192 | # Save package confg 193 | # -------------------------------------------------------------------------------- 194 | def _save_package_config(filename, config): 195 | if sys.version_info < (3, 0): 196 | with open(filename, "w+") as _file: 197 | _file.write(json.dumps(config, indent=4)) 198 | else: 199 | with open(filename, "w+", encoding='utf-8') as _file: 200 | _file.write(json.dumps(config, indent=4)) 201 | 202 | # -------------------------------------------------------------------------------- 203 | # Load package confg 204 | # -------------------------------------------------------------------------------- 205 | def _load_package_config(filename): 206 | # 1. check if "filename" file exists 207 | if os.path.exists(filename) == False: 208 | return None 209 | 210 | # 2. check that "filename" is illegal, Waiting for user processing 211 | try: 212 | with open(filename, 'r') as file: 213 | json.load(file) 214 | except ValueError: 215 | return None 216 | 217 | # 3. load package config 218 | with open(filename, 'r') as file: 219 | _package_config = json.load(file) 220 | 221 | _run_log.debug("Buildpkg load package config: \n" + json.dumps(_package_config, indent=4)) 222 | 223 | return _package_config 224 | 225 | # -------------------------------------------------------------------------------- 226 | # Check self(It will load the configuration) 227 | # -------------------------------------------------------------------------------- 228 | def _check_self(): 229 | # 1. check if the "package" directory exists 230 | if os.path.exists("packages") == False: 231 | _run_log.info("The [packages] path was not found, auto create directory.") 232 | os.makedirs ("packages") 233 | 234 | # 2. check if the "template" directory exists 235 | if os.path.exists("templates") == False: 236 | _run_log.info("The [template] path was not found, auto create directory.") 237 | os.makedirs ("templates") 238 | 239 | # 3. check if "filename" file exists 240 | # check that "filename" is illegal, Waiting for user processing 241 | # load config 242 | _load_config("config.json") 243 | 244 | # 4. check if License file exists 245 | if os.path.exists("LICENSE") == False: 246 | _run_log.info("Please do not delete the license, otherwise you will not be able to use buildpkg!") 247 | sys.exit("sorry, goodbye!") 248 | 249 | # 5. check if the library generated by the license is installed 250 | try: 251 | import lice 252 | except ImportError: 253 | if sys.version_info < (3, 0): 254 | os.system("easy_install lice") 255 | _run_log.info("The license generation module was not found, Automatic installation by easy_install!") 256 | else: 257 | os.system("pip install lice") 258 | _run_log.info("The license generation module was not found, Automatic installation! by pip.") 259 | 260 | # 6. check that the template file exists 261 | global _templates 262 | 263 | for item, file_name in _templates.items(): 264 | file_path = os.path.join(_buildpkg_template_path, str(file_name)) 265 | if os.path.exists(file_path) == False: 266 | _run_log.info("The template file [%s] does not exist and exit." % (file_name)) 267 | sys.exit("sorry, goodbye!") 268 | 269 | _run_log.info("To complete self-check, and load config form [config.json] file.") 270 | 271 | # -------------------------------------------------------------------------------- 272 | # Analyze the path to use 273 | # -------------------------------------------------------------------------------- 274 | def _analyze_path(package_name): 275 | global _buildpkg_path 276 | global _buildpkg_template_path 277 | global _buildpkg_packages_path 278 | global _buildpkg_packages_xxx_path 279 | global _buildpkg_packages_xxx_example_path 280 | global _buildpkg_packages_xxx_scripts_path 281 | 282 | _buildpkg_path = os.getcwd() 283 | _buildpkg_template_path = os.path.join(_buildpkg_path, "templates") 284 | _buildpkg_packages_path = os.path.join(_buildpkg_path, "packages") 285 | _buildpkg_packages_xxx_path = os.path.join(_buildpkg_packages_path, package_name) 286 | _buildpkg_packages_xxx_example_path = os.path.join(_buildpkg_packages_xxx_path, "example") 287 | _buildpkg_packages_xxx_scripts_path = os.path.join(_buildpkg_packages_xxx_path, "scripts") 288 | 289 | _run_log.debug("Analyze the path to use: ") 290 | _run_log.debug("- buildpkg_path : " + _buildpkg_path) 291 | _run_log.debug("- buildpkg_template_path : " + _buildpkg_template_path) 292 | _run_log.debug("- buildpkg_packages_path : " + _buildpkg_packages_path) 293 | _run_log.debug("- buildpkg_packages_xxx_path : " + _buildpkg_packages_xxx_path) 294 | _run_log.debug("- buildpkg_packages_xxx_example_path: " + _buildpkg_packages_xxx_example_path) 295 | _run_log.debug("- buildpkg_packages_xxx_scripts_path: " + _buildpkg_packages_xxx_scripts_path) 296 | 297 | # -------------------------------------------------------------------------------- 298 | # Generate file based on the template 299 | # -------------------------------------------------------------------------------- 300 | def _generate_file(template_name, target_name, replace_list): 301 | if _BUILDPKG_RELEASE == False: 302 | _run_log.info("Generate [%s] file form [%s], Replace list is %s." % (target_name, template_name, str(replace_list))) 303 | else: 304 | _run_log.info("Generate [%s] file form [%s]." % (target_name, template_name)) 305 | 306 | _template_file_path = os.path.join(_buildpkg_template_path, template_name) 307 | _target_file_path = os.path.join(_buildpkg_packages_xxx_path, target_name) 308 | 309 | if sys.version_info < (3, 0): 310 | with open(_template_file_path, 'r') as _file_in, open(_target_file_path, 'w+') as _file_out: 311 | _contents = _file_in.readlines() 312 | for _line in _contents: 313 | for (key, value) in replace_list.items(): 314 | _line = _line.replace("${" + key + "}", value) 315 | _file_out.write(_line) 316 | else: 317 | with open(_template_file_path, 'r', encoding='utf-8') as _file_in, open(_target_file_path, 'w+', encoding='utf-8') as _file_out: 318 | _contents = _file_in.readlines() 319 | for _line in _contents: 320 | for (key, value) in replace_list.items(): 321 | _line = _line.replace("${" + key + "}", value) 322 | _file_out.write(_line) 323 | 324 | _run_log.info("Generate [%s] file success." % (target_name)) 325 | 326 | # -------------------------------------------------------------------------------- 327 | # Commit package git 328 | # -------------------------------------------------------------------------------- 329 | def _commit_git(pkgname, commit_content): 330 | _run_log.info("Start commit the commit.") 331 | os.chdir(_buildpkg_packages_xxx_path) 332 | 333 | os.system('git add -A') 334 | os.system("git commit -m \"" + commit_content.replace("${pkgname}", pkgname) + "\"") 335 | 336 | os.chdir(_buildpkg_path) 337 | _run_log.info("Commit the commit success.") 338 | 339 | # -------------------------------------------------------------------------------- 340 | # Generate package 341 | # -------------------------------------------------------------------------------- 342 | def _make_package(pkgname, version = None, license = None): 343 | _run_log.info("Start make %s package." % (pkgname)) 344 | 345 | if version == None: 346 | version = _config["pkg_def_version"] 347 | 348 | # Replace the list 349 | _replace_list = { 350 | "username" : _config["username"], 351 | "pkgname" : pkgname, 352 | "version" : version, 353 | "pkgname_letter" : pkgname.upper(), 354 | "list_ignore_inc": str(_config["list_ignore_inc"]), 355 | "list_ignore_src": str(_config["list_ignore_src"]) 356 | } 357 | 358 | # 0. Generate package directory 359 | global _buildpkg_path 360 | global _buildpkg_template_path 361 | global _buildpkg_packages_path 362 | global _buildpkg_packages_xxx_path 363 | global _buildpkg_packages_xxx_example_path 364 | global _buildpkg_packages_xxx_scripts_path 365 | 366 | if _BUILDPKG_RELEASE == False: 367 | if os.path.exists(_buildpkg_packages_xxx_path) == True: 368 | shutil.rmtree(_buildpkg_packages_xxx_path) 369 | os.makedirs(_buildpkg_packages_xxx_path) 370 | else: 371 | if os.path.exists(_buildpkg_packages_xxx_path) == True: 372 | _backup_path = _buildpkg_packages_xxx_path + "_backup_" + time.strftime("%y%m%d_%H%M%S", time.localtime()) 373 | _run_log.warning("[%s] already existed, backup to [%s]" %(_buildpkg_packages_xxx_path, _backup_path)) 374 | os.rename(_buildpkg_packages_xxx_path, _backup_path) 375 | else: 376 | os.makedirs(_buildpkg_packages_xxx_path) 377 | 378 | os.makedirs(_buildpkg_packages_xxx_example_path) 379 | # os.makedirs(_buildpkg_packages_xxx_scripts_path) 380 | 381 | # 1. Generate the /readme.md file 382 | _generate_file(_templates["readme_md"], "readme.md", _replace_list) 383 | 384 | # 2. Generate the /SConscript file 385 | _generate_file(_templates["sconscript"], "SConscript", _replace_list) 386 | 387 | # 3. Generate the /example/SConscript file 388 | _example_sconscript_path = os.path.join("example", "SConscript") 389 | _generate_file(_templates["sconscript_example"], _example_sconscript_path, _replace_list) 390 | 391 | # 4. Generate the /.travis.yml file 392 | _templates_ci_script_dir_path = os.path.join(_buildpkg_template_path, "ci_script_github") 393 | 394 | shutil.copytree(_templates_ci_script_dir_path, _buildpkg_packages_xxx_scripts_path) 395 | _generate_file(_templates["ci_github"], ".travis.yml", _replace_list) 396 | 397 | # 5. Generate the /LICENSE file 398 | if license != None: 399 | _license_file_path = os.path.join(_buildpkg_packages_xxx_path, "LICENSE") 400 | _run_log.info("Generate [%s LICENSE] file by \"lice module\"." % (license)) 401 | cmd = "lice " + license.lower() + " -f " + _license_file_path + " -o " + _config["username"] 402 | os.system(cmd) 403 | 404 | if os.path.exists(_license_file_path) == True: 405 | _run_log.info("Generate [%s LICENSE] file success." % (license)) 406 | else: 407 | _run_log.error("Generate [%s LICENSE] file failed." % (license)) 408 | 409 | # 6. Save the configuration file when generating the project 410 | _run_log.info("Save the configuration file to [%s]." % (pkgname)) 411 | __buildpkg_config_json_path = os.path.join(_buildpkg_path, "config.json") 412 | __buildpkg_packages_xxx_config_json_path = os.path.join(_buildpkg_packages_xxx_path, "config.json") 413 | 414 | _config_save = {} 415 | _config_save.update(_config) 416 | _config_save.update(_replace_list) 417 | _save_package_config(__buildpkg_packages_xxx_config_json_path, _config_save) 418 | 419 | _run_log.info("Save the configuration success.") 420 | 421 | # 7. Create git repository 422 | _run_log.info("Create git repository in [%s]." % (_buildpkg_packages_xxx_path)) 423 | os.chdir(_buildpkg_packages_xxx_path) 424 | os.system("git init") 425 | os.chdir(_buildpkg_path) 426 | _run_log.info("Create git repository success.") 427 | 428 | _run_log.info("Make %s package success." % (pkgname)) 429 | 430 | # -------------------------------------------------------------------------------- 431 | # Transplant package 432 | # -------------------------------------------------------------------------------- 433 | def _transplant_package(pkgname, pkgrepo, version = None, license = None, submodule = False): 434 | global _buildpkg_path 435 | global _buildpkg_packages_xxx_path 436 | 437 | _make_package(pkgname, version, license) 438 | 439 | # Todo: check pkgrepo is git addr? 440 | 441 | # 1.1 Add to the repository as a submodule when Transplant package 442 | if submodule == True: 443 | os.chdir(_buildpkg_packages_xxx_path) 444 | os.system("git submodule add " + pkgrepo) 445 | os.chdir(_buildpkg_path) 446 | _run_log.debug("Add %s to the %s repository as a submodule." % (pkgrepo, pkgname)) 447 | 448 | # 1.2 Add to the repository as source code when Transplant package 449 | else: 450 | # Todo path??? 451 | _git_name = pkgrepo.split("/")[-1].replace(".git", "") 452 | _git_remove_path = os.path.join(_buildpkg_packages_xxx_path, _git_name, ".git") 453 | os.chdir(_buildpkg_packages_xxx_path) 454 | os.system('git clone --progress --recursive ' + pkgrepo) 455 | os.system('attrib -r ' + _git_remove_path + '\\*.* /s') 456 | shutil.rmtree(_git_remove_path) 457 | os.chdir(_buildpkg_path) 458 | _run_log.info("Add %s to the %s repository as source code." % (pkgrepo, pkgname)) 459 | 460 | # -------------------------------------------------------------------------------- 461 | # Update package 462 | # -------------------------------------------------------------------------------- 463 | def _update_package(pkgname, version = None, license = None): 464 | global _config 465 | global _buildpkg_path 466 | global _buildpkg_template_path 467 | global _buildpkg_packages_path 468 | global _buildpkg_packages_xxx_path 469 | global _buildpkg_packages_xxx_example_path 470 | global _buildpkg_packages_xxx_scripts_path 471 | 472 | # 1. Read the previously generated configuration 473 | _package_config_path = os.path.join(_buildpkg_packages_path, pkgname, "config.json") 474 | _package_config = _load_package_config(_package_config_path) 475 | 476 | if _package_config == None: 477 | _run_log.error("The [%s] package was not found, exit buildpkg update." % (pkgname)) 478 | sys.exit("sorry, goodbye!") 479 | 480 | _replace_list = { 481 | "username" : _config["username"], 482 | "pkgname" : _package_config["pkgname"], 483 | "version" : _package_config["version"] if version == None else version, 484 | "pkgname_letter" : _package_config["pkgname_letter"], 485 | "list_ignore_inc": str(_config["list_ignore_inc"]), 486 | "list_ignore_src": str(_config["list_ignore_src"]) 487 | } 488 | 489 | # 2. Update the /readme.md file 490 | _generate_file(_templates["readme_md"], "readme.md", _replace_list) 491 | 492 | # 3. Update the /SConscript file 493 | _generate_file(_templates["sconscript"], "SConscript", _replace_list) 494 | 495 | # 4. Update the /example/SConscript file 496 | _example_sconscript_path = os.path.join("example", "SConscript") 497 | _generate_file(_templates["sconscript_example"], _example_sconscript_path, _replace_list) 498 | 499 | # 5. Update the /.travis.yml file 500 | _templates_ci_script_dir_path = os.path.join(_buildpkg_template_path, "ci_script_github") 501 | shutil.rmtree(_buildpkg_packages_xxx_scripts_path) 502 | shutil.copytree(_templates_ci_script_dir_path, _buildpkg_packages_xxx_scripts_path) 503 | _generate_file(_templates["ci_github"], ".travis.yml", _replace_list) 504 | 505 | # 6. Update the /LICENSE file 506 | if license != None: 507 | _license_file_path = os.path.join(_buildpkg_packages_xxx_path, "LICENSE") 508 | _run_log.info("Generate [%s LICENSE] file by \"lice module\"." % (license)) 509 | cmd = "lice " + license.lower() + " -f " + _license_file_path + " -o " + _config["username"] 510 | os.system(cmd) 511 | 512 | if os.path.exists(_license_file_path) == True: 513 | _run_log.info("Generate [%s LICENSE] file success." % (license)) 514 | else: 515 | _run_log.error("Generate [%s LICENSE] file failed." % (license)) 516 | 517 | # 7. Save the configuration file when generating the project 518 | _run_log.info("Save the configuration file to [%s]." % (pkgname)) 519 | __buildpkg_config_json_path = os.path.join(_buildpkg_path, "config.json") 520 | __buildpkg_packages_xxx_config_json_path = os.path.join(_buildpkg_packages_xxx_path, "config.json") 521 | 522 | _config_save = {} 523 | _config_save.update(_config) 524 | _config_save.update(_replace_list) 525 | _save_package_config(__buildpkg_packages_xxx_config_json_path, _config_save) 526 | 527 | _run_log.info("Save the configuration success.") 528 | 529 | # -------------------------------------------------------------------------------- 530 | # Main 531 | # -------------------------------------------------------------------------------- 532 | def main(): 533 | # 1. create log 534 | global _run_log 535 | global _pkg_log 536 | 537 | _run_log = _create_log("run_log", _BUILDPKG_RUN_LOG_FILE, logging.DEBUG if _BUILDPKG_RELEASE == False else logging.INFO, True, _BUILDPKG_RUN_LOG_FORMAT) 538 | _pkg_log = _create_log("pkg_log", _BUILDPKG_PKG_LOG_FILE, logging.DEBUG, False, _BUILDPKG_PKG_LOG_FORMAT) 539 | 540 | _run_log.info("<< Start run buildpkg >>") 541 | _run_log.info("Version : %s" % (_BUILDPKG_VERSION)) 542 | _run_log.info("Author : %s" % (_BUILDPKG_AUTHOR)) 543 | _run_log.info("License : %s" % (_BUILDPKG_LICENSE)) 544 | _run_log.info("Conteributors: %s" % (str(_BUILDPKG_CONTRIBUTORS))) 545 | 546 | # 2. analyze path 547 | _analyze_path(_args.pkgname) 548 | 549 | # 3. self check 550 | _check_self() 551 | 552 | # 4. make or transplant package 553 | if _args.action == "make": 554 | # 4.1. make package 555 | if _args.pkgrepo == None: 556 | if str(_args.pkgname).find(".git") != -1 or str(_args.pkgname).find("http://") != -1 or str(_args.pkgname).find("https://") != -1: 557 | _run_log.error("The %s is a url! Please input package name" % (_args.pkgname)) 558 | sys.exit("sorry, goodbye!") 559 | 560 | _make_package(_args.pkgname, _args.version, _args.license) 561 | _commit_git(_args.pkgname, _config["commit_content"]) 562 | # 4.2. transplant package 563 | else: 564 | _transplant_package(_args.pkgname, _args.pkgrepo, _args.version, _args.license, _args.submodule) 565 | _commit_git(_args.pkgname, _config["commit_content"]) 566 | 567 | _run_log.info("To complete to make package [%s]!" % (_args.pkgname)) 568 | _pkg_log.info("To complete to make package [%s]!" % (_args.pkgname)) 569 | elif _args.action == "update": 570 | _update_package(_args.pkgname, _args.version, _args.license) 571 | _run_log.info("To complete to update package [%s]!" % (_args.pkgname)) 572 | _pkg_log.info("To complete to update package [%s]!" % (_args.pkgname)) 573 | 574 | if __name__ == "__main__": 575 | try: 576 | main() 577 | except: 578 | _pkg_log.exception(sys.exc_info()) 579 | # sys.exit("Sorry, goodbye!") 580 | _run_log("Sorry, goodbye!"); 581 | 582 | -------------------------------------------------------------------------------- /figures/buildpkg.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/figures/buildpkg.gif -------------------------------------------------------------------------------- /figures/logo.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/figures/logo.ico -------------------------------------------------------------------------------- /figures/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/figures/logo.png -------------------------------------------------------------------------------- /figures/logo2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/figures/logo2.png -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 | 6 | 23 | 24 |

Quick build rt-thread pkg toolkits | 快速构建rt-thread pkg工具集

25 |
26 | 27 | ## 简介 ([English](/readme.en.md)) 28 | 29 | buildpkg 是用于生成 RT-Thread package 的快速构建工具。 30 | 31 | 一个优秀的 package 应该是这样的： 32 | 1. 代码优雅, 规范化。 33 | 2. examples 例程，提供通俗易懂的使用例程。 34 | 3. SConscript 文件，用于和 RT-Thread 环境一起进行编译。 35 | 4. README.md 文档，向用户提供必要的功能说明。 36 | 5. docs 文件夹, 放置除了 README 之外的其他细节文档。 37 | 6. license 许可文件，版权说明。 38 | 39 | 为了方便快速的生成 RT-Thread package 规范化模板 以及 减轻开源仓库迁移 RT-Thread 的前期准备工作的负担，基于此目的的 buildpkg 应运而生，为开发 Rt-Thread 的 package 的开发者提供辅助开发工具。 40 | 41 | | 序号 | 支持功能 | 描述 | 42 | | :--- | :--- | :--- | 43 | | 1 | 构建 package 模板 | 创建指定名称 package , 自动添加 readme /版本号/ github ci脚本/demo/开源协议文件 | 44 | | 2 | 迁移开源仓库 | 从指定 git 仓库构建 package , 自动添加readme/版本号/ github ci脚本/demo/开源协议文件, 但是迁移的仓库需要用户自己按照实际情况修改 | 45 | | 3 | 更新 package | 生成package后可以再次更新之前设定的版本号，开源协议或者scons脚本等 | 46 | 47 | ## 使用说明 48 | 49 | ### 1. 构建package 50 | > buildpkg.exe make pkgdemo 51 | 52 | ### 2. 迁移开源仓库 53 | > buildpkg.exe make cstring https://github.com/liu2guang/cstring.git 54 | 55 | ### 3. 更新package 56 | > buildpkg.exe update pkgname 57 | 58 | ### 4. 可选配置 59 | | 长参数 | 短参数 | 描述 | 60 | | :--- | :--- | :--- | 61 | | --version=v1.0.0 | -v v1.0.0 | 设置 package 的版本 | 62 | | --license=MIT | -l MIT | 设置 package 所遵循的版权协议 | 63 | | --submodule | -s |删除 git 子模块 | 64 | 65 | ## Windows10 及 Linux 平台的演示动图 66 | ![buildpkg](/figures/buildpkg.gif) 67 | 68 | ## 测试平台 69 | 70 | | 序号 | 测试平台 | 测试结果 | 71 | |:---|:---|:---| 72 | | 1 | win10 | exe测试通过, py测试通过 | 73 | | 2 | win7 | exe待测试, py待测试 | 74 | | 3 | mac | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | 75 | | 4 | linux | py脚本不知道是否兼容, 没有测试条件, 后面维护下 | 76 | 77 | ## 联系人 78 | 79 | * 邮箱：[1004383796@qq.com](mailto:1004383796@qq.com) 80 | * 主页：[liu2guang](https://github.com/liu2guang) 81 | * 仓库：[Github](https://github.com/liu2guang), [Gitee](https://github.com/liu2guang) 82 | 83 | ## 感谢 84 | 85 | 感谢以下开发者的大力支持: [contributed](CONTRIBUTING.md) 86 | 94 | -------------------------------------------------------------------------------- /release.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | pyinstaller -F --icon=.\figures\logo.ico .\buildpkg.py 3 | copy .\dist\buildpkg.exe buildpkg.exe 4 | rd /s /Q .\__pycache__ 5 | rd /s /Q .\build 6 | rd /s /Q .\dist 7 | del .\buildpkg.spec 8 | pause -------------------------------------------------------------------------------- /templates/ci_script_github/script_bspcfg: -------------------------------------------------------------------------------- 1 | #ifndef RT_CONFIG_H__ 2 | #define RT_CONFIG_H__ 3 | 4 | /* Automatically generated file; DO NOT EDIT. */ 5 | /* RT-Thread Configuration */ 6 | 7 | /* RT-Thread Kernel */ 8 | 9 | #define RT_NAME_MAX 8 10 | #define RT_ALIGN_SIZE 4 11 | #define RT_THREAD_PRIORITY_32 12 | #define RT_THREAD_PRIORITY_MAX 32 13 | #define RT_TICK_PER_SECOND 100 14 | #define RT_DEBUG 15 | #define RT_USING_OVERFLOW_CHECK 16 | #define RT_DEBUG_INIT 0 17 | #define RT_DEBUG_THREAD 0 18 | #define RT_USING_HOOK 19 | #define RT_IDEL_HOOK_LIST_SIZE 4 20 | #define IDLE_THREAD_STACK_SIZE 256 21 | 22 | /* Inter-Thread communication */ 23 | 24 | #define RT_USING_SEMAPHORE 25 | #define RT_USING_MUTEX 26 | #define RT_USING_EVENT 27 | #define RT_USING_MAILBOX 28 | #define RT_USING_MESSAGEQUEUE 29 | 30 | /* Memory Management */ 31 | 32 | #define RT_USING_MEMHEAP 33 | #define RT_USING_MEMHEAP_AS_HEAP 34 | #define RT_USING_HEAP 35 | 36 | /* Kernel Device Object */ 37 | 38 | #define RT_USING_DEVICE 39 | #define RT_USING_CONSOLE 40 | #define RT_CONSOLEBUF_SIZE 128 41 | #define RT_CONSOLE_DEVICE_NAME "uart1" 42 | #define ARCH_ARM 43 | #define ARCH_ARM_CORTEX_M 44 | #define ARCH_ARM_CORTEX_M7 45 | 46 | /* RT-Thread Components */ 47 | 48 | #define RT_USING_COMPONENTS_INIT 49 | #define RT_USING_USER_MAIN 50 | #define RT_MAIN_THREAD_STACK_SIZE 2048 51 | 52 | /* C++ features */ 53 | 54 | 55 | /* Command shell */ 56 | 57 | #define RT_USING_FINSH 58 | #define FINSH_THREAD_NAME "tshell" 59 | #define FINSH_USING_HISTORY 60 | #define FINSH_HISTORY_LINES 5 61 | #define FINSH_USING_SYMTAB 62 | #define FINSH_USING_DESCRIPTION 63 | #define FINSH_THREAD_PRIORITY 20 64 | #define FINSH_THREAD_STACK_SIZE 4096 65 | #define FINSH_CMD_SIZE 80 66 | #define FINSH_USING_MSH 67 | #define FINSH_USING_MSH_DEFAULT 68 | #define FINSH_ARG_MAX 10 69 | 70 | /* Device virtual file system */ 71 | 72 | #define RT_USING_DFS 73 | #define DFS_USING_WORKDIR 74 | #define DFS_FILESYSTEMS_MAX 2 75 | #define DFS_FILESYSTEM_TYPES_MAX 2 76 | #define DFS_FD_MAX 4 77 | #define RT_USING_DFS_ELMFAT 78 | 79 | /* elm-chan's FatFs, Generic FAT Filesystem Module */ 80 | 81 | #define RT_DFS_ELM_CODE_PAGE 437 82 | #define RT_DFS_ELM_WORD_ACCESS 83 | #define RT_DFS_ELM_USE_LFN_3 84 | #define RT_DFS_ELM_USE_LFN 3 85 | #define RT_DFS_ELM_MAX_LFN 255 86 | #define RT_DFS_ELM_DRIVES 2 87 | #define RT_DFS_ELM_MAX_SECTOR_SIZE 512 88 | #define RT_DFS_ELM_REENTRANT 89 | #define RT_USING_DFS_DEVFS 90 | 91 | /* Device Drivers */ 92 | 93 | #define RT_USING_DEVICE_IPC 94 | #define RT_PIPE_BUFSZ 512 95 | #define RT_USING_SERIAL 96 | #define RT_USING_I2C 97 | #define RT_USING_I2C_BITOPS 98 | #define RT_USING_PIN 99 | #define RT_USING_RTC 100 | #define RT_USING_SDIO 101 | #define RT_SDIO_STACK_SIZE 512 102 | #define RT_SDIO_THREAD_PRIORITY 15 103 | #define RT_MMCSD_STACK_SIZE 1024 104 | #define RT_MMCSD_THREAD_PREORITY 22 105 | #define RT_MMCSD_MAX_PARTITION 16 106 | #define RT_USING_SPI 107 | 108 | /* Using USB */ 109 | 110 | 111 | /* POSIX layer and C standard library */ 112 | 113 | #define RT_USING_LIBC 114 | 115 | /* Network stack */ 116 | 117 | /* light weight TCP/IP stack */ 118 | 119 | #define RT_USING_LWIP 120 | #define RT_USING_LWIP202 121 | #define RT_LWIP_ICMP 122 | #define RT_LWIP_DNS 123 | #define RT_LWIP_DHCP 124 | #define IP_SOF_BROADCAST 1 125 | #define IP_SOF_BROADCAST_RECV 1 126 | 127 | /* Static IPv4 Address */ 128 | 129 | #define RT_LWIP_IPADDR "192.168.1.30" 130 | #define RT_LWIP_GWADDR "192.168.1.1" 131 | #define RT_LWIP_MSKADDR "255.255.255.0" 132 | #define RT_LWIP_UDP 133 | #define RT_LWIP_TCP 134 | #define RT_MEMP_NUM_NETCONN 8 135 | #define RT_LWIP_PBUF_NUM 16 136 | #define RT_LWIP_RAW_PCB_NUM 4 137 | #define RT_LWIP_UDP_PCB_NUM 4 138 | #define RT_LWIP_TCP_PCB_NUM 4 139 | #define RT_LWIP_TCP_SEG_NUM 40 140 | #define RT_LWIP_TCP_SND_BUF 8196 141 | #define RT_LWIP_TCP_WND 8196 142 | #define RT_LWIP_TCPTHREAD_PRIORITY 10 143 | #define RT_LWIP_TCPTHREAD_MBOX_SIZE 8 144 | #define RT_LWIP_TCPTHREAD_STACKSIZE 1024 145 | #define RT_LWIP_ETHTHREAD_PRIORITY 12 146 | #define RT_LWIP_ETHTHREAD_STACKSIZE 1024 147 | #define RT_LWIP_ETHTHREAD_MBOX_SIZE 8 148 | #define LWIP_NETIF_STATUS_CALLBACK 1 149 | #define SO_REUSE 1 150 | #define LWIP_SO_RCVTIMEO 1 151 | #define LWIP_SO_SNDTIMEO 1 152 | #define LWIP_SO_RCVBUF 1 153 | #define LWIP_NETIF_LOOPBACK 0 154 | 155 | /* Modbus master and slave stack */ 156 | 157 | 158 | /* VBUS(Virtual Software BUS) */ 159 | 160 | 161 | /* Utilities */ 162 | 163 | 164 | /* ARM CMSIS */ 165 | 166 | 167 | /* RT-Thread online packages */ 168 | 169 | /* IoT - internet of things */ 170 | 171 | 172 | /* Wi-Fi */ 173 | 174 | /* Marvell WiFi */ 175 | 176 | 177 | /* Wiced WiFi */ 178 | 179 | 180 | /* security packages */ 181 | 182 | 183 | /* language packages */ 184 | 185 | #define PKG_USING_LUA 186 | #define PKG_USING_LUA_LATEST_VERSION 187 | #define LUA_USING_PORTING_V534 188 | 189 | /* multimedia packages */ 190 | 191 | 192 | /* tools packages */ 193 | 194 | 195 | /* system packages */ 196 | 197 | #define PKG_USING_LITTLEVGL2RTT 198 | #define PKG_USING_LITTLEVGL2RTT_V001 199 | 200 | /* LittlevGL2RTT Options */ 201 | 202 | #define LV_MEM_DYNAMIC 203 | #define LV_MEM_CUSTOM 1 204 | #define LV_COLOR_DEPTH_16 205 | #define LV_COLOR_DEPTH 16 206 | #define LV_HOR_RES 480 207 | #define LV_VER_RES 272 208 | #define LV_DPI 50 209 | #define LITTLEVGL2RTT_USING_DEMO 210 | 211 | /* peripheral libraries and drivers */ 212 | 213 | 214 | /* miscellaneous packages */ 215 | 216 | 217 | /* sample package */ 218 | 219 | 220 | /* example package: hello */ 221 | 222 | #define SOC_IMXRT1052 223 | #define BOARD_USING_QSPIFLASH 224 | #define BOARD_RT1050_FIRE 225 | 226 | /* RT1050 Bsp Config */ 227 | 228 | /* Select uart drivers */ 229 | 230 | #define RT_USING_UART1 231 | 232 | /* Select spi bus and dev drivers */ 233 | 234 | #define LPSPI_CLK_SOURCE_FROM_PLL3PFD1 235 | #define LPSPI_CLK_SOURCE 0 236 | #define LPSPI_CLK_SOURCE_DIVIDER 8 237 | 238 | /* Select iic bus drivers */ 239 | 240 | 241 | /* Select lcd driver */ 242 | 243 | /* Notice: Fire Board para: 800*480 4 4 8 2 40 10 58 45 */ 244 | 245 | #define RT_USING_LCD 246 | #define LCD_WIDTH 480 247 | #define LCD_HEIGHT 272 248 | #define LCD_HFP 4 249 | #define LCD_VFP 4 250 | #define LCD_HBP 8 251 | #define LCD_VBP 2 252 | #define LCD_HSW 40 253 | #define LCD_VSW 10 254 | #define LCD_BL_PIN 106 255 | #define LCD_RST_PIN 45 256 | #define RT_USING_SDRAM 257 | 258 | #endif 259 | -------------------------------------------------------------------------------- /templates/ci_script_github/script_scons: -------------------------------------------------------------------------------- 1 | import os 2 | from building import * 3 | 4 | objs = [] 5 | cwd = GetCurrentDir() 6 | list = os.listdir(cwd) 7 | 8 | for item in list: 9 | if os.path.isfile(os.path.join(cwd, item, 'SConscript')): 10 | objs = objs + SConscript(os.path.join(item, 'SConscript')) 11 | 12 | Return('objs') 13 | -------------------------------------------------------------------------------- /templates/template-ci-github.yml: -------------------------------------------------------------------------------- 1 | language: c 2 | 3 | notifications: 4 | email: true 5 | 6 | git: 7 | depth: 1 8 | 9 | before_script: 10 | - USER_NAME='${username}' REPO_NAME='${pkgname}' 11 | 12 | - sudo apt-get update 13 | - "sudo apt-get -qq install gcc-multilib libc6:i386 libgcc1:i386 gcc-4.6-base:i386 libstdc++5:i386 libstdc++6:i386 libsdl-dev || true" 14 | - "[ $RTT_TOOL_CHAIN = 'sourcery-arm' ] && curl -s https://launchpadlibrarian.net/287101520/gcc-arm-none-eabi-5_4-2016q3-20160926-linux.tar.bz2 | sudo tar xjf - -C /opt && export RTT_EXEC_PATH=/opt/gcc-arm-none-eabi-5_4-2016q3/bin && /opt/gcc-arm-none-eabi-5_4-2016q3/bin/arm-none-eabi-gcc --version || true" 15 | 16 | - git clone --depth=3 --branch=master https://github.com/RT-Thread/rt-thread.git ../RT-Thread 17 | 18 | - export RTT_ROOT=/home/travis/build/$USER_NAME/RT-Thread 19 | - "[ x$RTT_CC == x ] && export RTT_CC='gcc' || true" 20 | 21 | - sudo mkdir $RTT_ROOT/bsp/$RTT_BSP/packages 22 | - sudo cp /home/travis/build/$USER_NAME/$REPO_NAME/script/script_bspcfg $RTT_ROOT/bsp/$RTT_BSP/rtconfig.h 23 | - sudo cp /home/travis/build/$USER_NAME/$REPO_NAME/script/script_scons $RTT_ROOT/bsp/$RTT_BSP/packages/SConscript 24 | - sudo cp -r /home/travis/build/$USER_NAME/$REPO_NAME $RTT_ROOT/bsp/$RTT_BSP/packages/$REPO_NAME 25 | 26 | script: 27 | - scons -C $RTT_ROOT/bsp/$RTT_BSP 28 | 29 | env: 30 | - RTT_BSP='imxrt1052-evk' RTT_TOOL_CHAIN='sourcery-arm' 31 | -------------------------------------------------------------------------------- /templates/template-kconfig: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/templates/template-kconfig -------------------------------------------------------------------------------- /templates/template-package.json: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rtpkgs/buildpkg/1480324a8e14c2dcef3cafae5cad4eba15dc6f19/templates/template-package.json -------------------------------------------------------------------------------- /templates/template-readme-rtt.md: -------------------------------------------------------------------------------- 1 | # ${pkgname} 2 | 3 | ## 1、介绍 4 | 5 | > 说明：你需要在这里对项目进行简单的介绍，描述项目背景，当前现状、功能特点等等…… 6 | 7 | 这是一个在 RT-Thread 上，用于演示的 package 。展示了一个 package 大致包括的内容，以及对应的一些模版文件。 8 | 9 | ### 1.1 目录结构 10 | 11 | > 说明：参考下面表格，整理出 packages 的目录结构 12 | 13 | | 名称 | 说明 | 14 | | ---- | ---- | 15 | | docs | 文档目录 | 16 | | examples | 例子目录，并有相应的一些说明 | 17 | | inc | 头文件目录 | 18 | | src | 源代码目录 | 19 | | port | 移植代码目录。如果没有移植代码，可以不需要 | 20 | 21 | ### 1.2 许可证 22 | 23 | > 说明：请在这里说明该 package 的授权许可，例如： GPLv2、LGPLv2.1、MIT、Apache license v2.0、BSD 等。 24 | 25 | hello package 遵循 LGPLv2.1 许可，详见 `LICENSE` 文件。 26 | 27 | ### 1.3 依赖 28 | 29 | > 说明：列出该 package 对于其他 package 、RT-Thread 操作系统版本等软件方面的依赖关系。 30 | 31 | - RT-Thread 3.0+ 32 | 33 | ## 2、如何打开 hello 34 | 35 | > 说明：描述该 package 位于 menuconfig 的位置，并对与其相关的配置进行介绍 36 | 37 | 使用 hello package 需要在 RT-Thread 的包管理器中选择它，具体路径如下： 38 | 39 | ``` 40 | RT-Thread online packages 41 | miscellaneous packages ---> 42 | [*] A hello package 43 | ``` 44 | 45 | 然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。 46 | 47 | ## 3、使用 ${pkgname} 48 | 49 | > 说明：在这里介绍 package 的移植步骤、使用方法、初始化流程、准备工作、API 等等，如果移植或 API 文档内容较多，可以将其独立至 `docs` 目录下。 50 | 51 | 在打开 hello package 后，当进行 bsp 编译时，它会被加入到 bsp 工程中进行编译。 52 | 53 | * 完整的 API 手册可以访问这个[链接](docs/api.md) 54 | * 更多文档位于 [`/docs`](/docs) 下，使用前 **务必查看** 55 | 56 | ## 4、注意事项 57 | 58 | > 说明：列出在使用这个 package 过程中需要注意的事项；列出常见的问题，以及解决办法。 59 | 60 | ## 5、联系方式 & 感谢 61 | 62 | * 维护：${username} 63 | * 主页：https://github.com/${username}/${pkgname} -------------------------------------------------------------------------------- /templates/template-readme.md: -------------------------------------------------------------------------------- 1 |
2 |

${pkgname}

3 | 4 | 12 | 13 | 24 | 25 |

你需要在这里对项目进行简单的介绍，描述项目背景，当前现状、功能特点等等...

26 |
27 | 28 | > 下面需要自由发挥了 29 | -------------------------------------------------------------------------------- /templates/template-sconscript-example.py: -------------------------------------------------------------------------------- 1 | import os 2 | from building import * 3 | 4 | # get current dir path 5 | cwd = GetCurrentDir() 6 | 7 | # init src and inc vars 8 | src = [] 9 | inc = [] 10 | 11 | # add libcsv common include 12 | inc = inc + [cwd] 13 | 14 | # add libcsv basic code 15 | src = src + Glob('./*.c') 16 | 17 | # add group to IDE project 18 | objs = DefineGroup('${pkgname}-${version}', src, depend = ['${pkgname_letter}_USING_DEMO'], CPPPATH = inc) 19 | 20 | Return('objs') 21 | -------------------------------------------------------------------------------- /templates/template-sconscript.py: -------------------------------------------------------------------------------- 1 | #-*- encoding: utf-8 -*- 2 | #--------------------------------------------------------------------------------- 3 | # @File: Sconscript for package 4 | # @Author: liu2guang 5 | # @Date: 2018-09-19 18:07:00(v0.1.0) 6 | # 7 | # @LICENSE: GPLv3: https://github.com/rtpkgs/buildpkg/blob/master/LICENSE. 8 | # 9 | #--------------------------------------------------------------------------------- 10 | import os 11 | from building import * 12 | Import('RTT_ROOT') 13 | Import('rtconfig') 14 | 15 | #--------------------------------------------------------------------------------- 16 | # Package configuration 17 | #--------------------------------------------------------------------------------- 18 | PKGNAME = "${pkgname}" 19 | VERSION = "${version}" 20 | DEPENDS = ["PKG_USING_${pkgname_letter}"] 21 | 22 | #--------------------------------------------------------------------------------- 23 | # Compile the configuration 24 | # 25 | # SOURCES: Need to compile c and c++ source, auto search when SOURCES is empty 26 | # 27 | # LOCAL_CPPPATH: Local file path (.h/.c/.cpp) 28 | # LOCAL_CCFLAGS: Local compilation parameter 29 | # LOCAL_ASFLAGS: Local assembly parameters 30 | # 31 | # CPPPATH: Global file path (.h/.c/.cpp), auto search when LOCAL_CPPPATH/CPPPATH 32 | # is empty # no pass!!! 33 | # CCFLAGS: Global compilation parameter 34 | # ASFLAGS: Global assembly parameters 35 | # 36 | # CPPDEFINES: Global macro definition 37 | # LOCAL_CPPDEFINES: Local macro definition 38 | # 39 | # LIBS: Specify the static library that need to be linked 40 | # LIBPATH: Specify the search directory for the library file (.lib/.a) 41 | # 42 | # LINKFLAGS: Link options 43 | #--------------------------------------------------------------------------------- 44 | SOURCES = [] 45 | 46 | LOCAL_CPPPATH = [] 47 | LOCAL_CCFLAGS = "" 48 | LOCAL_ASFLAGS = "" 49 | 50 | CPPPATH = [] 51 | CCFLAGS = "" 52 | ASFLAGS = "" 53 | 54 | CPPDEFINES = [] 55 | LOCAL_CPPDEFINES = [] 56 | 57 | LIBS = [] 58 | LIBPATH = [] 59 | 60 | LINKFLAGS = "" 61 | 62 | SOURCES_IGNORE = [] 63 | CPPPATH_IGNORE = [] 64 | 65 | #--------------------------------------------------------------------------------- 66 | # Feature clip configuration, optional 67 | #--------------------------------------------------------------------------------- 68 | if GetDepend(['XXX_USING_FUN1']) == True: 69 | pass 70 | 71 | if GetDepend(['XXX_USING_FUN2']) == False: 72 | pass 73 | 74 | #--------------------------------------------------------------------------------- 75 | # Compiler platform configuration, optional 76 | #--------------------------------------------------------------------------------- 77 | if rtconfig.CROSS_TOOL == "gcc": 78 | pass 79 | 80 | if rtconfig.CROSS_TOOL == "iar": 81 | pass 82 | 83 | if rtconfig.CROSS_TOOL == "keil": 84 | pass 85 | 86 | #--------------------------------------------------------------------------------- 87 | # Warning: internal related processing, developers do not modify!!! 88 | #--------------------------------------------------------------------------------- 89 | 90 | #--------------------------------------------------------------------------------- 91 | # System variables 92 | #--------------------------------------------------------------------------------- 93 | objs = [] 94 | root = GetCurrentDir() 95 | ignore = [] 96 | 97 | #--------------------------------------------------------------------------------- 98 | # Add relative path support for CPPPATH and LOCAL_CPPPATH 99 | #--------------------------------------------------------------------------------- 100 | for index, value in enumerate(CPPPATH): 101 | if string.find(value, root) == False: 102 | CPPPATH[index] = os.path.join(root, value) 103 | 104 | for index, value in enumerate(LOCAL_CPPPATH): 105 | if string.find(value, root) == False: 106 | LOCAL_CPPPATH[index] = os.path.join(root, value) 107 | 108 | if rtconfig.CROSS_TOOL == "gcc": # no test 109 | for index, value in enumerate(LIBS): 110 | if value.startswith("lib") == True: 111 | print("Automatic fix the nonstandard lib name, %s -> %s" % 112 | (LIBS[index], LIBS[index].lstrip("lib"))) 113 | LIBS[index] = LIBS[index].lstrip("lib") 114 | 115 | elif rtconfig.CROSS_TOOL == "keil": 116 | for index, value in enumerate(LIBS): 117 | if value.startswith("lib") == False: 118 | print("Automatic fix the nonstandard lib name, %s -> %s" % 119 | (LIBS[index], "lib" + LIBS[index])) 120 | LIBS[index] = "lib" + LIBS[index] 121 | 122 | LIBPATH += [root] 123 | 124 | #--------------------------------------------------------------------------------- 125 | # Auto search source files and paths, when SOURCES/CPPPATH/LOCAL_CPPPATH are empty 126 | #--------------------------------------------------------------------------------- 127 | _SOURCES_IGNORE = SOURCES_IGNORE + ${list_ignore_src} 128 | _CPPPATH_IGNORE = CPPPATH_IGNORE + ${list_ignore_inc} 129 | 130 | if not SOURCES: 131 | for dirpath, dirnames, filenames in os.walk(root): 132 | for name in filenames: 133 | suffix = os.path.splitext(name)[1] 134 | if (suffix == '.c' or suffix == '.cpp') and (not name in _SOURCES_IGNORE): 135 | SOURCES.append(os.path.join(dirpath, name)) 136 | 137 | if not LOCAL_CPPPATH and not CPPPATH: 138 | for dirpath, dirnames, filenames in os.walk(root): 139 | for dir in dirnames: 140 | abs_path = os.path.join(dirpath, dir) 141 | if (not ".git" in abs_path) and (not dir in _SOURCES_IGNORE): 142 | LOCAL_CPPPATH.append(abs_path) 143 | 144 | #--------------------------------------------------------------------------------- 145 | # Sub target 146 | #--------------------------------------------------------------------------------- 147 | list = os.listdir(root) 148 | if GetDepend(DEPENDS): 149 | for d in list: 150 | path = os.path.join(root, d) 151 | if os.path.isfile(os.path.join(path, 'SConscript')): 152 | objs = objs + SConscript(os.path.join(d, 'SConscript')) 153 | 154 | #--------------------------------------------------------------------------------- 155 | # Main target 156 | #--------------------------------------------------------------------------------- 157 | objs += DefineGroup(name = PKGNAME, src = SOURCES, depend = DEPENDS, 158 | CPPPATH = CPPPATH, 159 | CCFLAGS = CCFLAGS, 160 | ASFLAGS = ASFLAGS, 161 | LOCAL_CPPPATH = LOCAL_CPPPATH, 162 | LOCAL_CCFLAGS = LOCAL_CCFLAGS, 163 | LOCAL_ASFLAGS = LOCAL_ASFLAGS, 164 | CPPDEFINES = CPPDEFINES, 165 | LOCAL_CPPDEFINES = LOCAL_CPPDEFINES, 166 | LIBS = LIBS, 167 | LIBPATH = LIBPATH, 168 | LINKFLAGS = LINKFLAGS) 169 | 170 | Return("objs") 171 | #--------------------------------------------------------------------------------- 172 | # End 173 | #--------------------------------------------------------------------------------- 174 | --------------------------------------------------------------------------------