spelling correction

Create LICENSE

.env.example

@@ -1,6 +1,6 @@
 mongoURI=mongodb://localhost:27017
 dbo=school
-secret=
+secret=<your 256 bit secret>
 PORT=8000
-SYSTEM_EMAIL=
-SYSTEM_PASSWORD=
+SYSTEM_EMAIL=<your system email>
+SYSTEM_PASSWORD=<your system password>

.gitignore

@@ -3,7 +3,14 @@
 
 # Pycache
 /test/__pycache__/*
+/test/util/__pycache__/*
+/test/scheduleGenerator/__pycache__/*
+
+# Test
+/test/test.py
 
 # Test output
-/test/schedule.json
-/test/students.json
+/test/output/*
+
+# Sample Data
+/test/sample_data/*

LICENSE

@@ -1,21 +1,674 @@
-MIT License
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Copyright (c) 2022 Braeden Sowinski
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+                            Preamble
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -8,21 +8,21 @@ The backend API for a school management system accessible by staff and students.
 
 ## About The Project
 
-Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complains
+Originally started as a personal project to improve my overall Go knowledge and skills, driven by the complaints
 of my current school management system for students to view their grades, credits, course selections etc. I took
 this on as a full project to work on for my Software Engineering class and is now a staple of my work. I plan to
 work on this till completion, starting with this API, and then the front end, learning new tricks and languages
 along the way.
 
-## Future Plans
+I highly recommend looking at the testing for [schedule generation](/test/scheduleGenerator), [version 3](/test/scheduleGenerator/generator_v3.py)
+
+## Related Work
 
 After the majority completion of vital api functionalities such as the ability to update information, create new
-information, generate information, delete information, authentication etc. I plan on creating a new repository 
-for a new frontier of this project. I plan on making the [School Management Website](https://github.com/SowinskiBraeden/school-management-website).
+information, generate information, delete information, authentication etc. I have created a new repository 
+for the next frontier of this project. I am now concurrently working on the [School Management Website](https://github.com/SowinskiBraeden/school-management).
 
-This is most likely going to be written in another programming language or framework I am unfamiliar with. The 
-idea is to have a modern designed website capable of being used easily on any device or platform. I may use the
-[React.js](https://reactjs.org/) or [Vue.js](https://vuejs.org/) frameworks to build the front end design.
+The School Management Website. is going to be written using the [Vue.js](https://vuejs.org/) framework. Vue.js is a popular framwork for working on frontend UI programs. I am currently unfamiliar with the framework but plan on learning the framework to use it more in the future.
 <br>
 
 ### Built With
@@ -33,7 +33,7 @@ idea is to have a modern designed website capable of being used easily on any de
 
 ## Getting Started
 
-The systems is easy to start and your local machine. Eliminating and long unforgiving configurations you may face in other software.
+The systems is easy to start and your local machine. Eliminating any long unforgiving configurations you may face in other software.
 
 ### Installation
 
@@ -43,20 +43,34 @@ The systems is easy to start and your local machine. Eliminating and long unforg
     $ cd school-management-api
 ```
 
+<br>
+
 2. Rename `.env.example` to `.env`
+
+<br>
+
 3. Enter desired values into `.env`
 ```
     mongoURI='your mongo URI'
     dbo=school
-    secret='your secret'
+    secret='your 256 bit secret'
     PORT='your desired port'
     SYSTEM_EMAIL='your system email'
     SYSTEM_PASSWORD='your system email password'
 ```
-4. Run the sytem in your console
+
+<br>
+
+4. Run the system in your console
 ```
   go run main.go
 ```
+
+* The first time the API is run, you will be promted to enter in the systems defualt administrator account detials.
+ This is required, in order to use majority of the API you'll need to be in an authenticated admin account.
+
+<br>
+
 5. Build and compile the system into an executable
 ```
   go build

controllers/authController.go

@@ -1,12 +1,16 @@
 package controllers
 
 import (
+	"bufio"
 	"context"
+	"fmt"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/SowinskiBraeden/school-management-api/database"
 	"github.com/SowinskiBraeden/school-management-api/models"
+	"github.com/howeyc/gopass"
 
 	"net/smtp"
 
@@ -23,6 +27,58 @@ var studentCollection *mongo.Collection = database.OpenCollection(database.Clien
 var contactCollection *mongo.Collection = database.OpenCollection(database.Client, "contacts")
 var adminCollection *mongo.Collection = database.OpenCollection(database.Client, "admins")
 
+func NewSystem() {
+	count, err := adminCollection.CountDocuments(context.Background(), bson.D{})
+	if err != nil {
+		fmt.Println("Unable to detect new system")
+	}
+
+	if count == 0 {
+		fmt.Println("Admin account setup...")
+		reader := bufio.NewReader(os.Stdin)
+		fmt.Print("First Name: ")
+		firstname, _ := reader.ReadString('\n')
+		fmt.Print("Last Name: ")
+		lastname, _ := reader.ReadString('\n')
+		fmt.Print("Email: ")
+		email, _ := reader.ReadString('\n')
+		fmt.Print("Password: ")
+		password, _ := gopass.GetPasswd()
+
+		var admin models.Admin
+		admin.FirstName = strings.TrimSuffix(firstname, "\n")
+		admin.LastName = strings.TrimSuffix(lastname, "\n")
+		admin.Email = strings.TrimSuffix(email, "\n")
+
+		admin.SchoolEmail = admin.GenerateSchoolEmail()
+
+		pass := strings.TrimSuffix(string(password), "\n")
+		admin.Password = admin.HashPassword(pass)
+		admin.TempPassword = false
+
+		var aid string
+		for {
+			aid = GenerateID(6)
+			if ValidateID(aid) == true {
+				break
+			}
+		}
+		admin.AID = aid
+
+		admin.Created_at, _ = time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
+		admin.Updated_at, _ = time.Parse(time.RFC3339, time.Now().Format(time.RFC3339))
+		admin.ID = primitive.NewObjectID()
+
+		_, insertErr := adminCollection.InsertOne(context.Background(), admin)
+		if insertErr != nil {
+			fmt.Print("Failed to create admin")
+		}
+
+		fmt.Println("Successfully created system admin")
+		fmt.Println("Your admin ID is ", aid)
+	}
+}
+
 var SecretKey = os.Getenv("secret")
 
 var systemEmail string = os.Getenv("SYSTEM_EMAIL")
@@ -78,7 +134,7 @@ func Enroll(c *fiber.Ctx) error {
 
 	if err := c.BodyParser(&data); err != nil {
 		cancel()
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
 			"message": "Failed to parse body",
 			"error":   err,
@@ -207,7 +263,7 @@ func Enroll(c *fiber.Ctx) error {
 	}
 	defer cancel()
 
-	return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully inserted student",
 	})
@@ -252,7 +308,7 @@ func RegisterTeacher(c *fiber.Ctx) error {
 	teacher.PersonalData.Province = data["province"].(string)
 	teacher.PersonalData.City = data["city"].(string)
 	teacher.PersonalData.Postal = data["postal"].(string)
-	teacher.PersonalData.DOB = data["postal"].(string)
+	teacher.PersonalData.DOB = data["dob"].(string)
 
 	var photo models.Photo
 	photo.Name = uuid.New().String()
@@ -445,7 +501,7 @@ func StudentLogin(c *fiber.Ctx) error {
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 			"error":   err,
@@ -481,7 +537,7 @@ func StudentLogin(c *fiber.Ctx) error {
 
 	if localAccountDisabled || student.AccountData.AccountDisabled {
 		cancel()
-		return c.Status(fiber.StatusForbidden).JSON(fiber.Map{
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
 			"message": "Account is Disabled, contact an Admin",
 		})
@@ -510,7 +566,7 @@ func StudentLogin(c *fiber.Ctx) error {
 				"error":   updateErr,
 			})
 		}
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
@@ -571,9 +627,9 @@ func TeacherLogin(c *fiber.Ctx) error {
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
-			"message": "student not found",
+			"message": "teacher not found",
 			"error":   err,
 		})
 	}
@@ -581,7 +637,7 @@ func TeacherLogin(c *fiber.Ctx) error {
 
 	var verified bool = teacher.ComparePasswords(data["password"])
 	if verified == false {
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
@@ -641,7 +697,7 @@ func AdminLogin(c *fiber.Ctx) error {
 
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "admin not found",
 			"error":   err,
@@ -651,7 +707,7 @@ func AdminLogin(c *fiber.Ctx) error {
 
 	var verified bool = admin.ComparePasswords(data["password"])
 	if verified == false {
-		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "incorrect password",
 		})
@@ -722,27 +778,27 @@ func Student(c *fiber.Ctx) error {
 		sid = claims.Issuer
 	}
 
-	responceData := make(map[string]interface{})
-	responceData["student"] = nil
-	responceData["locker"] = nil
-	responceData["contacts"] = nil
-	responceData["photo"] = nil
+	responseData := make(map[string]interface{})
+	responseData["student"] = nil
+	responseData["locker"] = nil
+	responseData["contacts"] = nil
+	responseData["photo"] = nil
 
 	var student models.Student
 	findErr := studentCollection.FindOne(context.TODO(), bson.M{"schooldata.sid": sid}).Decode(&student)
 	if findErr != nil {
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 		})
 	}
 
-	responceData["student"] = student
+	responseData["student"] = student
 
 	var locker models.Locker
 	if student.SchoolData.Locker != "" {
 		lockerCollection.FindOne(context.TODO(), bson.M{"ID": student.SchoolData.Locker}).Decode(&locker)
-		responceData["locker"] = locker
+		responseData["locker"] = locker
 	}
 
 	var contacts []models.Contact
@@ -750,24 +806,24 @@ func Student(c *fiber.Ctx) error {
 	for i := range student.PersonalData.Contacts {
 		findErr := contactCollection.FindOne(context.TODO(), bson.M{"_id": student.PersonalData.Contacts[i]}).Decode(&contact)
 		if findErr != nil {
-			responceData["error"] = "Error! There was an error finding some contacts"
+			responseData["error"] = "Error! There was an error finding some contacts"
 		}
 		contacts = append(contacts, contact)
 	}
 	if len(contacts) > 0 {
-		responceData["contacts"] = contacts
+		responseData["contacts"] = contacts
 	}
 
 	var photo models.Photo
 	findErr = imageCollection.FindOne(context.TODO(), bson.M{"name": student.SchoolData.PhotoName}).Decode(&photo)
 	if findErr != nil {
-		responceData["error"] = "Error! There was an error finding the student photo"
+		responseData["error"] = "Error! There was an error finding the student photo"
 	}
-	responceData["photo"] = photo
+	responseData["photo"] = photo
 
 	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
 		"success":  true,
-		"responce": responceData,
+		"response": responseData,
 	})
 }
 
@@ -778,7 +834,7 @@ func Teacher(c *fiber.Ctx) error {
 		return []byte(SecretKey), nil
 	})
 	if err != nil {
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
 			"success": false,
 			"message": "not authorized",
 		})
@@ -789,13 +845,13 @@ func Teacher(c *fiber.Ctx) error {
 	var teacher models.Teacher
 	findErr := teacherCollection.FindOne(context.TODO(), bson.M{"schooldata.tid": claims.Issuer}).Decode(&teacher)
 	if findErr != nil {
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "teacher not found",
 		})
 	}
 
-	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully logged into teacher",
 		"result":  teacher,
@@ -820,13 +876,13 @@ func Admin(c *fiber.Ctx) error {
 	var admin models.Admin
 	findErr := adminCollection.FindOne(context.TODO(), bson.M{"aid": claims.Issuer}).Decode(&admin)
 	if findErr != nil {
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "admin not found",
 		})
 	}
 
-	return c.Status(fiber.StatusAccepted).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "successfully logged into admin",
 		"result":  admin,
@@ -968,7 +1024,7 @@ func DeleteContact(c *fiber.Ctx) error {
 	_, err := contactCollection.DeleteOne(ctx, bson.M{"_id": data["id"]})
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
 			"message": "Failed to delete object",
 			"error":   err,
@@ -976,7 +1032,7 @@ func DeleteContact(c *fiber.Ctx) error {
 	}
 	defer cancel()
 
-	return c.Status(fiber.StatusNotImplemented).JSON(fiber.Map{
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
 		"message": "Successfully deleted contact",
 	})

controllers/updateController.go

@@ -273,7 +273,7 @@ func UpdateStudentPassword(c *fiber.Ctx) error {
 	findErr := studentCollection.FindOne(ctx, bson.M{"schooldata.sid": claims.Issuer}).Decode(&student)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 		})
@@ -290,9 +290,9 @@ func UpdateStudentPassword(c *fiber.Ctx) error {
 
 	if !student.ComparePasswords(data["password"]) {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
-			"message": "Your current password is incorrect",
+			"message": "Your password is incorrect",
 		})
 	}
 
@@ -373,7 +373,7 @@ func ResetStudentPassword(c *fiber.Ctx) error {
 	findErr := studentCollection.FindOne(context.TODO(), bson.M{"schooldata.sid": data["sid"]}).Decode(&student)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 		})
@@ -381,7 +381,7 @@ func ResetStudentPassword(c *fiber.Ctx) error {
 
 	if student.PersonalData.Email != data["email"] {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "Your personal email is incorrect",
 		})
@@ -468,7 +468,7 @@ func UpdateStudentLocker(c *fiber.Ctx) error {
 	err := lockerCollection.FindOne(ctx, bson.M{"lockernumber": data["lockernumber"]}).Decode(&locker)
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "locker not found",
 			"error":   err,
@@ -569,7 +569,7 @@ func UpdateStudentAddress(c *fiber.Ctx) error {
 	})
 }
 
-// In the case a student gets help back a grade, we need to update their YOG (Year of Graduation)
+// In the case a student gets held back a grade, we need to update their YOG (Year of Graduation)
 func UpdateStudentYOG(c *fiber.Ctx) error {
 	var data map[string]string
 	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
@@ -605,7 +605,7 @@ func UpdateStudentYOG(c *fiber.Ctx) error {
 	findErr := studentCollection.FindOne(context.TODO(), bson.M{"schooldata.sid": data["sid"]}).Decode(&student)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "student not found",
 		})
@@ -676,7 +676,7 @@ func RemoveStudentContact(c *fiber.Ctx) error {
 	err := contactCollection.FindOne(ctx, bson.M{"_id": data["contactid"]}).Decode(&contact)
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "contact not found",
 			"error":   err,
@@ -750,7 +750,7 @@ func AddStudentContact(c *fiber.Ctx) error {
 	err := contactCollection.FindOne(ctx, bson.M{"_id": data["contactid"]}).Decode(&contact)
 	if err != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "contact not found",
 			"error":   err,
@@ -815,7 +815,7 @@ func UpdateStudentPhoto(c *fiber.Ctx) error {
 	findErr := studentCollection.FindOne(context.TODO(), bson.M{"schooldata.sid": sid}).Decode(&student)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "the student could not be found",
 			"error":   findErr,
@@ -1026,7 +1026,7 @@ func RemoveStudentsDisabled(c *fiber.Ctx) error {
 
 	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
-		"message": "successfully re-enabled student account",
+		"message": "successfully enabled student account",
 		"result":  result,
 	})
 }
@@ -1080,7 +1080,7 @@ func RemoveTeachersDisabled(c *fiber.Ctx) error {
 		cancel()
 		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
 			"success": false,
-			"message": "the student account could not be re-enabled",
+			"message": "the teacher account could not be enabled",
 			"error":   updateErr,
 		})
 	}
@@ -1088,7 +1088,7 @@ func RemoveTeachersDisabled(c *fiber.Ctx) error {
 
 	return c.Status(fiber.StatusOK).JSON(fiber.Map{
 		"success": true,
-		"message": "successfully re-enabled teacher account",
+		"message": "successfully enabled teacher account",
 		"result":  result,
 	})
 }
@@ -1197,7 +1197,7 @@ func UpdateTeacherPassword(c *fiber.Ctx) error {
 	findErr := studentCollection.FindOne(ctx, bson.M{"schooldata.tid": claims.Issuer}).Decode(&teacher)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "teacher not found",
 		})
@@ -1214,9 +1214,9 @@ func UpdateTeacherPassword(c *fiber.Ctx) error {
 
 	if !teacher.ComparePasswords(data["password"]) {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
-			"message": "Your current password is incorrect",
+			"message": "Your password is incorrect",
 		})
 	}
 
@@ -1224,7 +1224,7 @@ func UpdateTeacherPassword(c *fiber.Ctx) error {
 		cancel()
 		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
-			"message": "Your new password must match",
+			"message": "Your new passwords must match",
 		})
 	}
 
@@ -1296,7 +1296,7 @@ func ResetTeacherPassword(c *fiber.Ctx) error {
 	findErr := teacherCollection.FindOne(context.TODO(), bson.M{"schooldata.tid": data["tid"]}).Decode(&teacher)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "teacher not found",
 		})
@@ -1304,7 +1304,7 @@ func ResetTeacherPassword(c *fiber.Ctx) error {
 
 	if teacher.PersonalData.Email != data["email"] {
 		cancel()
-		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
 			"success": false,
 			"message": "Your personal email is incorrect",
 		})
@@ -1446,9 +1446,9 @@ func UpdateTeacherPhoto(c *fiber.Ctx) error {
 	findErr := teacherCollection.FindOne(context.TODO(), bson.M{"schooldata.tid": tid}).Decode(&teacher)
 	if findErr != nil {
 		cancel()
-		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
-			"message": "the student could not be found",
+			"message": "the teacher could not be found",
 			"error":   findErr,
 		})
 	}
@@ -1632,7 +1632,7 @@ func UpdateTeacherName(c *fiber.Ctx) error {
 	teacherObjectId, idErr := primitive.ObjectIDFromHex(data["_id"])
 	if idErr != nil {
 		cancel()
-		return c.Status(fiber.StatusNotFound).JSON(fiber.Map{
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
 			"success": false,
 			"message": "teacher not found",
 			"error":   idErr,
@@ -2101,3 +2101,180 @@ func UpdateLockerCombo(c *fiber.Ctx) error {
 		"result":  result,
 	})
 }
+
+func RemoveStudent(c *fiber.Ctx) error {
+	var data map[string]string
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+
+	if err := c.BodyParser(&data); err != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "Failed to parse body",
+			"error":   err,
+		})
+	}
+
+	// Ensure Authenticated admin sent request
+	if !AuthAdmin(c) {
+		cancel()
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+			"success": false,
+			"message": "Unauthorized: only an admin can perform this action",
+		})
+	}
+
+	// Check student id is included
+	if data["sid"] == "" {
+		cancel()
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"success": false,
+			"message": "missing required fields",
+		})
+	}
+
+	_, deleteErr := idCollection.DeleteOne(ctx, bson.M{"cid": data["sid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the identification number could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+
+	result, deleteErr := studentCollection.DeleteOne(ctx, bson.M{"schooldata.sid": data["sid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the student could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+	defer cancel()
+
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
+		"success": true,
+		"message": "successfully deleted student",
+		"result":  result,
+	})
+}
+
+func RemoveTeacher(c *fiber.Ctx) error {
+	var data map[string]string
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+
+	if err := c.BodyParser(&data); err != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "Failed to parse body",
+			"error":   err,
+		})
+	}
+
+	// Ensure Authenticated admin sent request
+	if !AuthAdmin(c) {
+		cancel()
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+			"success": false,
+			"message": "Unauthorized: only an admin can perform this action",
+		})
+	}
+
+	// Check student id is included
+	if data["tid"] == "" {
+		cancel()
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"success": false,
+			"message": "missing required fields",
+		})
+	}
+
+	_, deleteErr := idCollection.DeleteOne(ctx, bson.M{"cid": data["tid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the identification number could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+
+	result, deleteErr := teacherCollection.DeleteOne(ctx, bson.M{"schooldata.tid": data["tid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the teacher could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+	defer cancel()
+
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
+		"success": true,
+		"message": "successfully deleted teacher",
+		"result":  result,
+	})
+}
+
+func RemoveAdmin(c *fiber.Ctx) error {
+	var data map[string]string
+	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
+
+	if err := c.BodyParser(&data); err != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "Failed to parse body",
+			"error":   err,
+		})
+	}
+
+	// Ensure Authenticated admin sent request
+	if !AuthAdmin(c) {
+		cancel()
+		return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
+			"success": false,
+			"message": "Unauthorized: only an admin can perform this action",
+		})
+	}
+
+	// Check student id is included
+	if data["aid"] == "" {
+		cancel()
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"success": false,
+			"message": "missing required fields",
+		})
+	}
+
+	_, deleteErr := idCollection.DeleteOne(ctx, bson.M{"cid": data["aid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the identification number could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+
+	result, deleteErr := adminCollection.DeleteOne(ctx, bson.M{"aid": data["aid"]})
+	if deleteErr != nil {
+		cancel()
+		return c.Status(fiber.StatusInternalServerError).JSON(fiber.Map{
+			"success": false,
+			"message": "the admin could not be deleted",
+			"error":   deleteErr,
+		})
+	}
+	defer cancel()
+
+	return c.Status(fiber.StatusOK).JSON(fiber.Map{
+		"success": true,
+		"message": "successfully deleted admin",
+		"result":  result,
+	})
+}

go.mod

@@ -7,6 +7,7 @@ require (
 	github.com/gofiber/fiber/v2 v2.26.0
 	github.com/google/go-cmp v0.5.6 // indirect
 	github.com/google/uuid v1.3.0
+	github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef
 	github.com/joho/godotenv v1.3.0
 	github.com/stretchr/testify v1.7.0 // indirect
 	go.mongodb.org/mongo-driver v1.7.2

go.sum

@@ -42,6 +42,8 @@ github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
 github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef h1:A9HsByNhogrvm9cWb28sjiS3i7tcKCkflWFEkHfuAgM=
+github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef/go.mod h1:lADxMC39cJJqL93Duh1xhAs4I2Zs8mKS89XWXFGp9cs=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
 github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
@@ -128,6 +130,7 @@ golang.org/x/sys v0.0.0-20210514084401-e8d321eab015/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211205182925-97ca703d548d h1:FjkYO/PPp4Wi0EAUOVLxePm7qVW4r4ctbWpURyuOD0E=
 golang.org/x/sys v0.0.0-20211205182925-97ca703d548d/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 h1:v+OssWQX+hTHEmOBgwxdZxK4zHq3yOs8F9J7mk0PY8E=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

main.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/SowinskiBraeden/school-management-api/routes"
@@ -10,7 +11,10 @@ import (
 	"github.com/gofiber/fiber/v2/middleware/cors"
 )
 
+const version string = "\nv0.8.8-Alpha"
+
 func main() {
+	fmt.Println(version)
 	app := fiber.New()
 
 	app.Use(cors.New(cors.Config{

routes/routes.go

@@ -7,10 +7,20 @@ import (
 )
 
 func Setup(app *fiber.App) {
-	// API Handling
+	// Detect if system is new and needs default admin
+	controllers.NewSystem()
 
+	// API Handling
 	var routerPrefix string = "/api/v1"
 
+	// API check
+	app.Get(routerPrefix+"/status", func(c *fiber.Ctx) error {
+		return c.Status(fiber.StatusOK).JSON(fiber.Map{
+			"success": true,
+			"message": "the API is active",
+		})
+	})
+
 	// Student Authentication Handler
 	app.Get(routerPrefix+"/student", controllers.Student)
 	app.Post(routerPrefix+"/student/enroll", controllers.Enroll)
@@ -67,6 +77,11 @@ func Setup(app *fiber.App) {
 	app.Post(routerPrefix+"/admin/renableStudent", controllers.RemoveStudentsDisabled)
 	app.Post(routerPrefix+"/admin/renableTeacher", controllers.RemoveTeachersDisabled)
 
+	// Delete Handler
+	app.Post(routerPrefix+"/remove/student", controllers.RemoveStudent)
+	app.Post(routerPrefix+"/remove/teacher", controllers.RemoveTeacher)
+	app.Post(routerPrefix+"/remove/admin", controllers.RemoveAdmin)
+
 	// 404 Handler
 	app.Use(func(c *fiber.Ctx) error {
 		return c.SendStatus(404) // => 404 "Not Found"

test/README.md

@@ -0,0 +1,13 @@
+# Testing
+
+Hello there! If you are in this part of the codespace, I have cleaned it up compared to the 
+original codespace. The algorithms have been moved out of `tinker.py` into their own python  
+script from version 1 to 3. These are in the `/scheduleGenerator` folder. I suggest to look  
+at the latest work in `v3.py` where the algorithm has come a long way. Using real 2018 course  
+selection data from my school I am able to test the script to its full potential compared to  
+V1 and V2.
+
+V3 has a entirely different approach from V1 and V2, that you can read about at the top of  
+the function in `v3.py`. The function is broken up into 6 steps, each step is labeled within  
+the function with a comment, giving a brief explination of what that step contributes to the  
+algorithm.

test/error.py

@@ -0,0 +1,21 @@
+import json
+
+f = open('./output/students.json')
+students = json.load(f)
+f.close()
+
+couldnt_resolve = 0
+missing_classes = 0
+acceptable_missing_classes = 0
+
+for student in students:
+  blocks = [student["schedule"][block] for block in student["schedule"]]
+  conflicts = sum(1 for b in blocks if len(b)>1)
+  if conflicts == 0 and student["classes"] == student["expectedClasses"]: continue
+  if conflicts > 0: couldnt_resolve += 1
+  if (student["expectedClasses"] - 2) <= student["classes"] < student["expectedClasses"]: acceptable_missing_classes += 1
+  if student["classes"] < (student["expectedClasses"] - 2): missing_classes += 1
+
+print(f"Couldn't resolve            :  {couldnt_resolve}/{len(students)} - {round((couldnt_resolve/len(students))*100, 2)}%")
+print(f"Missing classes             :  {missing_classes}/{len(students)}  - {round((missing_classes/len(students))*100, 2)}%")
+print(f"Acceptable Missing classes  :  {acceptable_missing_classes}/{len(students)} - {round((acceptable_missing_classes/len(students))*100, 2)}%")

test/mock.py

@@ -1,32 +0,0 @@
-#!/usr/bin/python3
-import random
-import names
-from courses import courses
-
-mockStudents = []
-
-# Generate n students for mock data
-def generateMockStudents(n):
-  for _ in range(n):
-    newStudent = {
-      "name": names.get_full_name(),
-      "requests": [], # list of class codes
-      "schedule": {
-        "block1": "",
-        "block2": "",
-        "block3": "",
-        "block4": "",
-        "block5": "",
-        "block6": "",
-        "block7": "",
-        "block8": ""
-      }
-    }
-    # Get list of random class choices with no repeats
-    # 8 primary choices, 2 secondary choices
-    courseSelection = random.sample(range(0, len(courses)), 10)
-    for courseNum in courseSelection:
-      newStudent["requests"].append(list(courses)[courseNum])
-    mockStudents.append(newStudent)
-
-  return mockStudents

test/scheduleGenerator/generator_v1.py

@@ -0,0 +1,197 @@
+#!/usr/bin/env python3
+from util.courses import mockCourses, activeCourses # Fake courses
+from util.mockStudents import generateMockStudents # Generate fake students
+import json
+
+
+'''
+  Block 1-4 is first semester while
+  block 5-8 is second semester
+'''
+
+'''
+schedule example:
+schedule: {
+  "block1": "className",
+  "block2": "className",
+  "block3": "className",
+  "block4": "className" 
+  "block5": "className",
+  "block6": "className",
+  "block7": "className",
+  "block8": "className"
+}
+'''
+
+'''
+running example:
+running: {
+  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
+}
+'''
+
+# Error 1: No classes in schedule can fit this student
+# Error 2: No more room in schedule for another class
+
+minReq, median, classCap, blockClassLimit = 18, 24, 30, 12
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {}
+}
+
+# Currently V1 has an average of 9.4% success rate, with an avverage of 90.6% error rate
+def generateScheduleV1(mockStudents, mockCourses):
+  # Collect data and calculate schedules
+  for student in mockStudents:
+    # Tally class request
+    for request in student["requests"]:
+      mockCourses[request]["totalrequests"] += 1
+      mockCourses[request]["studentindexes"].append(mockStudents.index(student))
+      # Add course to active list if enough requests
+      if mockCourses[request]["totalrequests"] > minReq and mockCourses[request]["code"] not in activeCourses: activeCourses[mockCourses[request]["code"]] = mockCourses[request]
+
+  for student in mockStudents:
+    alternateOffset = len(student["requests"])-8
+    alternateIndex = 8
+    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
+      currentCourse = student["requests"][i]
+      generate = True
+      while generate:
+        # If class is allowed to run
+        if currentCourse in activeCourses:
+          blockIndex = 1
+          courseNum = 1
+          getFreeBlock = True
+          while getFreeBlock:
+            block = f"block{blockIndex}"
+            cname = f"{mockCourses[currentCourse]['name']}-{courseNum}"
+            if cname in running[block]:
+              if student["schedule"][block] == "": # Add student to class
+                if len(running[block][cname]["students"]) < classCap:
+                  running[block][cname]["students"].append(student["name"])
+                  student["schedule"][block] = cname
+                  getFreeBlock = False
+                else: # Find next available class or create new one
+                  if blockIndex == 8:  # No available classes
+                    if len(student["requests"]) == 8:
+                      # This student never had any alternatives
+                      # How to solve?
+
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                    else:
+                      if alternateIndex <= (len(student["requests"]) - 1):
+                        currentCourse = student["requests"][alternateIndex]
+                        alternateIndex += 1
+                      else: # No more alterantive
+                        # print(f"\nError 1: No more available classes for student {student['name']}")
+                        generate = False
+                    getFreeBlock = False
+                  else:
+                    if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                      courseNum += 1
+                    else:
+                      blockIndex += 1
+                      courseNum = 1
+              else:
+                if blockIndex == 8: # No available classes
+                  if len(student["requests"]) == 8:
+                    # This student never had any alternatives
+                    # How to solve?
+
+                    # print(f"\nError 1: No more available classes for student {student['name']}")
+                    err1 += 1
+                    generate = False
+                  else:
+                    if alternateIndex <= (len(student["requests"]) - 1):
+                      currentCourse = student["requests"][alternateIndex]
+                      alternateIndex += 1
+                    else: # No more alternatives
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                  getFreeBlock = False
+                else:
+                  blockIndex += 1
+                  courseNum = 1
+            else:
+              if blockIndex == 8:
+                # Class does not exists
+                # Create new class in first available slot 
+                blockNum = 1
+                while True:
+                  newBlock = f"block{blockNum}"
+                  if cname not in running[newBlock] and len(running[newBlock]) < blockClassLimit:
+                    if student["schedule"][newBlock] == "": # Add student to class
+                      running[newBlock][cname] = {
+                        "name": mockCourses[currentCourse]["name"],
+                        "students": [student["name"]]
+                      }
+                      student["schedule"][newBlock] = cname
+                      break
+                    else:
+                      if blockNum == 8:
+                        # All student classes have been filled
+                        break
+                      else:
+                        blockNum += 1
+                        courseNum = 1
+                  else:
+                    if blockNum == 8:
+                      # No room in school for more classes
+                      # print(f"\nError 2: No more room in school for another class")
+                      break
+                    else:
+                      if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                        courseNum += 1
+                      else:
+                        blockNum += 1
+                        courseNum = 1
+                break
+              else:
+                blockIndex += 1
+                courseNum = 1
+          break
+        elif currentCourse not in activeCourses:
+          if len(student["requests"]) == 8:
+            # This student never had any alternatives
+            # How to solve?
+
+            # print(f"\nError 1: No more available classes for student {student['name']}")
+            generate = False
+          else:
+            if alternateIndex <= (len(student["requests"]) - 1):
+              currentCourse = student["requests"][alternateIndex]
+              alternateIndex += 1
+            else: # Out of alternatives
+              # print(f"\nError 1: No more available classes for student {student['name']}")
+              generate = False
+
+  return running
+
+
+if __name__ == '__main__':
+  print("Processing...")
+
+  mockStudents = generateMockStudents(400)
+  timetable = {}
+  timetable["Version"] = 1
+  timetable["timetable"] = generateScheduleV1(mockStudents, mockCourses)
+
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/scheduleGenerator/generator_v2.py

@@ -0,0 +1,213 @@
+#!/usr/bin/env python3
+from util.courses import mockCourses, activeCourses # Fake courses
+from util.mockStudents import generateMockStudents # Generate fake students
+import math
+import json
+
+
+'''
+  Block 1-4 is first semester while
+  block 5-8 is second semester
+'''
+
+'''
+schedule example:
+schedule: {
+  "block1": "className",
+  "block2": "className",
+  "block3": "className",
+  "block4": "className" 
+  "block5": "className",
+  "block6": "className",
+  "block7": "className",
+  "block8": "className"
+}
+'''
+
+'''
+running example:
+running: {
+  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
+  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
+}
+'''
+
+
+minReq, median, classCap, blockClassLimit = 18, 24, 30, 12
+mockStudents = []
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {}
+}
+
+
+# Currently V2 has an average of 0.35% success rate, with an avverage of 99.65% error rate
+def generateScheduleV2(mockStudents, mockCourses):
+  # Collect data and calculate schedules
+  for student in mockStudents:
+    # Tally class request
+    for request in student["requests"]:
+      mockCourses[request]["totalrequests"] += 1
+      mockCourses[request]["studentindexes"].append(mockStudents.index(student))
+      # Add course to active list if enough requests
+      if mockCourses[request]["totalrequests"] > minReq and mockCourses[request]["code"] not in activeCourses: activeCourses[mockCourses[request]["code"]] = mockCourses[request]
+
+  # calculate # of times to run class
+  for i in range(len(activeCourses)):
+    index = list(activeCourses)[i]
+    classRunCount = math.floor(activeCourses[index]["totalrequests"] / classCap)
+    # If there is minReq+ requests left, 1 more class could be run
+    if (activeCourses[index]["totalrequests"] % classCap) > minReq: classRunCount += 1
+    activeCourses[index]["classRunCount"] = classRunCount
+
+    newBlockIndex = 1
+    newCourseNum = 1
+    while classRunCount > 0:
+      block = f"block{newBlockIndex}"
+      cname = f"{activeCourses[index]['name']}-{newCourseNum}"
+      if cname not in running[block] and len(running[block]) < blockClassLimit:
+        # Generate class and sub 1 from classRunCount
+        running[block][cname] = {
+          "name": activeCourses[index]["name"],
+          "students": []
+        }
+        classRunCount -= 1
+      else:
+        if newBlockIndex == 8:
+          if (activeCourses[index]["teachers"] - newCourseNum) > 0:
+            newCourseNum += 1
+            newBlockIndex = 1
+          else:  
+            # No room in school for more classes
+            # print(f"\nError 2: No more room in school for another class")
+            classRunCount = 0
+        else: newBlockIndex += 1
+
+  for student in mockStudents:
+    alternateOffset = len(student["requests"])-8
+    alternateIndex = 8
+    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
+      currentCourse = student["requests"][i]
+      generate = True
+      courseNum = 1
+      while generate:
+        # If class is allowed to run
+        if currentCourse in activeCourses:
+          blockIndex = 1
+          getFreeBlock = True
+          cname = f"{mockCourses[currentCourse]['name']}-{courseNum}"
+          while getFreeBlock:
+            block = f"block{blockIndex}"
+            if cname in running[block]:
+              if student["schedule"][block] == "": # Add student to class
+                if len(running[block][cname]["students"]) < classCap:
+                  running[block][cname]["students"].append(student["name"])
+                  student["schedule"][block] = cname
+                  getFreeBlock = False
+                else: # Find next available class or create new one
+                  if blockIndex == 8:  # No available classes
+                    if (activeCourses[index]["teachers"] - newCourseNum) > 0:
+                      newCourseNum += 1
+                      newBlockIndex = 1
+                    else:
+                      # No room in school for more classes
+                      # print(f"\nError 2: No more room in school for another class")
+                      classRunCount = 0
+                    if len(student["requests"]) == 8:
+                      # This student never had any alternatives
+                      # How to solve?
+
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                    else:
+                      if alternateIndex <= (len(student["requests"]) - 1):
+                        currentCourse = student["requests"][alternateIndex]
+                        alternateIndex += 1
+                      else: # No more alterantive
+                        # print(f"\nError 1: No more available classes for student {student['name']}")
+                        generate = False
+                    getFreeBlock = False
+                  else: blockIndex += 1
+              else:
+                if blockIndex == 8: # No available classes
+                  if len(student["requests"]) == 8:
+                    # This student never had any alternatives
+                    # How to solve?
+
+                    # print(f"\nError 1: No more available classes for student {student['name']}")
+                    generate = False
+                  else:
+                    if alternateIndex <= (len(student["requests"]) - 1):
+                      currentCourse = student["requests"][alternateIndex]
+                      alternateIndex += 1
+                    else: # No more alternatives
+                      # print(f"\nError 1: No more available classes for student {student['name']}")
+                      generate = False
+                  getFreeBlock = False
+                else:
+                  if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                    courseNum += 1
+                  else:
+                    blockIndex += 1
+                    courseNum = 1
+            else:
+              if blockIndex == 8:
+                # Class does not exists
+                # Resort to alternative
+                if alternateIndex <= (len(student["requests"]) - 1):
+                  currentCourse = student["requests"][alternateIndex]
+                  alternateIndex += 1
+                else: # Out of alternatives
+                  # print(f"\nError 1: No more available classes for student {student['name']}")
+                  generate = False
+                break
+              else:
+                if (mockCourses[currentCourse]["teachers"] - courseNum) > 0:
+                  courseNum += 1
+                else:
+                  blockIndex += 1
+                  courseNum = 1
+          break
+        elif currentCourse not in activeCourses:
+          if len(student["requests"]) == 8:
+            # This student never had any alternatives
+            # How to solve?
+
+            # print(f"\nError 1: No more available classes for student {student['name']}")
+            generate = False
+          else:
+            if alternateIndex <= (len(student["requests"]) - 1):
+              currentCourse = student["requests"][alternateIndex]
+              alternateIndex += 1
+            else: # Out of alternatives
+              # print(f"\nError 1: No more available classes for student {student['name']}")
+              generate = False
+
+  return running
+
+
+if __name__ == '__main__':
+  print("Processing...")
+  
+  mockStudents = generateMockStudents(400)
+  timetable = {}
+  timetable["Version"] = 2
+  timetable["timetable"] = generateScheduleV2(mockStudents, mockCourses)
+  
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/scheduleGenerator/generator_v3.py

@@ -0,0 +1,613 @@
+#!/usr/bin/env python3
+import json
+import math
+import random
+from inspect import currentframe
+
+from click import pass_context
+
+# Import from custom utilities
+from util.mockStudents import getSampleStudents
+from util.generateCourses import getSampleCourses
+
+
+'''
+  Block 1-5 is first semester while
+  block 6-10 is second semester
+
+
+  schedule example:
+  schedule: {
+    "block1": "className",
+    "block2": "className",
+    "block3": "className",
+    ...
+  }
+
+
+  running example:
+  running: {
+    "block1": {
+      classCode: {
+        "className": name,
+        "students": [student Name]
+      },
+      classCode: {
+        "className": name,
+        "students": [student Name]
+      }
+    },
+    ...
+  }
+'''
+
+def getLineNumber(): return currentframe().f_back.f_lineno
+
+# Takes in information to create or add a new conflict
+# Returns if the particular student has a previous error
+def newConflict(pupilNum: str, email: str, type: str, code: str, description: str, logs: dict) -> bool:
+  exists = True if pupilNum in logs else False
+  if exists: logs[pupilNum].append({
+      "Pupil #": pupilNum,
+      "Email": email,
+      "Type": type,
+      "Code": code,
+      "Conflict": description
+    })
+  else:
+    logs[pupilNum] = [{
+      "Pupil #": pupilNum,
+      "Email": email,
+      "Type": type,
+      "Code": code,
+      "Conflict": description
+    }]
+  return exists
+
+minReq, median, classCap = 18, 24, 30
+activeCourses = {}
+running = {
+  "block1": {},
+  "block2": {},
+  "block3": {},
+  "block4": {},
+  "block5": {},
+  "block6": {},
+  "block7": {},
+  "block8": {},
+  "block9": {},
+  "block10": {}
+}
+
+# These are the codes for Flex (spare) blocks
+# Semester 1 and 2
+flex = ["XAT--12A-S", "XAT--12B-S"]
+
+# V3 differs a lot by V1/2 as it does not focus on fitting the classes
+# into the time table first.
+# It starts by trying to get all classes full and give all students a full class list.
+# Then it starts to attempt to fit all classes into a timetable, making corretions along
+# the way. Corrections being moving a students class
+def generateScheduleV3(
+  students: list, 
+  courses: dict, 
+  blockClassLimit: int=40,
+  studentsDir: str="../output/students.json",
+  conflictsDir: str="../output/conflicts.json"
+  ) -> dict[str, dict]:
+  
+  def equal(l: list) -> list: # Used to equalize list of numbers
+    q,r = divmod(sum(l),len(l))
+    return [q+1]*r + [q]*(len(l)-r)
+
+
+  # Step 1 - Calculate which classes can run
+  for student in students:
+    # Tally class request
+    for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
+      code = request["CrsNo"]
+      courses[code]["Requests"] += 1
+      # Add course to active list if enough requests
+      if courses[code]["Requests"] > minReq and courses[code]["CrsNo"] not in activeCourses:
+        activeCourses[code] = courses[code]
+
+
+  # Step 2 - Generate empty classes
+  allClassRunCounts = []
+  courseRunInfo = {} # Generated now, used in step 4
+  emptyClasses = {} # List of all classes with how many students should be entered during step 3
+  # calculate # of times to run class
+  for i in range(len(activeCourses)):
+    index = list(activeCourses)[i]
+    if index not in emptyClasses: emptyClasses[index] = {}
+    classRunCount = math.floor(activeCourses[index]["Requests"] / median)
+    remaining = activeCourses[index]["Requests"] % median
+
+    # Put # of classRunCount classes in emptyClasses
+    for j in range(classRunCount):
+      emptyClasses[index][f"{index}-{j}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": median # Number of students expected in this class / may be altered
+      }
+
+    # If remaining fit in open slots in existing classes
+    if remaining <= classRunCount * (classCap - median):
+      # Equally disperse remaining into existing classes
+      while remaining > 0:
+        for j in range(classRunCount):
+          if remaining == 0: break
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
+          remaining -= 1
+
+    # If we can create a class using remaining, but no other classes
+    # exists, create class, and do not equalize
+    elif remaining >= minReq:
+      # Create a class using remaining
+      emptyClasses[index][f"{index}-{classRunCount}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": remaining
+      }
+
+      classRunCount += 1
+      if classRunCount >= 2:
+        # Equalize (level) class expectedLen's
+        expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
+        newExpectedLens = equal(expectedLengths)
+        for j in range(len(newExpectedLens)):
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
+
+    # Else if we can't fit remaining in open slots in existing classes
+    # and it is unable to create its own class,
+    # and requiered number to make a class is less than the max number we can provide from existing classes
+    elif minReq - remaining < classRunCount * (median - minReq):
+      # Take 1 from each class till min requirment met
+      for j in range(classRunCount):
+        emptyClasses[index][f"{index}-{j}"]["expectedLen"] -= 1
+        remaining += 1
+        if remaining == minReq: break
+
+      # Create a class using remaining
+      emptyClasses[index][f"{index}-{classRunCount}"] = {
+        "CrsNo": index,
+        "Description": activeCourses[index]["Description"],
+        "expectedLen": remaining
+      }
+      
+      classRunCount += 1
+
+      # Equalize (level) class expectedLen's
+      expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
+      newExpectedLens = equal(expectedLengths)
+      for j in range(len(newExpectedLens)):
+        emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
+
+    else:
+      # In the case that the remaining requests are unable to be resolved
+      # Fill as many requests into class as possible, any left that can't fit,
+      # Will need to be ignored so later we can fold them into their alternative
+      # choices
+      for j in range(classRunCount):
+        if emptyClasses[index][f"{index}-{j}"]["expectedLen"] < classCap and remaining > 0: 
+          emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
+          remaining -= 1
+
+    courseRunInfo[index] = {
+      "Total": classRunCount,
+      "CrsNo": index
+    }
+    allClassRunCounts.append(classRunCount)
+
+
+  # Step 3 Fill emptyClasses with Students
+  selectedCourses = {}
+  tempStudents = list(students)
+  
+  while len(tempStudents) > 0:
+    student = tempStudents[random.randint(0, len(tempStudents)-1)]
+
+    alternates = [request for request in student["requests"] if request["alt"]]
+    for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
+      course = request["CrsNo"]
+      getAvailableCourse = True
+      isAlt = False
+      while getAvailableCourse:
+        if course in emptyClasses:
+          # if course exists, get first available class
+          for cname in emptyClasses[course]:
+            if cname in selectedCourses:
+              if isAlt and emptyClasses[course][cname]["expectedLen"] < classCap:
+                emptyClasses[course][cname]["expectedLen"] += 1
+              if len(selectedCourses[cname]["students"]) < emptyClasses[course][cname]["expectedLen"]:
+                # Class exists with room for student
+                selectedCourses[cname]["students"].append({
+                  "Pupil #": student["Pupil #"],
+                  "index": student["studentIndex"]
+                })
+                getAvailableCourse = False
+                break
+              elif len(selectedCourses[cname]["students"]) == emptyClasses[course][cname]["expectedLen"]:
+                # If class is full, and is last class of that course
+                if cname[len(cname)-1] == f"{len(emptyClasses[course])-1}":
+                  if len(alternates) > 0:
+                    # Use alternate
+                    course = alternates[0]["CrsNo"]
+                    alternates.remove(alternates[0])
+                    isAlt = True
+                    break
+                  else:
+                    # Force break loop, ignore and let an admin
+                    # handle options to solve for missing class
+                    getAvailableCourse = False
+                    break
+            elif cname not in selectedCourses:
+              selectedCourses[cname] = {
+                "students": [{
+                  "Pupil #": student["Pupil #"],
+                  "index": student["studentIndex"]
+                }],
+                "CrsNo": course,
+                "Description": courses[course]["Description"]
+              }
+              getAvailableCourse = False
+              break
+
+        elif course not in emptyClasses:
+          if len(alternates) > 0:
+            # Use alternate
+            course = alternates[0]["CrsNo"]
+            alternates.remove(alternates[0])
+            isAlt = True
+          else:
+            # Force break loop, ignore and let an admin
+            # handle options to solve for missing class
+            getAvailableCourse = False
+
+    students[student["studentIndex"]]["remainingAlts"] = alternates
+    tempStudents.remove(student)
+
+
+  # Step 4 - Attempt to fit classes into timetable
+  def stepIndex(offset: int, stepType: int) -> int:
+    # stepType 0 is for stepping between first and second semester
+    if stepType == 0:
+      if offset == 0 or offset == -4: return 5
+      else: return -4
+    
+    # stepType 1 is for stepping between second and first semester
+    elif stepType == 1:
+      if offset == 0 or offset == 6: return -5
+      else: return 6
+
+    # Return Error if code is altered to cause error
+    else: raise SystemExit(f"Invalid 'stepType' in func 'stepIndex' line {getLineNumber()}")
+
+  while len(allClassRunCounts) > 0:
+    # Get highest resource class (most times run)
+    index = allClassRunCounts.index(min(allClassRunCounts))
+    course = list(courseRunInfo)[index]
+
+    # Tally first and second semester
+    sem1, sem2 = 0, 0
+    sem1List, sem2List = {}, {}
+    for i in range(1, 6):
+      sem1 += len(running[f"block{i}"])
+      sem1List[f"block{i}"] = running[f"block{i}"]
+    for i in range(5, 11):
+      sem2 += len(running[f"block{i}"])
+      sem2List[f"block{i}"] = running[f"block{i}"]
+
+    # If there is more than one class Running
+    if allClassRunCounts[index] > 1:
+      blockIndex = 0 if sem1 <= sem2 else 5
+      stepType = 0 if sem1 <= sem2 else 1
+      offset = 0
+
+      # Spread classes throughout both semesters
+      for i in range(courseRunInfo[course]["Total"]):
+        cname = f"{course}-{i}"
+        classInserted = False
+        while not classInserted:
+
+          blockIndex += offset
+          if len(running[list(running)[blockIndex]]) < blockClassLimit:
+            running[list(running)[blockIndex]][cname] = {
+              "CrsNo": course,
+              "Description": emptyClasses[course][cname]["Description"],
+              "students": selectedCourses[cname]["students"]
+            }
+            allClassRunCounts[index] -= 1
+            classInserted = True
+
+          offset = stepIndex(offset, stepType)
+
+          if blockIndex >= 9:
+            blockIndex = 0 if sem1 <= sem2 else 5
+            offset = 0
+
+    # If the class only runs once, place in semester with least classes
+    elif allClassRunCounts[index] == 1:
+      # Equally disperse into semesters classes
+      semBlocks = []
+      offset = 1
+
+      # If sem1 is less than or equal to sem2, add to sem1
+      if sem1 <= sem2:
+        for block in sem1List:
+          semBlocks.append(len(block))
+
+      # If sem2 is less than sem1, add to sem2
+      elif sem1 > sem2:
+        offset = 5
+        for block in sem2List:
+          semBlocks.append(len(block))
+
+      # Get block with least classes
+      leastBlock = semBlocks.index(min(semBlocks))
+      cname = f"{course}-0"
+
+      running[f"block{leastBlock+offset}"][course] = {
+        "CrsNo": course,
+        "Description": emptyClasses[course][cname]["Description"],
+        "students": selectedCourses[cname]["students"],
+      }
+
+      allClassRunCounts[index] -= 1
+
+    # Remove course when fully inserted
+    if allClassRunCounts[index] == 0:
+      allClassRunCounts.remove(allClassRunCounts[index])
+      courseRunInfo.pop(list(courseRunInfo)[index])
+
+
+  # Step 5 - Fill student schedule
+  for block in running:
+    for cname in running[block]:
+      for student in running[block][cname]["students"]:
+        students[student["index"]]["schedule"][block].append(cname)
+        students[student["index"]]["classes"] += 1
+
+
+  # Step 6 - Evaluate, move students to fix conflicts
+  conflictLogs = {}
+  criticalCount, acceptableCount = 0, 0
+  c_mc_count, c_cr_count, a_mc_count = 0, 0, 0
+  studentsCritical, studentsAcceptable = 0, 0
+
+  for student in students:
+    initialBlocks = [student["schedule"][block] for block in student["schedule"]]
+    conflicts = sum(1 for b in initialBlocks if len(b)>1)
+    hasConflicts = True if conflicts > 0 else False
+
+    # If there is no conflicts
+    # and classes inserted to is equal to expectedClasses
+    # or classes the student is inserted to is missing
+    # no more than two classes:
+    # continue to next student
+    if not hasConflicts and student["classes"] == student["expectedClasses"]: continue
+    elif not hasConflicts and (student["expectedClasses"]-2) <= student["classes"] < student["expectedClasses"]:
+      a_mc_count += 1
+      acceptableCount += 1
+      if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
+      continue
+    
+    studentData = {
+      "Pupil #": student["Pupil #"],
+      "index": student["studentIndex"]
+    }
+
+    # If we are unable to solve, we add to exceptions 
+    # and keep trying to resolve the rest of the schedule
+    exceptions = [] 
+
+    while hasConflicts:
+      # Check if conflicts have been resolved
+      blocks = [student["schedule"][block] for block in student["schedule"]]
+      # If there is exceptions, make them look normal in blocks
+      # list to ginore them when looking for clashes, and not to
+      # accidently overwrite while evaluating other classes
+      if len(exceptions) > 0:
+        for i in range(len(blocks)):
+          if i in exceptions: blocks[i] = ['EXPT']
+      conflicts = sum(1 for b in blocks if len(b)>1)
+
+      if conflicts == 0: hasConflicts = False
+      
+      elif conflicts > 0:
+
+        blockLens = [len(block) for block in blocks]
+        freeBlocks = [index for index in range(len(blocks)) if len(blocks[index]) == 0]
+
+        clashIndex = blockLens.index(max(blockLens))
+        blockOut = f"block{clashIndex+1}"
+        classIndex = 0
+        done, advancedConflict = False, False
+
+        while not done:
+          classOut = blocks[clashIndex][classIndex]
+          found = False
+          for index in freeBlocks:
+            if found: break
+            if index != clashIndex:
+              blockIn = list(running)[index]
+              for cname in running[blockIn]:
+                if cname[:-2] == classOut[:-2] and len(running[blockIn][cname]["students"]) < classCap:
+
+                  # Update records
+                  student["schedule"][blockOut].remove(classOut)
+                  student["schedule"][blockIn].append(cname)
+
+                  running[blockOut][classOut]["students"].remove(studentData)
+                  running[blockIn][cname]["students"].append(studentData)
+
+                  found = True
+                  break
+
+          if not found:
+            if classIndex < len(blocks[clashIndex])-1: classIndex += 1
+            elif classIndex == len(blocks[clashIndex])-1:
+              classIndex = 0
+              advancedConflict = True
+              done = True
+            else:
+              print(f"Fatal error ({getLineNumber()}): Impossible error")
+              continue
+          
+          elif found: done = True
+
+        if advancedConflict:
+          attemptResolve = True
+          classOutIndex = 0
+          while attemptResolve:
+            foundSolution = False
+            newClassOut = blocks[clashIndex][classOutIndex]
+            for blockIndex in range(len(running)):
+              if foundSolution: break
+              if blockIndex != clashIndex and blockIndex not in exceptions:
+                for cname in running[list(running)[blockIndex]]:
+                  if cname[:-2] == newClassOut[:-2]:
+                    blockIn = f"block{blockIndex+1}"
+                    if blockIndex in freeBlocks:
+                      if len(running[blockIn][cname]["students"]) < classCap:
+                        # In the rare or impossible case a student was not inserted to a class
+                        # And it weren't full, insert them into the class
+                        student["schedule"][blockOut].remove(newClassOut)
+                        student["schedule"][blockIn].append(cname)
+
+                        running[blockOut][newClassOut]["students"].remove(studentData)
+                        running[blockIn][cname]["students"].append(studentData)
+                        foundSolution = True
+                        break
+
+                    elif len(blocks[blockIndex]) == 1:
+                      oClassOut = blocks[blockIndex][0]
+                      found_oBlockSolution = False
+                      for oBlockIndex in range(len(running)):
+                        if found_oBlockSolution: break
+                        if oBlockIndex != clashIndex and oBlockIndex not in exceptions and oBlockIndex in freeBlocks:
+                          for ocname in running[list(running)[oBlockIndex]]:
+                            if ocname[:-2] == oClassOut[:-2]:
+                              oBlockIn = f"block{oBlockIndex+1}"
+                              if len(running[oBlockIn][ocname]["students"]) < classCap:
+                                student["schedule"][blockOut].remove(newClassOut)
+                                student["schedule"][blockIn].append(cname)
+                                student["schedule"][blockIn].remove(oClassOut)
+                                student["schedule"][oBlockIn].append(ocname)
+
+                                running[blockOut][newClassOut]["students"].remove(studentData)
+                                running[blockIn][cname]["students"].append(studentData)
+                                running[blockIn][oClassOut]["students"].remove(studentData)
+                                running[oBlockIn][ocname]["students"].append(studentData)
+
+                                found_oBlockSolution = True
+                                break
+
+                        
+                      if not found_oBlockSolution:
+                        exceptions.append(clashIndex)
+                        criticalCount += 1
+                        c_cr_count += 1
+                        if not newConflict(student["Pupil #"], "", "Critial", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1 
+
+                      foundSolution = True
+                      break
+
+            if not foundSolution:
+              if classOutIndex < len(blocks[clashIndex]) - 1: classOutIndex += 1
+              elif classOutIndex == len(blocks[clashIndex]) - 1:
+                if len(student["remainingAlts"]) > 0:
+                  exceptions.append(clashIndex)
+                  criticalCount += 1
+                  c_cr_count += 1
+                  if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
+                  
+                  attemptResolve = False
+                  # Attempt to use alt
+                elif len(student["remainingAlts"]) == 0:
+                  exceptions.append(clashIndex)
+                  criticalCount += 1
+                  c_cr_count += 1
+                  if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
+                  
+                  attemptResolve = False
+              else: print("Impossible - Thanos")
+            elif foundSolution:
+              attemptResolve = False
+      
+      else:
+        print(f"Fatal error ({getLineNumber()}): Impossible error")
+        continue
+
+    metSelfRequirements = True if student["classes"] == student["expectedClasses"] else False
+    while not metSelfRequirements:
+      
+      if (student["expectedClasses"] - 2) <= student["classes"] < student["expectedClasses"]:
+        a_mc_count += 1
+        acceptableCount += 1
+        if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
+        break
+
+      elif student["classes"] < (student["expectedClasses"] - 2):
+        # Difference between classes inserted to and
+        # expected classes is too great, attempt to fix
+        if student["Pupil #"] in conflictLogs:
+          c_mc_count += 1
+          criticalCount += 1
+          if not newConflict(student["Pupil #"], "", "Critical", "C-MC", "Missing too many Classses", conflictLogs): studentsCritical += 1
+
+        break
+
+      else:
+        print(f"Fatal error ({getLineNumber()}): Impossible error")
+        continue
+
+  finalConflictLogs = {
+    "Conflicts": conflictLogs,
+    "Critical": {
+      "Total": criticalCount,
+      "Students": studentsCritical,
+      "Errors": [{
+        "Total": c_mc_count,
+        "Description": "Missing too many Classes",
+        "Code": "C-MC"
+      }, {
+        "Total": c_cr_count,
+        "Description": "Couldn't Resolve",
+        "Code": "C-CR"
+      }]
+    },
+    "Acceptable": {
+      "Total": acceptableCount,
+      "Students": studentsAcceptable,
+      "Errors": [{
+        "Total": a_mc_count,
+        "Description": "Missing 1-2 Classes",
+        "Code": "A-MC"
+      }]
+    }
+  }
+
+  # Update Student records
+  with open(studentsDir, "w") as outfile:
+      json.dump(students, outfile, indent=2)
+
+  # Log Conflict to records
+  with open(conflictsDir, "w") as outfile:
+    json.dump(finalConflictLogs, outfile, indent=2)
+
+  return running
+
+if __name__ == '__main__':
+  print("Processing...")
+
+  sampleStudents = getSampleStudents(True)
+  samplemockCourses = getSampleCourses(True) 
+  timetable = {}
+  timetable["Version"] = 3
+  timetable["timetable"] = generateScheduleV3(sampleStudents, samplemockCourses)
+
+  with open("../output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
+
+  print("Done")

test/test.js

@@ -1,21 +0,0 @@
-let schedule = require('./schedule.json');
-let students = require('./students.json');
-
-// console.table(schedule)
-
-// Display first semester 
-// console.table(schedule.block1)
-// console.table(schedule.block2)
-// console.table(schedule.block3)
-// console.table(schedule.block4)
-
-// // Display second semester 
-// console.table(schedule.block5)
-// console.table(schedule.block6)
-// console.table(schedule.block7)
-// console.table(schedule.block8)
-
-// Display each students schedule
-for (let i = 0; i < students.length; i++) {
-  console.table(students[i].schedule)
-}

test/tinker.py

@@ -1,390 +1,98 @@
 #!/usr/bin/python3
-import sys
+from prettytable import PrettyTable
+from typing import Tuple
 import json
-import math
-from courses import courses, activeCourses
-from mock import generateMockStudents
+import sys
 
-'''
-  I will be using python to test and
-  develop course selection / schedule
-  generation
+# Import required utilities
+from util.mockStudents import generateMockStudents, getSampleStudents
+from util.generateCourses import getSampleCourses
+from util.courses import mockCourses
 
-  this is honestly terrible code but 
-  this is not an easy task for me to
-  do
+# Import Algorithms
+from scheduleGenerator.generator_v1 import generateScheduleV1
+from scheduleGenerator.generator_v2 import generateScheduleV2
+from scheduleGenerator.generator_v3 import generateScheduleV3
 
-  Block 1-4 is first semester while
-  block 5-8 is second semester
-'''
+def errorOutput(students) -> Tuple[PrettyTable, dict, dict]:
+  # Error Table calulation / output  
+  f = open('./output/conflicts.json')
+  conflicts = json.load(f)
+  f.close()
+  totalCritical = conflicts["Critical"]["Students"]
+  totalAcceptable = conflicts["Acceptable"]["Students"]
 
-'''
-schedule example:
-schedule: {
-  "block1": "className",
-  "block2": "className",
-  "block3": "className",
-  "block4": "className" 
-  "block5": "className",
-  "block6": "className",
-  "block7": "className",
-  "block8": "className"
-}
-'''
+  t = PrettyTable(['Type', 'Error %', 'Success %', 'Student Error Ratio'])
   
-'''
-running example:
-running: {
-  "block1": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block2": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block3": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block4": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block5": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block6": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block7": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}},
-  "block8": {classCode:{"className":name,"students":[student Name]},classCode:{"className":name,"students":[student Name]}}
-}
-'''
-
-# Error 1: No classes in schedule can fit this student
-# Error 2: No more room in schedule for another class
-
-# 400 by default
-studentsNum = 500
-
-err1, err2, = 0,0
-minReq, classCap, blockClassLimit = 18, 30, 18
-mockStudents = []
-running = {
-  "block1": {},
-  "block2": {},
-  "block3": {},
-  "block4": {},
-  "block5": {},
-  "block6": {},
-  "block7": {},
-  "block8": {}
-}
-
-
-def generateScheduleV1():
-  global err1, err2
-  # Collect data and calculate schedules
-  for student in mockStudents:
-    # Tally class request
-    for request in student["requests"]:
-      courses[request]["totalrequests"] += 1
-      courses[request]["studentindexes"].append(mockStudents.index(student))
-      # Add course to active list if enough requests
-      if courses[request]["totalrequests"] > minReq and courses[request]["code"] not in activeCourses: activeCourses[courses[request]["code"]] = courses[request]
-
-  for student in mockStudents:
-    alternateOffset = len(student["requests"])-8
-    alternateIndex = 8
-    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
-      currentCourse = student["requests"][i]
-      generate = True
-      while generate:
-        # If class is allowed to run
-        if currentCourse in activeCourses:
-          blockIndex = 1
-          courseNum = 1
-          getFreeBlock = True
-          while getFreeBlock:
-            block = f"block{blockIndex}"
-            cname = f"{courses[currentCourse]['name']}-{courseNum}"
-            if cname in running[block]:
-              if student["schedule"][block] == "": # Add student to class
-                if len(running[block][cname]["students"]) < classCap:
-                  running[block][cname]["students"].append(student["name"])
-                  student["schedule"][block] = cname
-                  getFreeBlock = False
-                else: # Find next available class or create new one
-                  if blockIndex == 8:  # No available classes
-                    if len(student["requests"]) == 8:
-                      # This student never had any alternatives
-                      # How to solve?
-
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      generate = False
-                    else:
-                      if alternateIndex <= (len(student["requests"]) - 1):
-                        currentCourse = student["requests"][alternateIndex]
-                        alternateIndex += 1
-                      else: # No more alterantive
-                        # print(f"\nError 1: No more available classes for student {student['name']}")
-                        err1 += 1
-                        generate = False
-                    getFreeBlock = False
-                  else:
-                    if (courses[currentCourse]["teachers"] - courseNum) > 0:
-                      courseNum += 1
-                    else:
-                      blockIndex += 1
-                      courseNum = 1
-              else:
-                if blockIndex == 8: # No available classes
-                  if len(student["requests"]) == 8:
-                    # This student never had any alternatives
-                    # How to solve?
-
-                    # print(f"\nError 1: No more available classes for student {student['name']}")
-                    err1 += 1
-                    generate = False
-                  else:
-                    if alternateIndex <= (len(student["requests"]) - 1):
-                      currentCourse = student["requests"][alternateIndex]
-                      alternateIndex += 1
-                    else: # No more alternatives
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                  getFreeBlock = False
-                else:
-                  blockIndex += 1
-                  courseNum = 1
-            else:
-              if blockIndex == 8:
-                # Class does not exists
-                # Create new class in first available slot 
-                blockNum = 1
-                while True:
-                  newBlock = f"block{blockNum}"
-                  if cname not in running[newBlock] and len(running[newBlock]) < blockClassLimit:
-                    if student["schedule"][newBlock] == "": # Add student to class
-                      running[newBlock][cname] = {
-                        "name": courses[currentCourse]["name"],
-                        "students": [student["name"]]
-                      }
-                      student["schedule"][newBlock] = cname
-                      break
-                    else:
-                      if blockNum == 8:
-                        # All student classes have been filled
-                        break
-                      else:
-                        blockNum += 1
-                        courseNum = 1
-                  else:
-                    if blockNum == 8:
-                      # No room in school for more classes
-                      # print(f"\nError 2: No more room in school for another class")
-                      err2 += 1
-                      break
-                    else:
-                      if (courses[currentCourse]["teachers"] - courseNum) > 0:
-                        courseNum += 1
-                      else:
-                        blockNum += 1
-                        courseNum = 1
-                break
-              else:
-                blockIndex += 1
-                courseNum = 1
-          break
-        elif currentCourse not in activeCourses:
-          if len(student["requests"]) == 8:
-            # This student never had any alternatives
-            # How to solve?
-
-            # print(f"\nError 1: No more available classes for student {student['name']}")
-            err1 += 1
-            generate = False
-          else:
-            if alternateIndex <= (len(student["requests"]) - 1):
-              currentCourse = student["requests"][alternateIndex]
-              alternateIndex += 1
-            else: # Out of alternatives
-              # print(f"\nError 1: No more available classes for student {student['name']}")
-              err1 += 1
-              generate = False
-
-
-def generateScheduleV2():
-  global err1, err2
-  # Collect data and calculate schedules
-  for student in mockStudents:
-    # Tally class request
-    for request in student["requests"]:
-      courses[request]["totalrequests"] += 1
-      courses[request]["studentindexes"].append(mockStudents.index(student))
-      # Add course to active list if enough requests
-      if courses[request]["totalrequests"] > minReq and courses[request]["code"] not in activeCourses: activeCourses[courses[request]["code"]] = courses[request]
-
-  # calculate # of times to run class
-  for i in range(len(activeCourses)):
-    index = list(activeCourses)[i]
-    classRunCount = math.floor(activeCourses[index]["totalrequests"] / classCap)
-    # If there is minReq+ requests left, 1 more class could be run
-    if (activeCourses[index]["totalrequests"] % classCap) > minReq: classRunCount += 1
-    activeCourses[index]["classRunCount"] = classRunCount
-
-    blockIndex = 1
-    while classRunCount > 0:
-      block = f"block{blockIndex}"
-      if activeCourses[index]["code"] not in running[block] and len(running[block]) < blockClassLimit:
-        # Generate class and sub 1 from classRunCount
-        running[block][activeCourses[index]["code"]] = {
-          "name": activeCourses[index]["name"],
-          "students": []
-        }
-        classRunCount -= 1
-      else:
-        if blockIndex == 8:
-          # No room in school for more classes
-          # print(f"\nError 2: No more room in school for another class")
-          err2 += 1
-          classRunCount = 0
-        else:
-          blockIndex += 1
-
-  for student in mockStudents:
-    alternateOffset = len(student["requests"])-8
-    alternateIndex = 8
-    for i in range(len(student["requests"])-alternateOffset): # Subtract x classes as they are alternatives
-      currentCourse = student["requests"][i]
-      generate = True
-      while generate:
-        # If class is allowed to run
-        if currentCourse in activeCourses:
-          blockIndex = 1
-          getFreeBlock = True
-          while getFreeBlock:
-            block = f"block{blockIndex}"
-            if currentCourse in running[block]:
-              if student["schedule"][block] == "": # Add student to class
-                if len(running[block][currentCourse]["students"]) < classCap:
-                  running[block][currentCourse]["students"].append(student["name"])
-                  student["schedule"][block] = courses[currentCourse]["name"]
-                  getFreeBlock = False
-                else: # Find next available class or create new one
-                  if blockIndex == 8:  # No available classes
-                    if len(student["requests"]) == 8:
-                      # This student never had any alternatives
-                      # How to solve?
-
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                    else:
-                      if alternateIndex <= (len(student["requests"]) - 1):
-                        currentCourse = student["requests"][alternateIndex]
-                        alternateIndex += 1
-                      else: # No more alterantive
-                        # print(f"\nError 1: No more available classes for student {student['name']}")
-                        err1 += 1
-                        generate = False
-                    getFreeBlock = False
-                  else: blockIndex += 1
-              else:
-                if blockIndex == 8: # No available classes
-                  if len(student["requests"]) == 8:
-                    # This student never had any alternatives
-                    # How to solve?
-
-                    # print(f"\nError 1: No more available classes for student {student['name']}")
-                    err1 += 1
-                    generate = False
-                  else:
-                    if alternateIndex <= (len(student["requests"]) - 1):
-                      currentCourse = student["requests"][alternateIndex]
-                      alternateIndex += 1
-                    else: # No more alternatives
-                      # print(f"\nError 1: No more available classes for student {student['name']}")
-                      err1 += 1
-                      generate = False
-                  getFreeBlock = False
-                else: blockIndex += 1
-            else:
-              if blockIndex == 8:
-                # Class does not exists
-                # Resort to alternative
-                if alternateIndex <= (len(student["requests"]) - 1):
-                  currentCourse = student["requests"][alternateIndex]
-                  alternateIndex += 1
-                else: # Out of alternatives
-                  # print(f"\nError 1: No more available classes for student {student['name']}")
-                  err1 += 1
-                  generate = False
-                break
-              else: blockIndex += 1
-          break
-        elif currentCourse not in activeCourses:
-          if len(student["requests"]) == 8:
-            # This student never had any alternatives
-            # How to solve?
-
-            # print(f"\nError 1: No more available classes for student {student['name']}")
-            err1 += 1
-            generate = False
-          else:
-            if alternateIndex <= (len(student["requests"]) - 1):
-              currentCourse = student["requests"][alternateIndex]
-              alternateIndex += 1
-            else: # Out of alternatives
-              # print(f"\nError 1: No more available classes for student {student['name']}")
-              err1 += 1
-              generate = False
+  errorsC = round(totalCritical / len(students) * 100, 2)
+  successC = round(100 - errorsC, 2)
+  errorsA = round(totalAcceptable / len(students) * 100, 2)
+  successA = round(100 - errorsA, 2)
   
+  t.add_row(['Critical', f"{errorsC} %", f"{successC} %", f"{totalCritical}/{len(students)} Students"])
+  t.add_row(['Acceptable', f"{errorsA} %", f"{successA} %", f"{totalAcceptable}/{len(students)} Students"])
   
+  return t, conflicts["Critical"], conflicts["Acceptable"]
 
 if __name__ == '__main__':
+  
   if len(sys.argv) == 1:
     print("Missing argument")
     exit()
+
   if sys.argv[1].upper() == 'V1':
-    if len(sys.argv) == 3:
-      try:
-        studentsNum = int(sys.argv[2])
-      except:
-        print("Error parsing number of students")
-        exit()
     print("Processing...")
-    mockStudents = generateMockStudents(studentsNum)
-    generateScheduleV1()
+
+    mockStudents = generateMockStudents(400)
+    timetable = {}
+    timetable["Version"] = 1
+    timetable["timetable"] = generateScheduleV1(mockStudents, mockCourses)
+  
   elif sys.argv[1].upper() == 'V2':
-    if len(sys.argv) == 3:
-      try:
-        studentsNum = int(sys.argv[2])
-      except:
-        print("Error parsing number of students")
-        exit()
     print("Processing...")
-    mockStudents = generateMockStudents(studentsNum)
-    generateScheduleV2()
+  
+    mockStudents = generateMockStudents(400)
+    timetable = {}
+    timetable["Version"] = 2
+    timetable["timetable"] = generateScheduleV2(mockStudents, mockCourses)
+  
+
+  elif sys.argv[1].upper() == 'V3':
+  
+    print("Processing...\n")
+  
+    sampleStudents = getSampleStudents("./sample_data/course_selection_data.csv", True)
+    samplemockCourses = getSampleCourses("./sample_data/course_selection_data.csv", True)
+    timetable = {}
+    timetable["Version"] = 3
+    timetable["timetable"] = generateScheduleV3(sampleStudents, samplemockCourses, 40, "./output/students.json", "./output/conflicts.json")
+
+    errors, _, _ = errorOutput(sampleStudents)
+    print(errors)
+
+  elif sys.argv[1].upper() == "ERRORS":
+    f = open('./output/students.json')
+    studentData = json.load(f)
+    f.close()
+    errors, critical, acceptable = errorOutput(studentData)
+    print()
+    print(errors)
+
+    print(f"\n{critical['Total']} critical errors")
+    for i in range(len(critical["Errors"])):
+      print(f"x{critical['Errors'][i]['Total']} {critical['Errors'][i]['Code']} Errors: Critical - {critical['Errors'][i]['Description']}")
+
+    print(f"\n{acceptable['Total']} acceptable errors")
+    for i in range(len(acceptable["Errors"])):
+      print(f"x{acceptable['Errors'][i]['Total']} {acceptable['Errors'][i]['Code']} Errors: Critical - {acceptable['Errors'][i]['Description']}")
+
+    exit()
+
   else:
     print("Invalid argument")
     exit()
 
-  print("\n")
-  print(f"Error 1: x{err1}")
-  print(f"Error 2: x{err2}")
-  print("\n")
+  with open("./output/timetable.json", "w") as outfile:
+    json.dump(timetable, outfile, indent=2)
 
-  ### Displays the number of students in each class
-  # for block in running:
-  #   print(f"\nBlock: {block}")
-  #   print("=====================")
-  #   for cl in running[block]:
-  #     name = running[block][cl]["name"]
-  #     students = len(running[block][cl]["students"])
-  #     print(f"Class: {name} | Students: {students}")
-
-  # Count errors in students schedules
-  errors = 0
-  for i in range(len(mockStudents)):
-    count = 0
-    for course in mockStudents[i]["schedule"]:
-      if mockStudents[i]["schedule"][course]=="": count+=1
-    if count > 0: errors += 1
-  
-  print(f"{errors}/{studentsNum} student(s) have a issue with their schedule")
-
-
-  with open("schedule.json", "w") as outfile:
-    json.dump(running, outfile, indent=2)
-
-  with open("students.json", "w") as outfile:
-    json.dump(mockStudents, outfile, indent=2)
-
-  print("Done")
+  print("\nDone")

test/util/courses.py

@@ -1,4 +1,6 @@
-courses = {
+# Fake sample data
+
+mockCourses = {
   "P-CL": {
     "name": "Pre-Calculus",
     "code": "P-CL",
@@ -99,8 +101,8 @@ courses = {
     "teachers": 3
   },
   "SC-ES": {
-    "name": "SC-ES",
-    "code": "cl12",
+    "name": "Earth Science",
+    "code": "SC-ES",
     "credits": 4,
     "gradelevel": 11,
     "totalrequests": 0,
@@ -109,7 +111,7 @@ courses = {
   },
   "M": {
     "name": "Music",
-    "code": "Ms",
+    "code": "M",
     "credits": 4,
     "gradelevel": 11,
     "totalrequests": 0,

test/util/generateCourses.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+import json
+import csv
+
+realCourses = {}
+
+# Get all courses from real sample data
+def getSampleCourses(data_dir, log=False) -> dict:
+  with open(data_dir, newline='') as csvfile:
+    reader = csv.DictReader(csvfile)
+    for row in reader:
+      exists = False
+      for course in realCourses:
+        exists = True if realCourses[course]["CrsNo"] == row["CrsNo"] else False
+        if exists: break
+      if not exists:
+        realCourses[row["CrsNo"]] = {
+          "CrsNo": row["CrsNo"],
+          "Requests": 0,
+          "Description": row["Description"],
+          "Credits": 4,
+          "students": []
+        }
+
+  if log:
+    with open("./output/realCourses.json", "w") as outfile:
+      json.dump(realCourses, outfile, indent=2)
+        
+  return realCourses
+
+
+if __name__ == '__main__':
+  courseSet: dict = getSampleCourses("../sample_data/course_selection_data.csv")
+
+  with open("../output/realCourses.json", "w") as outfile:
+    json.dump(courseSet, outfile, indent=2)

test/util/mockStudents.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+import random
+import names
+import json
+import csv
+import sys
+from util.courses import mockCourses
+
+flex= ["XAT--12A-S", "XAT--12B-S"]
+
+mockStudents: list[dict] = []
+
+# Generate n students for mock data
+def generateMockStudents(n: int) -> list[dict]:
+  for _ in range(n):
+    newStudent = {
+      "name": names.get_full_name(),
+      "requests": [], # list of class codes
+      "schedule": {
+        "block1": "",
+        "block2": "",
+        "block3": "",
+        "block4": "",
+        "block5": "",
+        "block6": "",
+        "block7": "",
+        "block8": ""
+      }
+    }
+    # Get list of random class choices with no repeats
+    # 8 primary choices, 2 secondary choices
+    courseSelection = random.sample(range(0, len(mockCourses)), 10)
+    for courseNum in courseSelection:
+      newStudent["requests"].append(list(mockCourses)[courseNum])
+    mockStudents.append(newStudent)
+
+  return mockStudents
+
+
+# sort real sample data into usable dictionary
+def getSampleStudents(data_dir: str, log: bool = False) -> list[dict]:
+  with open(data_dir, newline='') as csvfile:
+    reader = csv.DictReader(csvfile)
+    for row in reader:
+      exists = False
+      for student in mockStudents:
+        exists = True if student["Pupil #"] == row["Pupil #"] else False
+        if exists: break
+      alternate = True if row["Alternate?"] == 'TRUE' else False
+      if exists:
+        if len(mockStudents[student["studentIndex"]]["requests"]) >= 10 and not alternate and row["CrsNo"] not in flex: alternate = True
+        mockStudents[student["studentIndex"]]["requests"].append({
+          "CrsNo": row["CrsNo"],
+          "Description": row["Description"],
+          "alt": alternate
+        })
+        if row["CrsNo"] not in flex and not alternate and mockStudents[student["studentIndex"]]["expectedClasses"] < 10:
+          mockStudents[student["studentIndex"]]["expectedClasses"] += 1
+      else:
+        newStudent = {
+          "Pupil #": row["Pupil #"],
+          "requests": [{
+            "CrsNo": row["CrsNo"],
+            "Description": row["Description"],
+            "alt": alternate
+          }],
+          "schedule": {
+            "block1": [],
+            "block2": [],
+            "block3": [],
+            "block4": [],
+            "block5": [],
+            "block6": [],
+            "block7": [],
+            "block8": [],
+            "block9": [],
+            "block10": []
+          },
+          "expectedClasses": 1,
+          "classes": 0,
+          "remainingAlts": [],
+          "studentIndex": len(mockStudents)
+        }
+        mockStudents.append(newStudent)
+
+  if log:
+    with open("./output/students.json", "w") as outfile:
+      json.dump(mockStudents, outfile, indent=2)
+
+  return mockStudents
+
+
+if __name__ == '__main__':
+  if len(sys.argv) == 1:
+    print("Missing argument")
+    exit()
+  if sys.argv[1].lower() == 'sample':
+    studentRequests: list[dict] = getSampleStudents("../sample_data/course_selection_data.csv")
+
+    with open("../output/students.json", "w") as outfile:
+      json.dump(studentRequests, outfile, indent=2)
+  elif sys.argv[1].lower() == 'mock':
+    studentRequests: list[dict] = generateMockStudents(400)
+
+    with open("../output/students.json", "w") as outfile:
+      json.dump(studentRequests, outfile, indent=2)
+  else:
+    print("Invalid argument")
+    exit()
+
+  print("done")