├── .github └── FUNDING.yml ├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── acronScript.py ├── helper.py └── requirements.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: Svision 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: Svision 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | .idea 3 | build 4 | dist -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 11 | build. 12 | 2. Update the README.md with details of changes to the interface, this includes new environment 13 | variables, exposed ports, useful file locations and container parameters. 14 | 3. Increase the version numbers in any examples files and the README.md to the new version that this 15 | Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 16 | 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 17 | do not have permission to do that, you may request the second reviewer to merge it for you. 18 | 19 | ## Code of Conduct 20 | 21 | ### Our Pledge 22 | 23 | In the interest of fostering an open and welcoming environment, we as 24 | contributors and maintainers pledge to making participation in our project and 25 | our community a harassment-free experience for everyone, regardless of age, body 26 | size, disability, ethnicity, gender identity and expression, level of experience, 27 | nationality, personal appearance, race, religion, or sexual identity and 28 | orientation. 29 | 30 | ### Our Standards 31 | 32 | Examples of behavior that contributes to creating a positive environment 33 | include: 34 | 35 | * Using welcoming and inclusive language 36 | * Being respectful of differing viewpoints and experiences 37 | * Gracefully accepting constructive criticism 38 | * Focusing on what is best for the community 39 | * Showing empathy towards other community members 40 | 41 | Examples of unacceptable behavior by participants include: 42 | 43 | * The use of sexualized language or imagery and unwelcome sexual attention or 44 | advances 45 | * Trolling, insulting/derogatory comments, and personal or political attacks 46 | * Public or private harassment 47 | * Publishing others' private information, such as a physical or electronic 48 | address, without explicit permission 49 | * Other conduct which could reasonably be considered inappropriate in a 50 | professional setting 51 | 52 | ### Our Responsibilities 53 | 54 | Project maintainers are responsible for clarifying the standards of acceptable 55 | behavior and are expected to take appropriate and fair corrective action in 56 | response to any instances of unacceptable behavior. 57 | 58 | Project maintainers have the right and responsibility to remove, edit, or 59 | reject comments, commits, code, wiki edits, issues, and other contributions 60 | that are not aligned to this Code of Conduct, or to ban temporarily or 61 | permanently any contributor for other behaviors that they deem inappropriate, 62 | threatening, offensive, or harmful. 63 | 64 | ### Scope 65 | 66 | This Code of Conduct applies both within project spaces and in public spaces 67 | when an individual is representing the project or its community. Examples of 68 | representing a project or community include using an official project e-mail 69 | address, posting via an official social media account, or acting as an appointed 70 | representative at an online or offline event. Representation of a project may be 71 | further defined and clarified by project maintainers. 72 | 73 | ### Enforcement 74 | 75 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 76 | reported by contacting the project team at [INSERT EMAIL ADDRESS]. All 77 | complaints will be reviewed and investigated and will result in a response that 78 | is deemed necessary and appropriate to the circumstances. The project team is 79 | obligated to maintain confidentiality with regard to the reporter of an incident. 80 | Further details of specific enforcement policies may be posted separately. 81 | 82 | Project maintainers who do not follow or enforce the Code of Conduct in good 83 | faith may face temporary or permanent repercussions as determined by other 84 | members of the project's leadership. 85 | 86 | ### Attribution 87 | 88 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 89 | available at [http://contributor-covenant.org/version/1/4][version] 90 | 91 | [homepage]: http://contributor-covenant.org 92 | [version]: http://contributor-covenant.org/version/1/4/ 93 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # UofT_CourseScript 2 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E0F4Y96) 3 | 4 | ## DISCLAIMER 5 | ***Using the scirpt could result your Utorid Account be blocked by admin!!!***\ 6 | ***USE AT YOUR OWN RISK!***\ 7 | ***NOT INTENDED FOR ANY COMMERCIAL USE*** 8 | 9 | ## Description 10 | UofT Course Script is a fully free open-source script written in Python with [Selenium](https://www.selenium.dev/) (automating web applications) to help UofT students get popular courses securely. 11 | 12 | ## Motivation 13 | There are already some agents who charge students to 'help' them get popular courses, and students usually need to provide their username and password. 14 | This behavior is not only very unsecure to themselves but also unfair for other students. 15 | 16 | ## Purpose 17 | ***This script is intended solely to provide a more fair and secure environment for UofT students' course enrollment.*** 18 | 19 | ## Usage 20 | 21 | ### Installation 22 | 23 | 1. Ensure [Python](https://www.python.org/downloads/) is installed on your machine. 24 | 25 | 2. Clone and navigate to the repository. 26 | ```bash 27 | cd path/to/UofT_CourseScript 28 | ``` 29 | 30 | 3. Install the necessary Python packages. 31 | ```bash 32 | pip3 install -r requirements.txt 33 | ``` 34 | 35 | 4. Run the script. 36 | ```bash 37 | python3 acronScript.py 38 | ``` 39 | 40 | ### First-Time Login 41 | 42 | #### Step 1: Update DUO Authentication Settings 43 | 44 | - Log into Acorn using your UTORid and password. 45 | - When prompted by DUO Security, click on `My Settings & Devices`. 46 | - Press the 'Send Me a Push' button and approve the notification on your DUO-authorized mobile device. 47 | - For "When I log in:", select "Ask me to choose an authentication method" and click "Save". 48 | 49 | #### Step 2: Generate Bypass Code 50 | 51 | On your first run of the script, you'll encounter the DUO Security prompt. 52 | 53 | #### Step 3: Approve DUO Mobile Request 54 | 55 | After generating the bypass code, your DUO-authorized mobile device will receive a request. Approve this to continue. **Note**: This step is a one-time requirement. 56 | 57 | ### Subsequent Runs 58 | 59 | Once the initial setup is complete, the script will operate autonomously without needing DUO mobile approvals. 60 | 61 | 62 | ## Future Work 63 | - ~~Bypass reCAPTCHA (no longer needed)~~ 64 | - ~~Bypass DUO~~ 65 | - ~~Specify Course timeslot~~ 66 | - ~~Multiple Courses support~~ 67 | - Support replacement courses (Drop course A if course B is available) 68 | - Better UI 69 | 70 | 71 | 72 | -------------------------------------------------------------------------------- /acronScript.py: -------------------------------------------------------------------------------- 1 | import json 2 | import random 3 | import time 4 | from datetime import datetime 5 | import re 6 | 7 | import webbrowser 8 | 9 | import requests 10 | import ssl 11 | from selenium.common.exceptions import TimeoutException 12 | from selenium.webdriver.common.by import By 13 | from selenium.webdriver.support import expected_conditions as EC 14 | from selenium.webdriver.support.ui import WebDriverWait as Wait 15 | from selenium.webdriver.chrome.options import Options 16 | import undetected_chromedriver as uc 17 | from tkinter import * 18 | from tkinter import messagebox 19 | from tkinter.ttk import * 20 | from helper import * 21 | from twocaptcha import TwoCaptcha 22 | 23 | UTORID = "" 24 | PASSWORD = "" 25 | bypass_codes = [] 26 | 27 | TARGET_COURSE_CODE = "" # example for CSC108 in UTSG: "CSC108H1" 28 | TARGET_SESSION_CODE = f"{datetime.now().year}{datetime.now().month}" # options are "yyyym" m is one of 1, 5, 9 29 | TARGET_SECTION_CODE = "" # example for Full Session: "Y", options are "Y", "F", "S" 30 | 31 | # Extension 32 | TARGET_COURSE_SECTION = "" 33 | MODIFY_TUT_MODE = False 34 | TARGET_TUT_SECTION_CODES = [] # TUT ["1001", "1002"] 35 | TARGET_LEC_SECTION_CODES = [] 36 | API_2CAPTCHA = "" 37 | SOLVER_2CAPTCHA: TwoCaptcha = None 38 | 39 | ERRNO = -1 40 | WAIT_TIME = 30 41 | BYPASS_URL = "https://bypass.utormfa.utoronto.ca/" 42 | ACORN_URL = "https://acorn.utoronto.ca/sws/#/" 43 | COURSE_URL = "https://acorn.utoronto.ca/sws/rest/enrolment/course/view?courseCode={courseCode}&courseSessionCode={sessionCode}&postCode=ASCRSHBSC§ionCode={sectionCode}&sessionCode={sessionCode}" 44 | COURSE_SESSION_URL = "https://acorn.utoronto.ca/sws/#/courses/{index}" 45 | hCaptcha_URL = "https://acorn.utoronto.ca/sws/#/captcha" 46 | ENROLL_STATUS = False 47 | RETRY_TIME = 5 48 | 49 | driver: uc.Chrome = None 50 | chrome_options = Options() 51 | chrome_options.add_argument("--disable-blink-features=AutomationControlled") 52 | 53 | 54 | def input_key(name: str, value: str, wait_time: int, find_type=By.ID): 55 | global driver 56 | Wait(driver, 10).until(EC.presence_of_element_located((find_type, name))) 57 | block = driver.find_element(by=find_type, value=name) 58 | block.send_keys(value) 59 | time.sleep(wait_time) 60 | 61 | 62 | def proceed(name: str, wait_time: int, find_type=By.NAME): 63 | global driver 64 | Wait(driver, 5).until(EC.presence_of_element_located((find_type, name))) 65 | btn = driver.find_element(by=find_type, value=name) 66 | btn.click() 67 | time.sleep(wait_time) 68 | 69 | 70 | def generate_bypass_code(): 71 | global driver, bypass_codes 72 | Wait(driver, 10).until(EC.presence_of_element_located((By.NAME, "generate"))) 73 | generate_btn = driver.find_element(by=By.NAME, value="generate") 74 | generate_btn.click() 75 | # Use XPath to extract the codes 76 | time.sleep(random.randint(2, 3)) 77 | div_innerHTML = driver.execute_script('return document.querySelector("main .site-container").innerHTML;') 78 | bypass_codes = re.findall(r'(\d{9})', div_innerHTML) 79 | if len(bypass_codes) != 0: 80 | print("Bypass codes generated:", bypass_codes) 81 | driver.quit() 82 | submit() 83 | 84 | 85 | def login(target_url: str): 86 | global driver 87 | driver.get(target_url) 88 | print("Logging in...") 89 | 90 | print("Entering Utroid and password...") 91 | input_key("username", UTORID, random.randint(1, 2)) 92 | input_key("password", PASSWORD, random.randint(1, 2)) 93 | 94 | try: 95 | proceed("_eventId_proceed", random.randint(1, 2)) 96 | except TimeoutException: 97 | pass 98 | 99 | Wait(driver, 10).until(EC.presence_of_element_located((By.ID, "auth-view-wrapper"))) 100 | 101 | if len(bypass_codes) == 0: 102 | try: 103 | proceed("auth-button.positive", random.randint(1, 2), By.CLASS_NAME) 104 | except Exception: 105 | pass 106 | print("Notification has been pushed, check your mobile devices...") 107 | timeout = 30 108 | else: 109 | print("Bypassing Duo Security...") 110 | proceed('button--link', random.randint(1, 2), By.CLASS_NAME) 111 | next_bypass_code = bypass_codes.pop() 112 | print("Using bypasscode:", next_bypass_code) 113 | proceed("[data-testid='test-id-bypass']", random.randint(1, 2), By.CSS_SELECTOR) 114 | input_key("passcode-input", next_bypass_code, random.randint(1, 2), By.NAME) 115 | proceed("[data-testid='verify-button']", random.randint(1, 2), By.CSS_SELECTOR) 116 | try: 117 | proceed('trust-browser-button', random.randint(1, 2), By.ID) 118 | except Exception: 119 | pass 120 | timeout = 10 121 | try: 122 | Wait(driver, timeout).until(EC.url_to_be(target_url)) 123 | print("Login success!") 124 | except TimeoutException: 125 | print('timeout, duo authentication failed...') 126 | driver.quit() 127 | driver.switch_to.default_content() 128 | 129 | 130 | # def check_captcha(): 131 | # if driver.current_url == hCaptcha_URL: 132 | # bypass_hCaptcha() 133 | # try: 134 | # Wait(driver, 600).until(EC.url_to_be(ACORN_URL)) 135 | # script_prompt() 136 | # except TimeoutException: 137 | # print("Time out, retrying...") 138 | # driver.quit() 139 | # submit() 140 | # print("Bypass SUCCESS!") 141 | # else: 142 | # try: 143 | # Wait(driver, 60).until(EC.url_to_be(ACORN_URL)) 144 | # script_prompt() 145 | # except TimeoutException: 146 | # print("Time out, retrying...") 147 | # driver.quit() 148 | # submit() 149 | # print("Login SUCCESS!\n") 150 | 151 | 152 | def create_session_request(url, body, method='post', json=False): 153 | session = requests.Session() 154 | cookies = driver.get_cookies() 155 | for cookie in cookies: 156 | session.cookies.set(cookie['name'], cookie['value']) 157 | content_type = 'text/plain' 158 | if json: 159 | content_type = 'application/json;charset=UTF-8' 160 | headers = { 161 | "accept": "application/json, text/plain, */*", 162 | "accept-language": "en-CA,en;q=0.9,zh-CN;q=0.8,zh;q=0.7", 163 | "content-type": content_type, 164 | "sec-ch-ua": '\"Not_A Brand\";v=\"99\", \"Google Chrome\";v=\"109\", \"Chromium\";v=\"109\"', 165 | "sec-ch-ua-mobile": "?0", 166 | "sec-ch-ua-platform": "\"macOS\"", 167 | "sec-fetch-dest": "empty", 168 | "sec-fetch-mode": "cors", 169 | "sec-fetch-site": "same-origin", 170 | "x-xsrf-token": driver.get_cookie('XSRF-TOKEN')['value'], 171 | "Referer": "https://acorn.utoronto.ca/sws/", 172 | "Referrer-Policy": "strict-origin-when-cross-origin" 173 | } 174 | if method == 'post': 175 | if json: 176 | return session.post(url, headers=headers, json=body) 177 | return session.post(url, headers=headers, data=body) 178 | else: 179 | return session.get(url, headers=headers, data=body) 180 | 181 | 182 | def bypass_hCaptcha(): 183 | if SOLVER_2CAPTCHA is None: 184 | print("Waiting manually bypass hCaptcha...") 185 | driver.switch_to.window(driver.current_window_handle) 186 | else: 187 | try: 188 | Wait(driver, 10).until(EC.presence_of_element_located((By.TAG_NAME, "iframe"))) 189 | except TimeoutException: 190 | print("Time out, retrying...") 191 | driver.quit() 192 | submit() 193 | site_key_element = driver.find_element(By.TAG_NAME, "iframe") 194 | site_src = site_key_element.get_attribute("src") 195 | start_idx = site_src.index('sitekey=') + 8 196 | end_idx = site_src.index('&theme') 197 | site_key = site_src[start_idx:end_idx] 198 | print('Solving Captcha ' + site_key) 199 | 200 | result = SOLVER_2CAPTCHA.hcaptcha( 201 | sitekey=site_key, 202 | url='https://acorn.utoronto.ca/sws/#/captcha' 203 | ) 204 | print('Captcha solved!') 205 | cookies = driver.get_cookies() 206 | s = requests.Session() 207 | for cookie in cookies: 208 | s.cookies.set(cookie['name'], cookie['value']) 209 | 210 | # submit 211 | body = result['code'] 212 | verify = create_session_request("https://acorn.utoronto.ca/sws/rest/captcha/verify", body) 213 | if verify.status_code == 200: 214 | driver.get(ACORN_URL) 215 | 216 | 217 | def script_prompt(): 218 | driver_body = driver.find_element(By.XPATH, value="/html/body") 219 | driver.execute_script( 220 | "arguments[0].innerText = 'Script working... DO NOT TURN OFF Chrome! Check Terminal for Detail.'", driver_body) 221 | 222 | 223 | def enroll_modify(sectionNo): 224 | tutorial = {} 225 | lecture = {} 226 | if MODIFY_TUT_MODE: 227 | tutorial = {"sectionNo": f"TUT,{sectionNo}"} 228 | else: 229 | lecture = {"sectionNo": f"LEC,{sectionNo}"} 230 | 231 | body = { 232 | "activeCourse": { 233 | "course": { 234 | "code": TARGET_COURSE_CODE, 235 | "sessionCode": TARGET_SESSION_CODE, 236 | "sectionCode": TARGET_SECTION_CODE, 237 | "primaryTeachMethod": "LEC", 238 | "enroled": False 239 | }, 240 | "lecture": lecture, 241 | "tutorial": tutorial, 242 | "practical": {} 243 | }, 244 | "eligRegParams": { 245 | "postCode": "ASCRSHBSC", 246 | "postDescription": "A&S Bachelor's Degree Program", 247 | "sessionCode": TARGET_SESSION_CODE, 248 | "sessionDescription": "", 249 | "status": "REG", 250 | "assocOrgCode": "", 251 | "acpDuration": "2", 252 | "levelOfInstruction": "U", 253 | "typeOfProgram": "BACS", 254 | "subjectCode1": "SCN", 255 | "designationCode1": "PGM", 256 | "primaryOrgCode": "ARTSC", 257 | "secondaryOrgCode": "", 258 | "collaborativeOrgCode": "", 259 | "adminOrgCode": "ARTSC", 260 | "coSecondaryOrgCode": "", 261 | "yearOfStudy": "", 262 | "postAcpDuration": "2", 263 | "useSws": "Y" 264 | } 265 | } 266 | enroll = create_session_request('https://acorn.utoronto.ca/sws/rest/enrolment/course/modify', body, json=True) 267 | if enroll.status_code == 200: 268 | enroll_success() 269 | else: 270 | print(enroll.text) 271 | print(f"Enroll failed ({enroll.status_code}), retrying...") 272 | print("Using UI to retry:") 273 | # find tab 274 | _type = "LEC" if not MODIFY_TUT_MODE else "TUT" 275 | index = 0 276 | if 1 < datetime.now().month < 9: 277 | index = 1 278 | course_session_url = COURSE_SESSION_URL.format( 279 | index=index) # Currently, have Fall/Winter and Summer session tabs 280 | driver.get(course_session_url) 281 | driver.refresh() 282 | search = Wait(driver, 10).until(EC.element_to_be_clickable((By.ID, "typeaheadInput"))) 283 | search.send_keys(TARGET_COURSE_CODE) 284 | time.sleep(random.randint(1, 3)) 285 | 286 | # find course 287 | course_span = driver.find_element(By.XPATH, 288 | value=f"//span[contains(text(), '{TARGET_COURSE_CODE} {TARGET_SECTION_CODE}')]") 289 | course_span.click() 290 | time.sleep(random.randint(1, 3)) 291 | 292 | # choose section 293 | course_section = driver.find_element(By.ID, value=f"course{_type}{sectionNo}") 294 | course_section.click() 295 | 296 | # modify_enrol 297 | modify_enrol_btn = driver.find_element(By.ID, value="enrol" if not MODIFY_TUT_MODE else "modify") 298 | modify_enrol_btn.click() 299 | time.sleep(random.randint(2, 4)) 300 | try: 301 | driver.find_element(By.ID, f"{TARGET_COURSE_CODE}-courseBox") 302 | enroll_success() 303 | except: 304 | print("Enroll failed, retrying...") 305 | 306 | 307 | def enroll_success(): 308 | global ENROLL_STATUS 309 | ENROLL_STATUS = True 310 | print("Enrollment SUCCESS!") 311 | driver.get("https://ko-fi.com/svision") 312 | messagebox.showinfo("Donation", "SUCCESS! Buy me a coffee ☕️: https://ko-fi.com/svision") 313 | 314 | 315 | def get_course_info(): 316 | try: 317 | course_url = COURSE_URL.format(courseCode=TARGET_COURSE_CODE, sectionCode=TARGET_SECTION_CODE, 318 | sessionCode=TARGET_SESSION_CODE) 319 | response = create_session_request(course_url, None, 'get') 320 | if response.status_code == 200: 321 | data = json.loads(response.text) 322 | else: 323 | print("hCaptcha detected!") 324 | driver.get(hCaptcha_URL) 325 | bypass_hCaptcha() 326 | return 327 | 328 | errors = data["messages"]["errors"] 329 | if errors: 330 | print("Error getting course info") 331 | exit(-1) 332 | 333 | print(f"\n{datetime.today()}") 334 | print("----------------------------") 335 | meetings = data["responseObject"]["meetings"] 336 | for meeting in meetings: 337 | teachMethod = meeting["teachMethod"] 338 | space_available = meeting["enrollmentSpaceAvailable"] 339 | total_space = meeting["totalSpace"] 340 | sectionNo = meeting["sectionNo"] 341 | display_name = meeting["displayName"] 342 | if (not MODIFY_TUT_MODE and teachMethod == "LEC" and (TARGET_LEC_SECTION_CODES == [] or 343 | sectionNo in TARGET_LEC_SECTION_CODES)) or ( 344 | teachMethod == "TUT" and sectionNo in TARGET_TUT_SECTION_CODES): 345 | if space_available != 0: 346 | print( 347 | f"{TARGET_COURSE_CODE} has {space_available} spaces left (total: {total_space}) for {display_name}") 348 | enroll_modify(sectionNo) 349 | if ENROLL_STATUS is True: 350 | return 351 | else: 352 | print(f"{TARGET_COURSE_CODE} has no space left for {display_name}") 353 | except Exception as e: 354 | global RETRY_TIME 355 | RETRY_TIME += 1 356 | raise e 357 | 358 | 359 | def submit(): 360 | global ERRNO 361 | global RETRY_TIME 362 | global UTORID 363 | UTORID = fields['utorid'].get() 364 | global PASSWORD 365 | PASSWORD = fields['password'].get() 366 | if UTORID == "" or PASSWORD == "": 367 | messagebox.showerror("Auth Error", "Both utorid and password cannot be empty") 368 | return 369 | if MODIFY_TUT_MODE: 370 | global TARGET_TUT_SECTION_CODES 371 | TARGET_TUT_SECTION_CODES = fields['tut'].get().split(',') 372 | 373 | global WAIT_TIME 374 | if not fields['wait_time'].get().isnumeric() and int(fields['wait_time'].get()) <= 0: 375 | messagebox.showerror("Wait Time Error", "Wait time must be a number greater than 0") 376 | return 377 | WAIT_TIME = int(fields['wait_time'].get()) 378 | global TARGET_LEC_SECTION_CODES 379 | if fields['specify_lec'].get() != "" and fields['specify_lec'].get() != "ALL": 380 | TARGET_LEC_SECTION_CODES = fields['specify_lec'].get().split(',') 381 | print(f'Checking LEC {TARGET_LEC_SECTION_CODES}') 382 | 383 | global TARGET_SECTION_CODE 384 | TARGET_SECTION_CODE = selected_section.get() 385 | 386 | # 2Captcha 387 | # global API_2CAPTCHA 388 | # global SOLVER_2CAPTCHA 389 | # if fields['2captcha'].get() != "" and fields['2captcha'].get() != "Enter API to bypass hCaptcha": 390 | # API_2CAPTCHA = fields['2captcha'].get() 391 | # if API_2CAPTCHA != "": 392 | # SOLVER_2CAPTCHA = TwoCaptcha(API_2CAPTCHA) 393 | # print("Solver created!") 394 | 395 | global driver 396 | driver = uc.Chrome(chrome_options=chrome_options) 397 | try: 398 | if len(bypass_codes) <= 1: 399 | login(BYPASS_URL) 400 | generate_bypass_code() 401 | login(ACORN_URL) 402 | 403 | global ENROLL_STATUS 404 | global TARGET_COURSE_CODE 405 | if selected_course_mode.get() == "Single Course": 406 | TARGET_COURSE_CODE = fields['course_code'].get() 407 | if TARGET_COURSE_CODE == "": 408 | messagebox.showerror("Course Code Error", "Course code cannot be empty") 409 | exit(-1) 410 | print(f"Checking {TARGET_COURSE_CODE} for {TARGET_SESSION_CODE}...") 411 | while True: 412 | get_course_info() 413 | if ENROLL_STATUS is True: 414 | window.destroy() 415 | driver.quit() 416 | exit(0) 417 | time.sleep(random.uniform(max(1, WAIT_TIME - 5), WAIT_TIME + 5)) 418 | else: 419 | num_courses = 0 420 | multiple_courses = ['course_code1', 'course_code2', 'course_code3', 'course_code4', 'course_code5'] 421 | for course_code_field in multiple_courses: 422 | if fields[course_code_field].get().strip() != "": 423 | num_courses += 1 424 | success_enrolled = [] 425 | while True: 426 | for course_code_field in multiple_courses: 427 | TARGET_COURSE_CODE = fields[course_code_field].get().strip() 428 | if TARGET_COURSE_CODE != "" and TARGET_COURSE_CODE not in success_enrolled: 429 | print(f"Checking {TARGET_COURSE_CODE} for {TARGET_SESSION_CODE}...") 430 | get_course_info() 431 | if ENROLL_STATUS is True: 432 | success_enrolled.append(TARGET_COURSE_CODE) 433 | if len(success_enrolled) == num_courses: 434 | window.destroy() 435 | driver.quit() 436 | exit(0) 437 | ENROLL_STATUS = False 438 | time.sleep(random.randint(2, 4)) 439 | time.sleep(random.uniform(max(1, WAIT_TIME - 5), WAIT_TIME + 5)) 440 | 441 | except Exception as e: 442 | if str(e).strip() == "ERROR_WRONG_USER_KEY": 443 | print("API Key is not right!") 444 | API_2CAPTCHA = "" 445 | if RETRY_TIME > 0: 446 | print(str(e)) 447 | print("Retrying...") 448 | driver.quit() 449 | if str(e).strip() != "Expecting value: line 1 column 1 (char 0)": 450 | RETRY_TIME -= 1 451 | submit() 452 | else: 453 | print(str(e)) 454 | exit(1) 455 | 456 | 457 | def donation(): 458 | webbrowser.open("https://ko-fi.com/svision") 459 | 460 | 461 | def update_course_mode(mode): 462 | # Define the order of the elements for each mode 463 | base_fields_first_half = [ 464 | 'utorid_label', 465 | 'utorid', 466 | 'password_label', 467 | 'password', 468 | 'session_code_label', 469 | 'course_mode_label', 470 | 'course_mode_rads', 471 | ] 472 | base_fields_second_half = [ 473 | 'wait_time_label', 474 | 'wait_time', 475 | 'course_session_code_label', 476 | 'course_session_code_rads', 477 | 'submit', 478 | 'signature', 479 | 'donation' 480 | ] 481 | single_course_fields = [ 482 | 'course_code_label', 483 | 'course_code', 484 | 'specify_lec_label', 485 | 'specify_lec_tip_label', 486 | 'specify_lec', 487 | 'tut_label', 488 | 'tut_toggle', 489 | 'tut' 490 | ] 491 | multiple_courses_fields = [ 492 | 'course_codes_label', 493 | 'course_code1', 494 | 'course_code2', 495 | 'course_code3', 496 | 'course_code4', 497 | 'course_code5' 498 | ] 499 | for _field in fields: 500 | fields[_field].pack_forget() 501 | if mode == "Single Course": 502 | for _field in base_fields_first_half + single_course_fields + base_fields_second_half: 503 | fields[_field].pack(anchor=W, padx=10, pady=5, fill=X) 504 | else: 505 | for _field in base_fields_first_half + multiple_courses_fields + base_fields_second_half: 506 | fields[_field].pack(anchor=W, padx=10, pady=5, fill=X) 507 | 508 | 509 | if __name__ == "__main__": 510 | ssl._create_default_https_context = ssl._create_unverified_context 511 | window = Tk() 512 | window.title("Acron Enrollment Helper") 513 | 514 | fields = {} 515 | fields['utorid_label'] = Label(window, text="Utorid:") 516 | fields['utorid'] = Entry(window, width=10) 517 | 518 | fields['password_label'] = Label(window, text="Password:") 519 | fields['password'] = Entry(window, width=10, show='*') 520 | 521 | if 8 <= datetime.today().month <= 12: 522 | TARGET_SECTION_CODE = f'{datetime.today().year}9' 523 | elif 1 <= datetime.today().month <= 2: 524 | TARGET_SECTION_CODE = f'{datetime.today().year}1' 525 | else: 526 | TARGET_SECTION_CODE = f'{datetime.today().year}5' 527 | fields['session_code_label'] = Label(window, text=f"Session Code: {TARGET_SECTION_CODE}") 528 | 529 | # Radio buttons for course mode selection 530 | fields['course_mode_label'] = Label(window, text="Enroll Mode:") 531 | fields['course_mode_rads'] = Frame(window) 532 | selected_course_mode = StringVar(None, "Single Course") 533 | rads = [ 534 | Radiobutton(fields['course_mode_rads'], text='Single Course', value="Single Course", 535 | variable=selected_course_mode, command=lambda: update_course_mode("Single Course")), 536 | Radiobutton(fields['course_mode_rads'], text='Multiple Courses', value="Multiple Courses", 537 | variable=selected_course_mode, command=lambda: update_course_mode("Multiple Courses")) 538 | ] 539 | for rad in rads: 540 | rad.pack(expand=True, side=LEFT) 541 | 542 | fields['course_code_label'] = Label(window, text="Course Code:") 543 | fields['course_code'] = EntryWithPlaceholder(window, 'CSC108H1', width=10) 544 | fields['specify_lec_label'] = Label(window, text="Specify Lec Sections:") 545 | fields['specify_lec_tip_label'] = Label(window, text="Code only (No 'LEC'), separated by ','") 546 | fields['specify_lec'] = EntryWithPlaceholder(window, 'ALL', width=10) 547 | 548 | fields['tut_label'] = Label(window, text="Modify TUT Mode") 549 | 550 | 551 | def toggle(): 552 | global MODIFY_TUT_MODE 553 | if fields['tut_toggle'].config('text')[-1] == 'ON': 554 | fields['tut_toggle'].config(text='OFF') 555 | MODIFY_TUT_MODE = False 556 | else: 557 | fields['tut_toggle'].config(text='ON') 558 | messagebox.showinfo("TUT Example", "TUT sections example (only valid if you already enrolled the course) " 559 | "\nNO SPACE:\n\n1001,1002") 560 | MODIFY_TUT_MODE = True 561 | 562 | 563 | fields['tut_toggle'] = Button(text="OFF", width=10, command=toggle) 564 | fields['tut'] = EntryWithPlaceholder(window, "Enter TUT sections separate by ','", width=10) 565 | 566 | fields['wait_time_label'] = Label(window, text="Refresh interval (in sec):") 567 | fields['wait_time'] = EntryWithPlaceholder(window, WAIT_TIME, width=10) 568 | 569 | fields['course_session_code_label'] = Label(window, text="Course Session Code:") 570 | fields['course_session_code_rads'] = Frame(window) 571 | if datetime.now().month == 1: 572 | section = "S" 573 | else: 574 | section = "F" 575 | selected_section = StringVar(None, section) 576 | rads = [ 577 | Radiobutton(fields['course_session_code_rads'], text='F', value="F", variable=selected_section), 578 | Radiobutton(fields['course_session_code_rads'], text='S', value="S", variable=selected_section), 579 | Radiobutton(fields['course_session_code_rads'], text='Y', value="Y", variable=selected_section) 580 | ] 581 | 582 | for field in fields: 583 | fields[field].pack(anchor=W, padx=10, pady=5, fill=X) 584 | for rad in rads: 585 | rad.pack(expand=True, side=LEFT) 586 | 587 | fields['submit'] = Button(window, text="Submit", command=submit) 588 | fields['submit'].pack(side=BOTTOM) 589 | 590 | fields['signature'] = Label(window, text="Made with ❤️ by Changhao Song") 591 | fields['signature'].pack() 592 | 593 | fields['donation'] = Button(window, text="Buy me a coffee ☕️", command=donation) 594 | fields['donation'].pack() 595 | 596 | # Multiple Course Mode 597 | fields['course_codes_label'] = Label(window, text="Course Codes:") 598 | fields['course_code1'] = Entry(window, width=10) 599 | fields['course_code2'] = Entry(window, width=10) 600 | fields['course_code3'] = Entry(window, width=10) 601 | fields['course_code4'] = Entry(window, width=10) 602 | fields['course_code5'] = Entry(window, width=10) 603 | 604 | update_course_mode(selected_course_mode.get()) 605 | window.mainloop() 606 | -------------------------------------------------------------------------------- /helper.py: -------------------------------------------------------------------------------- 1 | import tkinter as tk 2 | 3 | 4 | class EntryWithPlaceholder(tk.Entry): 5 | def __init__(self, master=None, placeholder="PLACEHOLDER", color='grey', width=10): 6 | super().__init__(master, width=width) 7 | 8 | self.placeholder = placeholder 9 | self.placeholder_color = color 10 | self.default_fg_color = self['fg'] 11 | 12 | self.bind("", self.foc_in) 13 | self.bind("", self.foc_out) 14 | 15 | self.put_placeholder() 16 | 17 | def put_placeholder(self): 18 | self.insert(0, self.placeholder) 19 | self['fg'] = self.placeholder_color 20 | 21 | def foc_in(self, *args): 22 | if self['fg'] == self.placeholder_color: 23 | self.delete('0', 'end') 24 | self['fg'] = self.default_fg_color 25 | 26 | def foc_out(self, *args): 27 | if not self.get(): 28 | self.put_placeholder() 29 | 30 | 31 | class AnyEc: 32 | """ Use with WebDriverWait to combine expected_conditions 33 | in an OR. 34 | """ 35 | def __init__(self, *args): 36 | self.ecs = args 37 | 38 | def __call__(self, driver): 39 | for fn in self.ecs: 40 | try: 41 | res = fn(driver) 42 | if res: 43 | return True 44 | # Or return res if you need the element found 45 | except: 46 | pass 47 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | selenium==4.9.1 2 | selenium-requests==2.0.3 3 | webdriver-manager==4.0.2 4 | pillow==10.2.0 5 | 2captcha-python==1.2.2 6 | undetected_chromedriver==3.5.4 7 | requests==2.31.0 8 | setuptools==69.0.3 9 | 10 | --------------------------------------------------------------------------------