diff --git a/.dockerignore b/.dockerignore index 8a732ea..5192e3b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -33,3 +33,4 @@ Thumbs.db # Local Developer Notes dev +dist diff --git a/.gitignore b/.gitignore index 7585238..1521c8b 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -book +dist diff --git a/Dockerfile b/Dockerfile index 31b46f3..e5a7021 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,7 @@ #################### # - Stage: SSG #################### -FROM docker-mdbook:0.4.34 AS base +FROM git.sofus.io/so-rose/docker-mdbook:0.4.34 AS base COPY . /src RUN mdbook build /src --dest-dir /dist diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server 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, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 2bfd126..b1bbdef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ # TODO +- [ ] Don't use commit ID when tagging dev containers / check clean git tree before allowing a commit ID tag. - [ ] `pre-commit install` as part of `run.sh`? diff --git a/book.toml b/book.toml index d34134a..391f25c 100644 --- a/book.toml +++ b/book.toml @@ -1,5 +1,10 @@ [book] -authors = [] +title = "DTU Python Support" +authors = ["Sofus Albert Høgsbro Rose"] language = "en" multilingual = false src = "src" + +[output.html.fold] +enable = true +level = 0 diff --git a/run.py b/run.py index 673e755..a7a1fd4 100755 --- a/run.py +++ b/run.py @@ -39,9 +39,15 @@ CMD_DEPENDENCIES = [ 'pre-commit' ] -IMAGE_NAME = "python-support" +IMAGE_NAME = "site-support" IMAGE_VERSION = ("0", "0", "1") +REGISTRY_HOST = "git.sofus.io" +REGISTRY_USER = "so-rose" +REGISTRY_PASSWORD = subprocess.check_output( + ['pass', 'services/home/git.sofus.io/container-registry-token'] +).decode('ascii').strip() + #################### # - Help Text #################### @@ -60,52 +66,48 @@ def action_help() -> None: => Enforces that certain checks pass at each commit. Options: - ./run.sh - => Equivilant to run.sh help. + ./run.py + => Equivilant to run.py help. - ./run.sh -h|h|help + ./run.py -h|h|help => Shows this text. Options, Run Locally: - ./run.sh app - => Will run the app on port 9500, for local development. - - ./run.sh cli - => Will run a console in the dev container, with port 9500 closed. + ./run.py app + => Will run the app on port 8787, for local development. Options, Check: - ./run.sh check + ./run.py check => Will run all checks, including static analysis and tests. - ./run.sh analyze-quality [OPTIONS] + ./run.py analyze-quality [OPTIONS] => Will run the static code-quality analysis suite. => OPTIONS will be passed directly to the tool (ruff). - ./run.sh analyze-types [OPTIONS] + ./run.py analyze-types [OPTIONS] => Will run the static type checking suite. - => OPTIONS will be passed directly to the tool (pyright). + => OPTIONS will be passed directly to the tool (mypy). - ./run.sh analyze-security + ./run.py analyze-security => Will run the static security analysis suite. - ./run.sh analyze-format [--overwrite] [OPTIONS] + ./run.py analyze-format [--overwrite] [OPTIONS] => Will run the code formatter in read-only omde. => '--overwrite' will cause the formater to reformat all files. => OPTIONS will be passed directly to the tool (tan). - ./run.sh test [OPTIONS] - => Will run the test suite locally. - => OPTIONS will be passed directly to the tool (pytest). + ./run.py test + => Will run all Markdown Python snippets as tests. Options, Build & Deploy: - ./run.sh build + ./run.py build => Will build, tag and upload a docker image appropriately. - ./run.sh build-release + ./run.py build-release => Will build, tag and upload a docker image appropriate for release. Options, Housekeeping: - ./run.sh clean + ./run.py clean => Will delete all data caused by this project's presence on your system. """) @@ -123,10 +125,12 @@ def cd_script_dir() -> None: finally: os.chdir(cwd_orig) -def get_git_revision_hash() -> str: - return subprocess.check_output( +def get_git_revision_hash(short = True) -> str: + commit_id = subprocess.check_output( ['git', 'rev-parse', 'HEAD'] ).decode('ascii').strip() + + return commit_id[:16] if short else commit_id def cmd_exists(cmd: str) -> bool: """Checks if a command exists. Supports Linux, Mac, Windows. @@ -136,53 +140,74 @@ def cmd_exists(cmd: str) -> bool: #################### -# - Actions +# - Actions - Build #################### -def action_build() -> None: +def action_build(release = False) -> None: + tag = get_git_revision_hash() if release else "dev" subprocess.run([ "podman", "build", ".", - "--target", "base", # : - Tag Commit ID "--tag", - f"{IMAGE_NAME}:{get_git_revision_hash()}", + f"{IMAGE_NAME}:{tag}", ]) - -def action_run() -> None: - action_build() - subprocess.run([ - "podman", "run", - "--rm", "-it", - "--publish", "8787:8787", - ]) - - def action_publish() -> None: - action_build() + action_build(release = True) - # Add Tags for M, M.m, M.m.p + # Login to Registry + subprocess.run([ + "podman", "login", REGISTRY_HOST, + "--username", REGISTRY_USER, + "--password", REGISTRY_PASSWORD, + ]) + + ## TODO: Ensure git tag matches. + + # Tag & Publish Image @ : + subprocess.run([ + "podman", "image", "push", + f"{IMAGE_NAME}:dev", + f"{REGISTRY_HOST}/{REGISTRY_USER}/{IMAGE_NAME}:{get_git_revision_hash()}", + ]) + + # Publish Image @ :M, :M.m, :M.m.p for image_tag in [ f"{IMAGE_NAME}:{'.'.join(IMAGE_VERSION)}", f"{IMAGE_NAME}:{'.'.join(IMAGE_VERSION[:2])}", f"{IMAGE_NAME}:{IMAGE_VERSION[0]}", ]: + # Tag Image subprocess.run([ "podman", "tag", - f"{IMAGE_NAME}:{get_git_revision_hash()}", + f"{IMAGE_NAME}:dev", image_tag ]) - # Publish Image + # Publish Image + subprocess.run([ + "podman", "image", "push", + image_tag, + f"{REGISTRY_HOST}/{REGISTRY_USER}/{image_tag}", + ]) + + +#################### +# - Actions - Run +#################### +def action_app() -> None: + action_build() subprocess.run([ - "podman", "image", "push", "--all-tags", - f"git.sofus.io/so-rose/{IMAGE_NAME}", + "podman", "run", "--rm", "-it", + "--publish", "8787:8787", + f"{IMAGE_NAME}:{get_git_revision_hash()}", ]) + #################### # - Script #################### @@ -196,12 +221,12 @@ if __name__ == "__main__": with cd_script_dir(): if len(sys.argv) > 1: { - "run": action_run, - "dev": lambda: print("TBD"), - "build": action_build, "publish": action_publish, + "app": action_app, + "dev": lambda: print("TBD"), + "help": action_help, "-h": action_help, "--help": action_help, diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 7390c82..12dca97 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,3 +1,97 @@ # Summary +- [Introduction](introduction.md) -- [Chapter 1](./chapter_1.md) +- [How to Ask for Help](how-to.md) + - [DTU Python Support Community](help.md) + + + +# Computer Essentials +- [Handbook of Presumed Knowledge](basics/nonobvious_stuff/README.md) + - ["File"? "Filesystem"?](basics/nonobvious_stuff/files.md) + - [Your password sucks...](basics/nonobvious_stuff/passwords.md) + - ["Command"? "Executable"?](basics/nonobvious_stuff/execute.md) + - [...and so does your router!](basics/nonobvious_stuff/networks.md) + - [Licenses - "Can I Use That Code?"](basics/nonobvious_stuff/foss.md) + - [Why Word Sucks feat. "Markdown"](basics/nonobvious_stuff/markdown.md) + - [Professionals > Sum of Tools](basics/nonobvious_stuff/conclusion.md) + +- [The Terminal: How I Learned to Stop Worrying and Love the Shell 🐚](basics/terminal/README.md) + - [Linux\*](basics/terminal/linux.md) + - [Windows - Powershell](basics/terminal/windows.md) + - [Mac](basics/terminal/mac.md) + + + +# Installing Python w/Packages +- [Getting Python](installing/native/README.md) + - [Debian](installing/native/debian.md) + - [Ubuntu](installing/native/ubuntu.md) + - [Arch](installing/native/arch.md) + - [Fedora](installing/native/fedora.md) + - [Windows](installing/native/windows.md) + - [MacOS](installing/native/mac.md) + +- [Getting Packages](installing/packages/README.md) + - [Getting Packages - venv](installing/packages/venv.md) + - [Saving Packages - requirements.txt](installing/packages/requirements.txt.md) + + + +# Managing Python Projects +- [Software Collaboration Essentials](basics/collaboration/README.md) + - [The Story of 1000 Monkeys 🐒](basics/collaboration/monkeys.md) + - [How Professional Monkeys Work 🍌](basics/collaboration/dvcs.md) + - [The git Video Game](basics/collaboration/git.md) + +- [Anatomy of a Python Project](projects/basics/README.md) + - [pyproject.toml](projects/basics/pyproject.toml.md) + - [poetry](projects/basics/poetry.md) + +- [Filling the Python Toolbelt](projects/tooling/README.md) + - [Auto-Formatting](projects/tooling/formatting.md) + - [Type Checking](projects/tooling/types.md) + - [Code Quality Analysis](projects/tooling/quality.md) + - [Parameterized Testing](projects/tooling/testing.md) + - [Containerization](projects/tooling/containers.md) + - ["Do I need all this?"](projects/tooling/conclusion.md) + +- [Anatomy of a Serious (TM) Python Project](projects/real_world/README.md) + - [podman + poetry](projects/real_world/podman_poetry.md) + - [.editorconfig](projects/real_world/editorconfig.md) + - [ruff](projects/real_world/ruff.md) + - [black](projects/real_world/black.md) + - [pre-commit](projects/real_world/pre_commit.md) + - [run.py](projects/real_world/run.py.md) + + + +# Python Guides for DTU Courses +- [Polytech Foundation](course_guides/polytech/README.md) + - [01001/01003 - Mathematics 1a](course_guides/polytech/01001_01003.md) + - [02002/02003 - Computer Programming](course_guides/polytech/02002_02003.md) +- [DTU Compute](course_guides/dtu_compute/README.md) + - [02502 - Image Analysis](course_guides/dtu_compute/02502.md) + + + +# Reference +- [Cheat Sheets](reference/cheat_sheets/README.md) + - [git Cheat Sheet](reference/cheat_cheets/git.md) + - [import Cheat Sheet](reference/cheat_shets/import.md) + - [Package Cheat Sheet](reference/cheat_shets/package.md) + +- [Tips & Tricks](reference/tips/README.md) + - [Sofus' Tips](reference/tips/sofus.md) + +- [Managed Ecosystems](installing/ecosystems/README.md) + - [conda](installing/ecosystems/conda.md) + +# Meta +- [Improve This Book](meta/contributing/README.md) + - [How To: Report Bugs/Confusion](meta/contributing/bugs.md) + - [How To: Propose a Change](meta/contributing/change.md) + +- [Moderating Chat](meta/chat/README.md) + - [Using for Courses](meta/chat/course.md) + - [Rules / Code of Conduct](meta/chat/rules.md) diff --git a/src/basics/collaboration/README.md b/src/basics/collaboration/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/collaboration/dvcs.md b/src/basics/collaboration/dvcs.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/collaboration/git.md b/src/basics/collaboration/git.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/collaboration/monkeys.md b/src/basics/collaboration/monkeys.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/README.md b/src/basics/nonobvious_stuff/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/conclusion.md b/src/basics/nonobvious_stuff/conclusion.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/execute.md b/src/basics/nonobvious_stuff/execute.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/files.md b/src/basics/nonobvious_stuff/files.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/foss.md b/src/basics/nonobvious_stuff/foss.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/markdown.md b/src/basics/nonobvious_stuff/markdown.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/networks.md b/src/basics/nonobvious_stuff/networks.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/nonobvious_stuff/passwords.md b/src/basics/nonobvious_stuff/passwords.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/terminal/README.md b/src/basics/terminal/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/terminal/linux.md b/src/basics/terminal/linux.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/terminal/mac.md b/src/basics/terminal/mac.md new file mode 100644 index 0000000..e69de29 diff --git a/src/basics/terminal/windows.md b/src/basics/terminal/windows.md new file mode 100644 index 0000000..e69de29 diff --git a/src/chapter_1.md b/src/chapter_1.md deleted file mode 100644 index b743fda..0000000 --- a/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/src/course_guides/dtu_compute/02502.md b/src/course_guides/dtu_compute/02502.md new file mode 100644 index 0000000..98c70e4 --- /dev/null +++ b/src/course_guides/dtu_compute/02502.md @@ -0,0 +1 @@ +# 02502 - Image Analysis diff --git a/src/course_guides/dtu_compute/README.md b/src/course_guides/dtu_compute/README.md new file mode 100644 index 0000000..e13244b --- /dev/null +++ b/src/course_guides/dtu_compute/README.md @@ -0,0 +1 @@ +# DTU Compute diff --git a/src/course_guides/polytech/01001_01003.md b/src/course_guides/polytech/01001_01003.md new file mode 100644 index 0000000..7d9b668 --- /dev/null +++ b/src/course_guides/polytech/01001_01003.md @@ -0,0 +1 @@ +# 01001/01003 - Mathematics 1a diff --git a/src/course_guides/polytech/02002_02003.md b/src/course_guides/polytech/02002_02003.md new file mode 100644 index 0000000..995002d --- /dev/null +++ b/src/course_guides/polytech/02002_02003.md @@ -0,0 +1 @@ +# 02002/02003 - Computer Programming diff --git a/src/course_guides/polytech/README.md b/src/course_guides/polytech/README.md new file mode 100644 index 0000000..4d206ee --- /dev/null +++ b/src/course_guides/polytech/README.md @@ -0,0 +1 @@ +# Polytech Foundation diff --git a/src/help.md b/src/help.md new file mode 100644 index 0000000..e69de29 diff --git a/src/how-to.md b/src/how-to.md new file mode 100644 index 0000000..e69de29 diff --git a/src/installing/ecosystems/README.md b/src/installing/ecosystems/README.md new file mode 100644 index 0000000..cf60d23 --- /dev/null +++ b/src/installing/ecosystems/README.md @@ -0,0 +1 @@ +# Managed Ecosystems diff --git a/src/installing/ecosystems/conda.md b/src/installing/ecosystems/conda.md new file mode 100644 index 0000000..c30b812 --- /dev/null +++ b/src/installing/ecosystems/conda.md @@ -0,0 +1 @@ +# conda diff --git a/src/installing/here-be-magic.md b/src/installing/here-be-magic.md new file mode 100644 index 0000000..37edbe8 --- /dev/null +++ b/src/installing/here-be-magic.md @@ -0,0 +1 @@ +# BEWARE: Here Be Magic diff --git a/src/installing/native/README.md b/src/installing/native/README.md new file mode 100644 index 0000000..3a32ac2 --- /dev/null +++ b/src/installing/native/README.md @@ -0,0 +1,3 @@ +# TODO +- Decide which Python versions the book will deal with. +- Incorporate more native Python install docs: https://docs.python.org/3/using/index.html diff --git a/src/installing/native/arch.md b/src/installing/native/arch.md new file mode 100644 index 0000000..c6c65ad --- /dev/null +++ b/src/installing/native/arch.md @@ -0,0 +1,5 @@ +To be Written... + +Links: +- +- diff --git a/src/installing/native/debian.md b/src/installing/native/debian.md new file mode 100644 index 0000000..ce2ee92 --- /dev/null +++ b/src/installing/native/debian.md @@ -0,0 +1,91 @@ +# Debian +|Python Version|Debian 11 (bullseye)|Debian 12 (bookworm)| +|:------------:|:------------------:|:------------------:| +| 3.9 | X | | +| 3.11 | | X | + +[Debian](https://www.debian.org/) is a general-purpose operating system often used as a base for other operating systems, notably Ubuntu. + +Debian "Stable" is released every two years, and notably, only security updates are allowed in this time. +This helps makes Debian an exceedinly reliable foundation, at the cost of no new software features for two years at a time. + +Debian is usually used with the Linux kernel; thus, "Debian Linux". + +## Installing Python on Debian Linux +Python often comes pre-installed on Debian. +Sometimes it doesn't, for example on rented cloud servers. + +You can always install Python securely and easily the usual way with apt. **Note: Remember to pre-append apt with `sudo`** +```bash +# image: docker.io/debian:bookworm +# command: bash +# user: root +apt update +apt install python3 + +# Remember, `sudo ...` lets any "administrator" user run one command as root. +# - Ex. `sudo apt update`. +``` + +Make sure to check that `python` is available: +```bash +# user: any +python3 --version +>>> Python 3.11.2 + +python3 -c "print('Hello World')" +>>> Hello World! +``` + +For convenience, we suggest you also install `python-is-python3` +```bash +# user: root +apt install python-is-python3 +``` +which lets you invoke Python using `python` instead of `python3`: +```bash +# user: any +python --version +>>> Python 3.10.12 +``` + + + +# Important Information +Here are some things to keep in mind when using Python on Debian. + +## Don't Use pip (without venv) +Many websites will encourage you to run things like `sudo pip install`. + +**Don't**. + +**Seriously, [Don't Break Debian](https://wiki.debian.org/DontBreakDebian)**. + +If you need packages on your Debian system, **always** prefer the built-in Debian packages. Here are some that are commonly used at DTU: +- `numpy`: +- `pandas`: +- `scipy`: +- `matplotlib`: +- `seaborn`: + +You can find such packages on [Debian's package search](https://packages.debian.org/search?keywords=search). + +### ...But I need the newest packages / a specific version of a package! +This is what `venv`s ("Virtual Environments") are for. +See [our article on venv](../packages/venv.md). + + +## What's with the Toy Story release names? +In 1995, the Debian Project Leader worked at Pixar. +Thus, Debian was granted permission to name releases after Toy Story characters. + +The tradition continues to this day! + + + +# Reference +- Debian Wiki on Python: +- Bugs in Debian Python: +- Python Package Info: +- Debian Package Tracker: +- Debian Wiki on Toy Story: diff --git a/src/installing/native/fedora.md b/src/installing/native/fedora.md new file mode 100644 index 0000000..c9bcba8 --- /dev/null +++ b/src/installing/native/fedora.md @@ -0,0 +1,4 @@ +To Be Written... + +Links: +- Fedora has a super nice guide already (). diff --git a/src/installing/native/mac.md b/src/installing/native/mac.md new file mode 100644 index 0000000..c27f599 --- /dev/null +++ b/src/installing/native/mac.md @@ -0,0 +1,98 @@ +# macOS +|Python Version|brew python@3.9|brew python@3.10|brew python@3.11| +|:------------:|:-------------:|:--------------:|:--------------:| +| 3.9 | X | | | +| 3.10 | | X | | +| 3.11 | | | X | + +[macOS](https://en.wikipedia.org/wiki/MacOS) is a pseudo-BSD-based general-purpose operating system, developed and commercially supported by Apple Inc. + +macOS is released approximately every year, with security updates historically available for ~3 years after release. + +*NOTE: macOS is not "free" (as in "user freedom") software*. + +## Installing Python on macOS: Supported Method +**First, take a deep breath**. +*This is not always entirely simple. But we promise to walk you through it!* + +If you've previously installed Python, **uninstall it thoroughly before starting**. + +### 1. Installing `brew` - The Missing Package Manager for macOS +[Homebrew](https://brew.sh/) is a package manager for your Mac. +Think of it as an **app store for nerds** (yes you are, M\*. Engineer!) + +1. Downlod the latest `.pkg` installer from Homebrew: +2. Follow the instructions. + +Good job! Let's get Python now. + +### 2. Installing `python` +*Now for the scary bit*. + +1. Open up Spotlight, and search for "Terminal". Open it! +2. Type the following command: `brew install python@3` +3. Press Enter! + +Now, sit back as `brew` does everything for you. +That's it! + +### 3. Updating `python` +The best thing about any *app store* ($\equiv$ package managers) is, that it can update stuff for you. + +1. Open up Spotlight, and search for "Terminal". Open it! +2. Type the following command: `brew update`, then press ENTER. + - This **checks for new versions** of any `brew`-managed software. +3. Type the following command: `brew upgrade`, then press ENTER. + - This **actually updates** all `brew`-managed software, if updates are available. + +That's it! + +### Disclaimer +**When you update Python, your code may break**. +Additionally, your code may simply not work for anyone using a slightly different Python version and/or slightly different packages. + +See [our article on Python projects](../../projects/basics/README.md) to learn how to prevent this in a collaboration-friendly way. + + + +# Important Information +Here are some things to keep in mind when using Python on macOS. + +## Don't Use pip (without venv) +Many websites will encourage you to run things like `sudo pip install`. + +**Don't**. + +Seriously, it is **very easy to break macOS with pip**. + +When using Python packages on macOS, you **must** isolate them from your system. +The easiest way to do this is with the built-in `venv` ("Virtual Environments"). +See [our article on venv](../packages/venv.md) for help. + + + +# Unsupported Installation Methods +We **strongly suggest** using the method described above. +Here we'll briefly describe some other installation methods, and explain why we don't suggest them. + +## Built-In Python +Some versions of macOS come with a built-in version of Python. +These are optimized for internal use by your operating system. + +We don't suggest using it for the following reasons: +- **It cannot be updated**. Attempting to is nearly guaranteed to *break macOS*. +- The installation is tailored to the internal needs of the macOS system, *not* to the needs of users. This can cause small, but significant, issues. + +## python.org Installer +An installer for Python is available from python.org() + +We don't suggest it for the following reasons: +- Finding what to download can be confusing, and there is only one right option. +- The installer asks some confusing questions, which can lead to very significant differences in how the install works. +- Updates must be installed manually. +- Generally speaking, *software downloaded from websites shouldn't be trusted*. Rather, a trusted package manager / app store should be preferred. + + + +# Reference +- Python Documentation on macOS: diff --git a/src/installing/native/ubuntu.md b/src/installing/native/ubuntu.md new file mode 100644 index 0000000..73bc89a --- /dev/null +++ b/src/installing/native/ubuntu.md @@ -0,0 +1,85 @@ +# Ubuntu +|Python Version|Ubuntu 20.04 (focal)|Ubuntu 22.04 (jammy)| +|:------------:|:------------------:|:------------------:| +| 3.8 | ~ | | +| 3.10 | | X | + +[Ubuntu Linux](https://ubuntu.com/desktop) is a general-purpose Debian-based operating system, developed and commercially supported by Canonical Ltd. + +Ubuntu LTS ("Long Term Support") is released every two years, and notably, only security updates are allowed in LTS during this time. +Smaller, optional releases between LTS releases provide newer software to users who don't need maximum stability. + +Ubuntu is known especially for its: +- Beginner-friendly desktop focus on making any computer "just work", including official laptops with pre-installed Ubuntu from ex. Dell. +- Wide range of [flavors](https://ubuntu.com/desktop/flavours) with their own take on modern, productive interfaces. +- Availability of full-stack commercial support for server flavors. + +## Installing Python on Ubuntu Linux +Python often comes pre-installed on Ubuntu. +Sometimes it doesn't, for example on rented cloud servers. + +You can always install Python securely and easily the usual way: +```bash +# image: docker.io/ubuntu:jammy +# command: bash +# user: root +apt update +apt install python3 + +# Remember, `sudo ...` lets any "administrator" user run one command as root. +# - Ex. `sudo apt update`. +``` + +Make sure to check that `python` is available: +```bash +# user: any +python3 --version +>>> Python 3.10.12 + +python3 -c "print('Hello World')" +>>> Hello World! +``` + +For convenience, we suggest you also install `python-is-python3` +```bash +# user: root +apt install python-is-python3 +``` +which lets you invoke Python using `python` instead of `python3`: +```bash +# user: any +python --version +>>> Python 3.10.12 +``` + + + +# Important Information +Here are some things to keep in mind when using Python on Ubuntu. + +## Don't Use pip (without venv) +Many websites will encourage you to run things like `sudo pip install`. + +**Don't**. + +**Seriously, [Don't Break Debian (/Ubuntu)](https://wiki.debian.org/DontBreakDebian)**. + +If you need packages on your Ubuntu system, **always** prefer the built-in Ubuntu packages. Here are some that are commonly used at DTU: +- `numpy`: +- `pandas`: +- `scipy`: +- `matplotlib`: +- `seaborn`: + +You can find such packages on [Ubuntu's package search](https://packages.ubuntu.com/). + +### ...But I need the newest packages / a specific version of a package! +This is what `venv`s ("Virtual Environments") are for. +See [our article on venv](../packages/venv.md). + + + +# Reference +- Ubuntu Wiki on Python: +- Bugs in Ubuntu Python: +- Python Package Info: diff --git a/src/installing/native/windows.md b/src/installing/native/windows.md new file mode 100644 index 0000000..1fbbd1c --- /dev/null +++ b/src/installing/native/windows.md @@ -0,0 +1,58 @@ +# Windows +|Python Version|MS Store @3.9|MS Store @3.10|MS Store @3.11| +|:------------:|:------------:|:-----------:|:------------:| +| 3.9 | X | | | +| 3.10 | | X | | +| 3.11 | | | X | + +[Windows]() is a general-purpose operating system, developed and commercially supported by Microsoft. + +Windows is released continuously, with large upgrades + +*NOTE: Windows is not "free" (as in "user freedom") software*. + +## Installing Python on Windows: Microsoft Store +Luckily, Python on Windows has gotten much simpler in recent years. +Using the official Microsoft Store enables official support and automatic updates. + +1. Open the Microsoft Store. +2. Locate Python 3.11 on the Microsoft Store. + - Link: +3. Install the App. + +To test if everything is working, open the `Powershell` application and type `python --version` + +### Disclaimer +**When you update Python, your code may break**. +Additionally, your code may simply not work for anyone using a slightly different Python version and/or slightly different packages. + +See [our article on Python projects](../../projects/basics/README.md) to learn how to prevent this in a collaboration-friendly way. + + + +# Important Information +Here are some things to keep in mind when using Python on Windows. + +## Don't Use pip (without venv) +Many websites will encourage you to run things like `sudo pip install`. + +**Don't**. + +Seriously, it is **very easy to break Windows with pip**. + +When using Python packages on Windows, you **must** isolate them from your system. +The easiest way to do this is with the built-in `venv` ("Virtual Environments"). +See [our article on venv](../packages/venv.md) for help. + + + +# Unsupported Installation Methods +We **strongly suggest** using the method described above. +Here we'll briefly describe some other installation methods, and explain why we don't suggest them. + +TBD + + + +# Reference +- TBD diff --git a/src/installing/packages/README.md b/src/installing/packages/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/installing/packages/requirements.txt.md b/src/installing/packages/requirements.txt.md new file mode 100644 index 0000000..e69de29 diff --git a/src/installing/packages/venv.md b/src/installing/packages/venv.md new file mode 100644 index 0000000..e69de29 diff --git a/src/introduction.md b/src/introduction.md new file mode 100644 index 0000000..e69de29 diff --git a/src/meta/chat/README.md b/src/meta/chat/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/meta/chat/course.md b/src/meta/chat/course.md new file mode 100644 index 0000000..32e799c --- /dev/null +++ b/src/meta/chat/course.md @@ -0,0 +1 @@ +# Using for Courses diff --git a/src/meta/chat/rules.md b/src/meta/chat/rules.md new file mode 100644 index 0000000..e69de29 diff --git a/src/meta/contributing/README.md b/src/meta/contributing/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/meta/contributing/bugs.md b/src/meta/contributing/bugs.md new file mode 100644 index 0000000..e69de29 diff --git a/src/meta/contributing/change.md b/src/meta/contributing/change.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/basics/README.md b/src/projects/basics/README.md new file mode 100644 index 0000000..d359830 --- /dev/null +++ b/src/projects/basics/README.md @@ -0,0 +1 @@ +# Anatomy of a Python Project diff --git a/src/projects/basics/poetry.md b/src/projects/basics/poetry.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/basics/pyproject.toml.md b/src/projects/basics/pyproject.toml.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/real_world/README.md b/src/projects/real_world/README.md new file mode 100644 index 0000000..c90fd25 --- /dev/null +++ b/src/projects/real_world/README.md @@ -0,0 +1 @@ +# Anatomy of a Serious (TM) Python Project diff --git a/src/projects/real_world/black.md b/src/projects/real_world/black.md new file mode 100644 index 0000000..2e8f135 --- /dev/null +++ b/src/projects/real_world/black.md @@ -0,0 +1 @@ +# black diff --git a/src/projects/real_world/editorconfig.md b/src/projects/real_world/editorconfig.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/real_world/podman_poetry.md b/src/projects/real_world/podman_poetry.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/real_world/pre_commit.md b/src/projects/real_world/pre_commit.md new file mode 100644 index 0000000..95148da --- /dev/null +++ b/src/projects/real_world/pre_commit.md @@ -0,0 +1 @@ +# pre-commit diff --git a/src/projects/real_world/ruff.md b/src/projects/real_world/ruff.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/real_world/run.py.md b/src/projects/real_world/run.py.md new file mode 100644 index 0000000..3ae1eb7 --- /dev/null +++ b/src/projects/real_world/run.py.md @@ -0,0 +1 @@ +# run.py diff --git a/src/projects/reproducibility/README.md b/src/projects/reproducibility/README.md new file mode 100644 index 0000000..79cb1ac --- /dev/null +++ b/src/projects/reproducibility/README.md @@ -0,0 +1 @@ +# Reproducible Python diff --git a/src/projects/tooling/README.md b/src/projects/tooling/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/conclusion.md b/src/projects/tooling/conclusion.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/containers.md b/src/projects/tooling/containers.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/formatting.md b/src/projects/tooling/formatting.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/quality.md b/src/projects/tooling/quality.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/testing.md b/src/projects/tooling/testing.md new file mode 100644 index 0000000..e69de29 diff --git a/src/projects/tooling/types.md b/src/projects/tooling/types.md new file mode 100644 index 0000000..e69de29 diff --git a/src/reference/cheat_cheets/git.md b/src/reference/cheat_cheets/git.md new file mode 100644 index 0000000..3953c43 --- /dev/null +++ b/src/reference/cheat_cheets/git.md @@ -0,0 +1 @@ +# git Cheat Sheet diff --git a/src/reference/cheat_sheets/README.md b/src/reference/cheat_sheets/README.md new file mode 100644 index 0000000..d9e3320 --- /dev/null +++ b/src/reference/cheat_sheets/README.md @@ -0,0 +1 @@ +# Cheat Sheets diff --git a/src/reference/cheat_sheets/git.md b/src/reference/cheat_sheets/git.md new file mode 100644 index 0000000..e69de29 diff --git a/src/reference/cheat_sheets/import.md b/src/reference/cheat_sheets/import.md new file mode 100644 index 0000000..e69de29 diff --git a/src/reference/cheat_shets/import.md b/src/reference/cheat_shets/import.md new file mode 100644 index 0000000..fbe8932 --- /dev/null +++ b/src/reference/cheat_shets/import.md @@ -0,0 +1 @@ +# import Cheat Sheet diff --git a/src/reference/cheat_shets/package.md b/src/reference/cheat_shets/package.md new file mode 100644 index 0000000..ffaae69 --- /dev/null +++ b/src/reference/cheat_shets/package.md @@ -0,0 +1 @@ +# Package Cheat Sheet diff --git a/src/reference/ecosystems/README.md b/src/reference/ecosystems/README.md new file mode 100644 index 0000000..e69de29 diff --git a/src/reference/ecosystems/conda.md b/src/reference/ecosystems/conda.md new file mode 100644 index 0000000..e69de29 diff --git a/src/reference/tips/README.md b/src/reference/tips/README.md new file mode 100644 index 0000000..a0c1a69 --- /dev/null +++ b/src/reference/tips/README.md @@ -0,0 +1 @@ +# Tips & Tricks diff --git a/src/reference/tips/sofus.md b/src/reference/tips/sofus.md new file mode 100644 index 0000000..ac14e97 --- /dev/null +++ b/src/reference/tips/sofus.md @@ -0,0 +1,25 @@ +To be Written... + + +# Email Copy/Paste +From my own email. + +*Especially important to me is to support the development of the intuition that allows students to express their engineering needs semantically, and the curiosity to not simply take the "easy" way (at least, what seems easy ex. global variables and for..append), but to make a daily goal of exploring new ways to more elegantly express concepts using the available language tools. For fun, for some, but more importantly, so that all can create better behaved software tools to accomplish their own unique engineering goals.* + +With those big words, here goes! +- `import this`: I think PEP 20 really sets the tone for the whole 'computational thinking' buzz. 10min evangelizing it is time well-spent. I think so, anyway :) +- `help(anything)` and `dir()`: Python's own help system is actually quite nice. People should know built-in help systems like this. It especially helps when trying to figure out what to google / cutting through too-dense library documentation. + +Moving past day 1: +- `complex(real = 1, imag = 2)`: A godsend for any student checking their imaginary calculations. +- `range(10, -1, -1)`: That `range` is [s,e) with a direction too is strange at first, and this is a helpful explainer. +- `from pathlib import Path`: It's not immediately obvious what's wrong with `open("C:\Users\MrBean\...")`, until the TA tries to run the code. `pathlib` has been solving headaches since 2012's PEP 428. +- `{s % 2 for s in range(10)}`: Friends don't let friends `for...append`! Especially not when deduplication is desired! + +As students get stronger: +- `with open(...) as f: ...`: `close()` has icky `free(*ptr)` vibes. `with` has such a nice mental model, which I feel everyone using Python deserves to be introduced to from the start. +- `settings_dict = tomllib.load(settings_file)`: Most people will need to configure their software one day. Config files are the lowest barrier to entry, and TOML is one of the simplest and least brittle. *Hopefully PEP 723 makes it through, in which case having met TOML will be even more vital!* +- `itertools.count`: That iterators can run forever, and that this is super useful, is one of those "aha" moments that I think is kind of important for everyone to get behind. +- `functools.lru_cache`: I've always found recursive `fibbonacci` a good little mind bender when unfamiliar with recursion. `lru_cache` makes it and other things fast! Plus, what better way to stimulate respect for caches than demonstrating how to abuse a simple one? + +There are more, of course; `re` with regex101.com should be common knowledge, as should `shutil` for the more dangerous filesystem operations, `subprocess.run`, `print(file=)`, and so on... It is all subjective anyway, but I hope this gave a nice overview of how I like to think about things.