diff --git a/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml b/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml new file mode 100644 index 0000000..258298b --- /dev/null +++ b/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml @@ -0,0 +1,38 @@ +name: 📖 Documentation +on: + push: + branches: + - main + - docs + # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory + paths: + - ".github/workflows/BuildMKDocsAndPublishToGithubPages.yml" + - "docs/**.md" + - "docs/**.py" + - "docs/assets/**" + # Allow manually running in the actions tab + workflow_dispatch: + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout main from github + uses: actions/checkout@v1 + - name: Create Mkdocs Config 🚀 + working-directory: ./docs + run: ./create-mkdocs-html-config.sh + - name: Deploy docs to github pages + # This is where we get the material theme from + uses: timlinux/mkdocs-deploy-gh-pages@master + # Wrong + #uses: timlinux/QGISAnimationWorkbench@main + env: + # Read this carefully: + # https://github.com/marketplace/actions/deploy-mkdocs#building-with-github_token + # The token is automatically generated by the GH Action + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BASE_DIRECTORY: docs + CONFIG_FILE: docs/mkdocs.yml + REQUIREMENTS: docs/requirements.txt diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index 122602c..160b24e 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -68,6 +68,7 @@ jobs: make dev-runserver make dev-load-demo-data make sleep + # TODO: # Fix this after we have the tests # - name: Test django endpoint diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /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/Makefile b/Makefile index ef29300..f9cde75 100644 --- a/Makefile +++ b/Makefile @@ -55,7 +55,8 @@ dev-test: @echo "Run tests" @echo "------------------------------------------------------------------" @docker-compose exec -T dev python manage.py collectstatic --noinput - @docker-compose exec -T dev python manage.py test --keepdb --noinput + @docker-compose exec -T dev python manage.py test cloud_native_gis.tests --keepdb --noinput +# TODO: Remove cloud_native_gis.tests by fixing issue https://github.com/kartoza/CloudNativeGIS/issues/7 serve: @echo diff --git a/README.md b/README.md index 6985d3f..e6ffebd 100644 --- a/README.md +++ b/README.md @@ -1 +1,129 @@ -# Kartoza Cloud Native GIS \ No newline at end of file +# Cloud Native GIS + +[![Tests](https://github.com/kartoza/CloudNativeGIS/workflows/Tests/badge.svg)](https://github.com/kartoza/CloudNativeGIS/actions/workflows/tests.yaml) +[![📖 Documentation](https://github.com/kartoza/CloudNativeGIS/actions/workflows/BuildMKDocsAndPublishToGithubPages.yml/badge.svg)](https://kartoza.github.io/CloudNativeGIS/) + +## Overview + +Cloud Native GIS is a platform for handling layers and served on map. + +## Key Concepts + +**Layer** can be in vector and raster and being served as tile. + +**Style** is saved in database. Vector layer is in mapbox style. + +**Maputnik** is being used to change the style. + +## Quick installation + +### Production + +``` +git submodule update +git clone https://github.com/kartoza/CloudNativeGIS +cp deployment/.template.env deployment/.env +cp deployment/docker-compose.override.template deployment/docker-compose.template +make up +``` + +The web will be available at `http://127.0.0.1/` + +To stop containers: + +``` +make kill +``` + +To stop and delete containers: + +``` +make down +``` + +### Install as django library + +This application can be installed as django library. + +To install it, put `git+https://github.com/kartoza/CloudNativeGIS.git` to +requirements.
+Add `cloud_native_gis` to INSTALLED_APPS,
+and add url `path('', include('cloud_native_gis.urls'))`. + +### Development + +``` +git submodule update +git clone https://github.com/kartoza/CloudNativeGIS +cp deployment/.template.env deployment/.env +cp deployment/docker-compose.override.template deployment/docker-compose.template +``` + +After that, do + +- open new terminal +- on folder root of project, do + +``` +make serve +``` + +Wait until it is done +when there is sentence "webpack xxx compiled successfully in xxx ms".
+After that, don't close the terminal. +If it is accidentally closed, do `make serve` again + +Next step: + +- Open new terminal +- Do commands below + +``` +make up +make dev +``` + +Wait until it is on. + +The web can be accessed using `http://localhost:5000/` + +If the web is taking long time to load, restart cloud_native_gis_dev_1 container.
+The sequence should be `make dev`, after that run or restart cloud_native_gis_dev_1. + +### Maputnik updates + +CloudNativeGIS using maputnik to edit style. +We could update maputnik in the folder root/maputnik. +Maputnik can be accessed in the django-admin and layers, and there is "editor" +column that will be redirect to maputnik instance. +By default, it is using maputnik production. + +To change and test maputnik: + +``` +make serve-maputnik +``` + +After it is done, there will be link to maputnik. +Copy the link and paste in: +go to deployment/.env +change MAPUTNIK_URL to the copied link + +``` +restart dev container +``` + +After done, we need to update the maputnik production.
+First, create commit of maputnik and push it to repo. +Then + +``` +make build-maputnik +``` + +It will create files in the +django_project/cloud_native_gis/templates/maputnik.html +and also assets in the django_project/cloud_native_gis/static + +After that, test it by remove MAPUTNIK_URL and restart dev container. +If satisfied, just create commit for the changes. \ No newline at end of file diff --git a/deployment/.template.env b/deployment/.template.env index 66a825a..6f0e427 100644 --- a/deployment/.template.env +++ b/deployment/.template.env @@ -19,3 +19,4 @@ REDIS_PASSWORD=redis_password RABBITMQ_HOST=rabbitmq SENTRY_DSN= SECRET_KEY=SECRET_KEY +MAPUTNIK_URL= \ No newline at end of file diff --git a/deployment/docker-compose.override.template.yml b/deployment/docker-compose.override.template.yml index 0d57f09..98edb46 100644 --- a/deployment/docker-compose.override.template.yml +++ b/deployment/docker-compose.override.template.yml @@ -61,6 +61,7 @@ services: - DATABASE_PASSWORD=${DATABASE_PASSWORD:-docker} - DATABASE_HOST=${DATABASE_HOST:-db} - DJANGO_SETTINGS_MODULE=core.settings.dev + - MAPUTNIK_URL=${MAPUTNIK_URL} # Email where alters should be sent. This will be used by let's encrypt and as the django admin email. - ADMIN_USERNAME=${ADMIN_USERNAME:-admin} diff --git a/django_project/cloud_native_gis/utils/layer.py b/django_project/cloud_native_gis/utils/layer.py index c1dc45f..7f8a0b6 100644 --- a/django_project/cloud_native_gis/utils/layer.py +++ b/django_project/cloud_native_gis/utils/layer.py @@ -12,7 +12,10 @@ def maputnik_url() -> str: """Return url for mapnik layer.""" try: - return os.environ['MAPUTNIK_URL'] + maputnik_url = os.environ['MAPUTNIK_URL'] + if not maputnik_url: + raise KeyError() + return maputnik_url except KeyError: return reverse('cloud-native-gis-maputnik') diff --git a/docs/.envrc b/docs/.envrc new file mode 100644 index 0000000..c994689 --- /dev/null +++ b/docs/.envrc @@ -0,0 +1,2 @@ +use nix +layout python diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..0446c85 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,15 @@ +.idea +.venv +pdfs/ + +# mkdocs related +mkdocs.yml +templates/graphics.scss +site/* + +#direnv for docs building +.direnv +# Autogenerated api docs +src/developer/manual/*.md + +*.swp diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/docs/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/docs/README.md b/docs/README.md new file mode 100644 index 0000000..0e98b51 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,30 @@ +# Building the documentation as a PDF + +## Install Dependencies + +You need to install these packages: + +```bash +pip install mkdocs-with-pdf +pip install mkdocs-material +pip install mdx_gh_links +pip install mkdocs-pdf-export-plugin +``` + +## Building in a terminal + +> Note that whenever you add new sections to nav in the mkdocs.yml +> (used for building the web version), you should apply those same +> edits to mkdocs-pdf.yml if you want those new sections to appear +> in the pdf too. + +```bash +cd docs +./build-docs-pdf.sh +xdg-open Handbook.pdf +``` + +## Building in VSCode + +If you are in VSCode, you can also just run the 'Compile PDF' task. The +generated PDF will be placed in docs/pdfs/. diff --git a/docs/assets/kartoza-icon.png b/docs/assets/kartoza-icon.png new file mode 100644 index 0000000..071e57f Binary files /dev/null and b/docs/assets/kartoza-icon.png differ diff --git a/docs/build-docs-html.sh b/docs/build-docs-html.sh new file mode 100755 index 0000000..5073ac3 --- /dev/null +++ b/docs/build-docs-html.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash + +# This is only intended for local +# testing. See github workflows for +# how this build is automated. + +# this will create mkdocs.yml +./create-mkdocs-html-config.sh +# and this will build the html site +mkdocs build diff --git a/docs/build-docs-pdf.sh b/docs/build-docs-pdf.sh new file mode 100755 index 0000000..59e2cfd --- /dev/null +++ b/docs/build-docs-pdf.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash + +# This is only intended for local +# testing. See github workflows for +# how this build is automated. + +# this will create mkdocs.yml +./create-mkdocs-pdf-config.sh +# and this will build the PDF document +mkdocs build > /tmp/document.html diff --git a/docs/clean.sh b/docs/clean.sh new file mode 100755 index 0000000..58f6678 --- /dev/null +++ b/docs/clean.sh @@ -0,0 +1,6 @@ +#! /usr/bin/env bash + +rm -rf .venv +rm -rf site +rm -rf __pycache__ + diff --git a/docs/create-mkdocs-html-config.sh b/docs/create-mkdocs-html-config.sh new file mode 100755 index 0000000..b696d30 --- /dev/null +++ b/docs/create-mkdocs-html-config.sh @@ -0,0 +1,14 @@ +#!/usr/bin/env bash + +# This script will assemble a mkdocs.yml +# file with plugins section suitable for +# html site generation. + +# This script is used both in manual +# site compilation (via build-docs-html.sh) +# and via the github workflow for +# publishing the site to github pages +# .github/workflows/BuildMKDocsAndPublishToGithubPages.yml + +cat mkdocs-base.yml > mkdocs.yml +cat mkdocs-html.yml >> mkdocs.yml diff --git a/docs/create-mkdocs-pdf-config.sh b/docs/create-mkdocs-pdf-config.sh new file mode 100755 index 0000000..81ac674 --- /dev/null +++ b/docs/create-mkdocs-pdf-config.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +# This script will assemble a mkdocs.yml +# file with plugins section suitable for +# PDF site generation. + +# This script is used both in manual +# site compilation (via build-docs-html.sh) +# and via the github workflow for +# publishing the site to github pages +# .github/workflows/CompileMKDocsToPDF.yml + +cat mkdocs-base.yml > mkdocs.yml +cat mkdocs-pdf.yml >> mkdocs.yml +# This is a kludge: I could not figure out +# how to reference image resources using a relative path in the scss... +cat templates/graphics.scss.templ | sed "s?\[BASE_FOLDER\]?$PWD?g" > templates/graphics.scss diff --git a/docs/create-uuid.py b/docs/create-uuid.py new file mode 100755 index 0000000..7cd8a6b --- /dev/null +++ b/docs/create-uuid.py @@ -0,0 +1,5 @@ +#! /usr/bin/env python + +import shortuuid +uuid = shortuuid.uuid() +print (uuid) diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..e69de29 diff --git a/docs/default.nix b/docs/default.nix new file mode 100644 index 0000000..ee1388f --- /dev/null +++ b/docs/default.nix @@ -0,0 +1,61 @@ +with import { }; + +let + # For packages pinned to a specific version + pinnedHash = "933d7dc155096e7575d207be6fb7792bc9f34f6d"; + pinnedPkgs = import (fetchTarball "https://github.com/NixOS/nixpkgs/archive/${pinnedHash}.tar.gz") { }; + pythonPackages = pinnedPkgs.python3Packages; +in pkgs.mkShell rec { + name = "impurePythonEnv"; + venvDir = "./.venv"; + buildInputs = [ + # A Python interpreter including the 'venv' module is required to bootstrap + # the environment. + pythonPackages.python + + # This executes some shell code to initialize a venv in $venvDir before + # dropping into the shell + + # For PDF production in mkdocs + pythonPackages.venvShellHook + python311Packages.weasyprint + pinnedPkgs.cairo + pinnedPkgs.pango + pinnedPkgs.gdk-pixbuf + pinnedPkgs.glib + pinnedPkgs.gtk2 + # Those are dependencies that we would like to use from nixpkgs, which will + # add them to PYTHONPATH and thus make them accessible from within the venv. + pythonPackages.requests + pythonPackages.pygobject3 + # Doesnt work properly + #python311Packages.cffi + pinnedPkgs.gobject-introspection + pinnedPkgs.gtk3 + pinnedPkgs.taglib + pinnedPkgs.openssl + pinnedPkgs.git + pinnedPkgs.libxml2 + pinnedPkgs.libxslt + pinnedPkgs.libzip + pinnedPkgs.zlib + pinnedPkgs.gnused + pinnedPkgs.rpl + ]; + + # Run this command, only after creating the virtual environment + postVenvCreation = '' + unset SOURCE_DATE_EPOCH + pip install -r requirements.txt + ''; + + shellHook = '' + ''; + # Now we can execute any commands within the virtual environment. + # This is optional and can be left out to run pip manually. + postShellHook = '' + # allow pip to install wheels + unset SOURCE_DATE_EPOCH + ''; + +} diff --git a/docs/js/tablesort.js b/docs/js/tablesort.js new file mode 100644 index 0000000..573dd5d --- /dev/null +++ b/docs/js/tablesort.js @@ -0,0 +1,6 @@ +document$.subscribe(function () { + var tables = document.querySelectorAll("article table:not([class])") + tables.forEach(function (table) { + new Tablesort(table) + }) +}) \ No newline at end of file diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml new file mode 100644 index 0000000..00861e8 --- /dev/null +++ b/docs/mkdocs-base.yml @@ -0,0 +1,42 @@ +site_name: Cloud Native GIS +site_description: "Project technical and user documentation." +site_author: "Kartoza" +docs_dir: ./src +site_dir: ./site +repo_name: "CloudNativeGIS" +repo_url: "https://github.com/kartoza/CloudNativeGIS.git" +edit_uri: "https://github.com/kartoza/CloudNativeGIS/blob/main/docs/" + +copyright: Kartoza and Contributors + +markdown_extensions: + - attr_list # lets us resize images see https://github.com/mkdocs/mkdocs/issues/1678#issuecomment-455500757 + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + #- mdx_truly_sane_lists + - toc: + permalink: true + #slugify: !!python/name:pymdownx.slugs.slugify + - pymdownx.snippets: + base_path: . + - admonition + - tables + - pymdownx.details + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.emoji: + emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:materialx.emoji.twemoji + +nav: + - Home: + - index.md + - quick_installation.md \ No newline at end of file diff --git a/docs/mkdocs-html.yml b/docs/mkdocs-html.yml new file mode 100644 index 0000000..96700be --- /dev/null +++ b/docs/mkdocs-html.yml @@ -0,0 +1,109 @@ +# Configuration +theme: + name: material + language: en + direction: ltr + include_search_page: false + search_index_only: true + features: + - content.code.annotate + - content.tabs.link + - header.autohide + - navigation.expand + - navigation.indexes + - navigation.instant + - navigation.sections + - navigation.tabs + - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + palette: + - scheme: default + primary: blue + accent: grey + toggle: + icon: material/brightness-4 + name: Switch to dark mode + - scheme: slate + primary: blue + accent: grey + toggle: + icon: material/brightness-6 + name: Switch to light mode + font: + text: Roboto + code: Roboto Mono + favicon: assets/logo.png + icon: + logo: material/book + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/kartoza + +extra_css: + - css/print.css + +extra_javascript: + - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js + - js/tablesort.js + +# Needed for the hooks below to work +plugins: + - search + - git-revision-date-localized + - mkdocs-video + - mkdocstrings: + handlers: + python: + paths: [ ../django_project ] + import: + - https://docs.python.org/3/objects.inv + - https://mkdocstrings.github.io/autorefs/objects.inv + options: + # Lots of other nice options can be found at + # https://mkdocstrings.github.io/python/usage/ + docstring_style: sphinx + heading_level: 2 + show_bases: true + show_signature: true + separate_signature: true + show_signature_annotations: true + show_source: true + show_root_heading: true + show_root_full_path: true + show_root_members_full_path: true + merge_init_into_class: true + docstring_options: + ignore_init_summary: false + + - redirects: + redirect_maps: + #see https://github.com/mkdocs/mkdocs-redirects/tree/master#using + #'old.md': 'new.md' + #'old/file.md': 'new/file.md' + #'some_file.md': 'http://external.url.com/foobar' + - enumerate-headings: + toc_depth: 3 + strict: true + increment_across_pages: true + include: + - "*" + exclude: + - index.md + - developer/manual/*.md + restart_increment_after: + - second_section.md + +# Hook to add a uuid to every anchor +# see also hook.py and https://github.com/squidfunk/mkdocs-material/discussions/3758#discussioncomment-4397373 +# Note that although the above link implies you can use UUIDs, you have to use numeric IDS not UUIDS +hooks: + - ./uuid_redirects_hook.py + - ./python_manual_hook.py + diff --git a/docs/mkdocs-pdf.yml b/docs/mkdocs-pdf.yml new file mode 100644 index 0000000..7392d7c --- /dev/null +++ b/docs/mkdocs-pdf.yml @@ -0,0 +1,56 @@ +# See mkdocs base and the create-mkdocs* +# scripts for how this is used + +plugins: + - with-pdf: + # Generate the whole site as a single PDF + # Full details on this plugin here: + # https://github.com/orzih/mkdocs-with-pdf + # And don't get it confused with https://github.com/zhaoterryy/mkdocs-pdf-export-plugin + # which is intended to export a single page at a time + output_path: ../pdfs/Documentation.pdf + author: Kartoza + # copyright will draw in page.bottom-right + # do it manually in templates/styles.scss + # for more control + # if you comment out here or use an empty string, + # the copyright text from mkdocs-base.yml will be + # used instead + copyright: " " + cover: true # see templates/cover.html + back_cover: true + cover_title: Cloud Native GIS + cover_subtitle: Cloud Native GIS + # cover_logo: ./resources/img/logo/logo.svg + # Print css is defined in templates/styles.scss + #custom_template_path: TEMPLATES PATH + # + toc_title: Contents + #heading_shift: false + toc_level: 2 + # Set to 0 so that it does not generate chapter numbering + # we do the numbering in styles.css rather + ordered_chapter_level: 0 + #excludes_children: + # - 'release-notes/:upgrading' + # - 'release-notes/:changelog' + # + #exclude_pages: + # - 'bugs/' + # - 'appendix/contribute/' + #convert_iframe: + # - src: IFRAME SRC + # img: POSTER IMAGE URL + # text: ALTERNATE TEXT + # - src: ... + #two_columns_level: 3 + # + #render_js: true + #headless_chrome_path: headless-chromium + # + + #enabled_if_env: ENABLE_PDF_EXPORT + # See notes at the top of templates/styles.scss.templ + # for debugging workflow details. + debug_html: true + #show_anchors: true diff --git a/docs/python_manual_hook.py b/docs/python_manual_hook.py new file mode 100755 index 0000000..2eee186 --- /dev/null +++ b/docs/python_manual_hook.py @@ -0,0 +1,45 @@ +import logging +import mkdocs.plugins +import os +log = logging.getLogger('mkdocs') + +@mkdocs.plugins.event_priority(-50) + + +def on_startup(command, dirty): + + template = """ +--- +title: Automatically Generated Python Documentation +summary: DO NOT EDIT THIS FILE MANUALLY : It is created during the mkdocs build process +date: 2023-08-03 +--- + +# Python Reference Manual +""" + ignore_list = [ + "__init__", + "migrations", + "tests"] + for root, dirs, files in os.walk("../django_project"): + for file in files: + file = os.path.join(root, file) + ignored = False; + if file.endswith(".py"): + for item in ignore_list: + if item in file: + ignored = True; + #print (item, file, ignored) + if not ignored: + file = file.replace("../django_project/", "::: ") + file = file.replace("/", ".") + file = file.replace(".py", "") + template = template + file + "\n" + output_path = os.path.join( + os.path.dirname(os.path.abspath(__file__)), + "src/developer/manual/index.md") + log.info("Manual will be written to: " + output_path) + file = open(output_path,"wt+") + file.write(template) + file.close() + log.info("Manual written to: " + os.path.realpath(file.name)) diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..5b1c45a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,21 @@ +#Alternative for pdf creation - broken on nixos and lately ubuntu +mkdocs-with-pdf +# Export to pdf - see https://comwes.github.io/mkpdfs-mkdocs-plugin/index.html +#mkpdfs-mkdocs +# Rather do +# pip install -e git+https://github.com/jwaschkau/mkpdfs-mkdocs-plugin.git#egg=mkpdfs-mkdocs +mkdocs-material +mdx_gh_links +mkdocs-pdf-export-plugin +mkdocstrings-python +mkdocs-video +mkdocs-redirects +mkdocs-enumerate-headings-plugin +mkdocs-git-revision-date-localized-plugin +# needed for the create-uuid.py helper script +shortuuid +# Needed for mkdocstrings python documentation generator +black +cffi +# Needed for PDF back page QR Code +qrcode diff --git a/docs/run-server.sh b/docs/run-server.sh new file mode 100755 index 0000000..276f48a --- /dev/null +++ b/docs/run-server.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +cd site +httplz diff --git a/docs/src/developer/index.md b/docs/src/developer/index.md new file mode 100644 index 0000000..7c29992 --- /dev/null +++ b/docs/src/developer/index.md @@ -0,0 +1,18 @@ +--- +title: Documentation +summary: Cloud Native GIS + - Irwan Fathurrahman +date: 2024-06-01 +some_url: https://github.com/kartoza/CloudNativeGIS +copyright: Copyright 2024, Kartoza +contact: +license: 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. +context_id: +--- + +# For Developers + + + +This is the homepage for all developer related documentation. + diff --git a/docs/src/developer/manual/README.txt b/docs/src/developer/manual/README.txt new file mode 100644 index 0000000..98a8561 --- /dev/null +++ b/docs/src/developer/manual/README.txt @@ -0,0 +1,16 @@ + _ _ _ ____ _ +| \ | | ___ | |_ __ _ ___ | __ ) ___ _ __ __ _ ___ | | +| \| |/ _ \| __/ _` |/ _ \ | _ \ / _ \ '_ \ / _` |/ _ \ | | +| |\ | (_) | || (_| | __/ | |_) | __/ | | | (_| | __/ |_| +|_| \_|\___/ \__\__,_|\___| |____/ \___|_| |_|\__,_|\___| (_) + +IMPORTANT: DO NOT EDIT FILES IN THIS FOLDER BY HAND! + +The files in this folder will be generated by the script in + +docs/update_python_manual.py + +All markdown files in this folder will also be under .gitignore. + +Tim Sutton +10 August 2023 diff --git a/docs/src/developer/manual/img/naming-convention.README b/docs/src/developer/manual/img/naming-convention.README new file mode 100644 index 0000000..b7fd046 --- /dev/null +++ b/docs/src/developer/manual/img/naming-convention.README @@ -0,0 +1,7 @@ +# Image naming convention + +Images should be named according to reference doc, sub-section and order in document. +e.g. + +- The 1st image in instructions regarding zooming will be something like zooming-1, the 2nd image will be zooming-2, etc. +- The 1st image in quickstart regarding logging in will be login-1, etc diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..8735f2c --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,60 @@ +--- +title: Documentation +summary: Cloud Native GIS + - Irwan Fathurrahman +date: 2024-06-01 +some_url: https://github.com/kartoza/CloudNativeGIS +copyright: Copyright 2024, Kartoza +contact: +license: 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. +context_id: nDU6LLGiXPTLADXY +--- + +# Cloud Native GIS + +## Overview + +Cloud Native GIS is a platform for handling layers and served on map. + +## Key Concepts + +**Layer** can be in vector and raster and being served as tile. + +**Style** is saved in database. Vector layer is in mapbox style. + +**Maputnik** is being used to change the style. + +## Disclaimer + +
+The software provided by this project is provided 'as is'. All information provided +within the platform should be independently verified before using as the basis for +action. The contributors and developers of this platform take no responsibility +for any loss of revenue, life, physical harm or any other adverse outcome that may +occur as a result of the use of this platform. +
+ +## Releases + +Our releases are published on our [GitHub releases page](https://github.com/kartoza/CloudNativeGIS/releases) + +| | **Project Badges** | | +| ----------------------- | ----------------------- | ----------------------- | +| ![License](https://img.shields.io/github/license/kartoza/CloudNativeGIS.svg) | ![Version](https://img.shields.io/github/release/kartoza/CloudNativeGIS.svg) | ![Commits](https://img.shields.io/github/commits-since/kartoza/CloudNativeGIS/{version}.svg) | +| ![Issue Tracker](https://img.shields.io/github/issues/kartoza/CloudNativeGIS.svg) | ![Closed Issues](https://img.shields.io/github/issues-closed/kartoza/CloudNativeGIS.svg) | ![Pull requests](https://img.shields.io/github/issues-pr/kartoza/CloudNativeGIS.svg) | + +#### Project Chatroom + +We do not yet have a [Chatroom]() set up for this project. Please use the GitHub issue tracker for discussions rather. + +#### Contributor License Agreement (CLA) + +Contributions to this project will be subject to our [Contributor License Agreement]() (Coming soon) + +#### License + +This project is open source, published under the AGPL-3. +You can read our license to find out what rights this license bestows to users and contributors. + +[License](about/license.md) + diff --git a/docs/src/quick_installation.md b/docs/src/quick_installation.md new file mode 100644 index 0000000..7d1c1b1 --- /dev/null +++ b/docs/src/quick_installation.md @@ -0,0 +1,114 @@ +## Quick installation + +### Production + +``` +git submodule update +git clone https://github.com/kartoza/CloudNativeGIS +cp deployment/.template.env deployment/.env +cp deployment/docker-compose.override.template deployment/docker-compose.template +make up +``` + +The web will be available at `http://127.0.0.1/` + +To stop containers: + +``` +make kill +``` + +To stop and delete containers: + +``` +make down +``` + +### Install as django library + +This application can be installed as django library. + +To install it, put `git+https://github.com/kartoza/CloudNativeGIS.git` to +requirements.
+Add `cloud_native_gis` to INSTALLED_APPS,
+and add url `path('', include('cloud_native_gis.urls'))`. + +### Development + +``` +git submodule update +git clone https://github.com/kartoza/CloudNativeGIS +cp deployment/.template.env deployment/.env +cp deployment/docker-compose.override.template deployment/docker-compose.template +``` + +After that, do + +- open new terminal +- on folder root of project, do + +``` +make serve +``` + +Wait until it is done +when there is sentence "webpack xxx compiled successfully in xxx ms".
+After that, don't close the terminal. +If it is accidentally closed, do `make serve` again + +Next step: + +- Open new terminal +- Do commands below + +``` +make up +make dev +``` + +Wait until it is on. + +The web can be accessed using `http://localhost:5000/` + +If the web is taking long time to load, restart cloud_native_gis_dev_1 +container.
+The sequence should be `make dev`, after that run or restart +cloud_native_gis_dev_1. + +### Maputnik updates + +CloudNativeGIS using maputnik to edit style. +We could update maputnik in the folder root/maputnik. +Maputnik can be accessed in the django-admin and layers, and there is "editor" +column that will be redirect to maputnik instance. +By default, it is using maputnik production. + +To change and test maputnik: + +``` +make serve-maputnik +``` + +After it is done, there will be link to maputnik. +Copy the link and paste in: +go to deployment/.env +change MAPUTNIK_URL to the copied link + +``` +restart dev container +``` + +After done, we need to update the maputnik production.
+First, create commit of maputnik and push it to repo. +Then + +``` +make build-maputnik +``` + +It will create files in the +django_project/cloud_native_gis/templates/maputnik.html +and also assets in the django_project/cloud_native_gis/static + +After that, test it by remove MAPUTNIK_URL and restart dev container. +If satisfied, just create commit for the changes. \ No newline at end of file diff --git a/docs/templates/cover.html b/docs/templates/cover.html new file mode 100644 index 0000000..257b2a8 --- /dev/null +++ b/docs/templates/cover.html @@ -0,0 +1,8 @@ +
+

The Handbook

+
+ +
+

Kartoza

+

2024

+
\ No newline at end of file diff --git a/docs/templates/footer.svg b/docs/templates/footer.svg new file mode 100644 index 0000000..2c42a38 --- /dev/null +++ b/docs/templates/footer.svg @@ -0,0 +1,185 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/templates/graphics.scss.templ b/docs/templates/graphics.scss.templ new file mode 100644 index 0000000..a5b00e3 --- /dev/null +++ b/docs/templates/graphics.scss.templ @@ -0,0 +1,7 @@ +/* BASE FOLDER token will be replaced at compile time by our bash script. */ + + +$logo-url: url('file://[BASE_FOLDER]/assets/kartoza-icon.png'); +$corner-logo-url: url('file://[BASE_FOLDER]/assets/logo.svg'); +$header-url: url('file://[BASE_FOLDER]/templates/header.svg'); +$footer-url: url('file://[BASE_FOLDER]/templates/footer.svg'); diff --git a/docs/templates/header.svg b/docs/templates/header.svg new file mode 100644 index 0000000..bfba99d --- /dev/null +++ b/docs/templates/header.svg @@ -0,0 +1,173 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/templates/styles.scss b/docs/templates/styles.scss new file mode 100644 index 0000000..15dae3b --- /dev/null +++ b/docs/templates/styles.scss @@ -0,0 +1,544 @@ +/* Sass property declarations - these two files contain stuff you can edit. + Don't edit anything in this file unless you are wanting to improve the base style. + This file is only used for the pdf generation. + */ +@import "variables.scss"; +@import "graphics.scss"; +/* To debug and define css rules, run the generator in debug mode + by editing mkdocs-pdf.yml and enabling debug mode. Then + redirect the generator output to an html file e.g. + + ./build-docs-pdf.sh > /tmp/output.html + xdg-open /tmp/output.html + + Then use the inspect tool in your browser to identify the css paths + of styles you want to modify. + + */ + +@import url('https://fonts.googleapis.com/css2?family=Roboto+Slab&family=Source+Code+Pro&display=swap'); +@import url('https://fonts.googleapis.com/css2?family=Source+Code+Pro&display=swap'); +@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+Mono:wght@100&display=swap'); + +// +// Print media specific page setup +// + +html { + font-family: 'Roboto Slab', serif; + font-size: $font-size; + color: $font-color; +} + +img { + display: block; + margin-left: auto; + margin-right: auto; + width: 50%; +} + +.cover-logo { + background-image: $logo-url; + background-repeat: no-repeat; + width: 440px; + height: 440px; + z-index: 1000; + /* Center on page */ + margin-left: auto; + margin-right: auto; + margin-top: 40px; + width: 50%; + background-color: #fff; + /* ensures that svg stretches to fill the container */ + background-size: contain; +} + +@font-face { + src: url(../assets/AvenirLTStd-Book.otf); + font-family: avenir; +} + +@page { + /* size: a4 portrait; */ + size: 210mm 297mm; + margin: 0mm; + padding: 0mm; + counter-increment: page; + font-family: Georgia, serif; + font-size: $font-size; + white-space: normal; + color: $font-color; + /* + Margin properties next: + + See https://www.quackit.com/css/at-rules/css_bottom-left-corner_at-rule.cfm + for a nice explanation of the margin properties for css print layouts */ + + + @top-left-corner { + @if $show-top-left-corner-logo { + background: $corner-logo-url; + } + + background-repeat: no-repeat; + background-position: 0% 0%; + background-size: contain; + z-index: 99; + //Hack needed or image will not show + content: " "; + } + + + @top-left { + /* Note this element gets obscured by top-center if it is solid. */ + z-index: 95; + content: $document-title; + color: $document-title-color; + } + + @top-center { + /* Idiosyncratic note: The top center section is the + only one that you can expand out to the full width of the page. + Also: The left elements will render under it, the right elements + over it (the z order increases as you move right). + + Be careful trying to use a PNG background as the DPI is hard to configure + and your graphics will appear pixelated or not scale correctly + so rather use an SVG. + + The setup below will span your SVG across the page, make sure your + SVG document has exactly the same dimensions. Leave a pixel or two + white space to the very right of your SVG as the right edge is + difficult to page align. + */ + background-color: transparent; + /* Dont remove these two lines, they force the center element + to the width of the page and height of the footer image. */ + min-width: 210mm; + min-height: 22mm; + background-repeat: no-repeat; + background-position: 0% 0%; + background-size: contain; + size: 210mm 22mm; + border: none; + background: $header-url; + /* Hack needed or image will not show */ + content: " "; + z-index: 90; + } + + @top-right { + min-width: 100mm; + background-color: transparent; + /* hack to make it appear as box */ + content: " "; + } + + @bottom-left-corner { + /* has no effect on corner elements */ + max-width: 0mm; + background-color: transparent; + /* hack to make it appear as box */ + content: " "; + } + + @bottom-left { + background-color: transparent; + /* hack to make it appear as box */ + content: " "; + } + + @bottom-center { + /* Idiosyncratic note: The bottom center section is the + only one that you can expand out to the full width of the page. + Also: The left elements will render under it, the right elements + over it (the z order increases as you move right). + + Be careful trying to use a PNG background as the DPI is hard to configure + and your graphics will appear pixelated or not scale correctly + so rather use an SVG. + + The setup below will span your SVG across the page, make sure your + SVG document has exactly the same dimensions. Leave a pixel or two + white space to the very right of your SVG as the right edge is + difficult to page align. + */ + background-color: transparent; + /* Dont remove these two lines, they force the center element + to the width of the page and height of the footer image. */ + min-width: 210mm; + min-height: 22mm; + background-repeat: no-repeat; + background-position: 0% 0%; + background-size: contain; + size: 210mm 22mm; + background: $footer-url; + /* Note you cannot do concatenation in CSS content + except I figured out this little trick below TS */ + content: " " counter(page) " "; + } + + @bottom-right { + max-width: 0mm; + background-color: transparent; + /* hack to make it appear as box */ + content: " "; + } + + @bottom-right-corner { + /* has no effect on corner elements */ + max-width: 0mm; + background-color: transparent; + /* hack to make it appear as box */ + content: " "; + } +} + + + +/** Setting margins */ + +@page { + margin: 2cm; + padding-top: 10mm; +} + + +/* The first page of a print can be manipulated as well */ + +@page :first { + position: absolute; + top: 0px; + right: 0px; +} + +// +// Heading counters and styles +// + +h1 { + counter-increment: c1; + counter-reset: c2; + counter-reset: c3; + counter-reset: c4; +} + +h2 { + counter-increment: c2; + counter-reset: c3; + counter-reset: c4; +} + +h3 { + counter-increment: c3; + counter-reset: c4; +} + +h4 { + counter-increment: c4; +} + +h1:before, +h2:before, +h3:before, +h4:before { + width: 2cm; + display: inline-block; + text-align: right; + padding-right: 0.25cm; +} + +h1:before { + color: $primary-color; + content: counter(c1); +} + +h2:before { + color: $secondary-color; + content: counter(c1) "." counter(c2); +} + +h3:before { + color: $tertiary-color; + content: counter(c1) "." counter(c2) "." counter(c3); +} + +h4:before { + color: $primary-color; + content: counter(c1) "." counter(c2) "." counter(c3) "." counter(c4); +} + +article h1, +h2, +h3, +h4 { + width: 100%; + padding-right: 20pt; + text-align: right; + background: white; + color: black; + page-break-after: avoid; + page-break-inside: avoid; + display: inline-block; +} + + +article h1 { + border-bottom: 1px solid $primary-color; + color: $primary-color; + padding-top: 24px; + text-decoration-style: double; + margin-bottom: 32px; +} + +article h2 { + color: $secondary-color; + border-bottom: 2px solid $secondary-color; + padding-top: 12px; + margin-bottom: 12px; +} + +article h3 { + border-bottom: none; + color: $tertiary-color; + padding-top: 8px; + margin-bottom: 8px; +} + +article h4 { + border-bottom: none; + color: $primary-color; + padding-top: 8px; + margin-bottom: 8px; +} + +/* MKdocs renders code blocks inside a pre element and + inline code simply inside code elements + + Code block related items below are based on the article + at https://css-tricks.com/styling-code-in-and-out-of-blocks/ + + */ + +code { + font-family: monospace; + font-size: inherit; + color: $font-color; +} + + +/* Code in text */ + +p>code, +li>code, +dd>code, +td>code { + display: inline; + background: $inline-code-background; + white-space: pre-wrap; + //max-width: 100%; + //min-width: 100px; + word-wrap: break-word; + box-decoration-break: clone; + border-radius: .2rem; + font-size: $font-size; + color: #000 !important; +} + + +/* code in blocks */ + +pre code:before { + display: block; + width: 25%; + position: relative; + top: -33px; + left: -20px; + content: '🧑‍💻 Code:'; + padding: 1em 1em; + margin-left: 0; + margin-top: 1em; + margin-bottom: 1em; + border-left: 5px solid $codeblock-label-border; + background: $codeblock-label-background; + font-size: $font-size; + color: $codeblock-label-font-color; + font-weight: bolder; +} + +pre code { + display: block; + white-space: pre; + max-width: 100%; + min-width: 100px; + padding: 0; + font-size: $code-font-size; + font-family: $code-font-family; + /* margin: 1em 3em; + */ + padding: 1em 1em; + margin-left: 8px; + margin-top: 1em; + margin-bottom: 1em; + width: 100%; + border-left: 5px solid $codeblock-border; + background: $codeblock-background; + color: $font-color; +} + + +/* End of code blocks */ + +blockquote:before { + display: block; + width: 25%; + position: relative; + top: -33px; + left: -20px; + content: '🧑‍🔧 Note:'; + padding: 1em 1em; + margin-top: 10mm; + margin-left: 0; + margin-bottom: 1em; + border-left: 5px solid $blockquote-label-border; + background: $blockquote-label-background; + font-size: $font-size; + color: $blockquote-label-font-color; + font-weight: bolder !important; +} + +blockquote { + margin-left: 8px; + margin-top: 0mm; + margin-bottom: 0mm; + width: 100%; + border-left: 5px solid $blockquote-border; + background: $blockquote-background; + font-size: $font-size; + color: $font-color; +} + +blockquote p { + margin: 0; +} + +img { + page-break-inside: avoid; + page-break-after: avoid; +} + +table, +pre { + page-break-inside: avoid; +} + +ul, +ol, +dl { + page-break-before: avoid; +} + +table { + border-collapse: collapse; + margin: 25px 0; + font-size: 0.9em; + font-family: sans-serif; + min-width: 400px; + box-shadow: 0 0 20px rgba(0, 0, 0, 0.15); + margin-left: auto; + margin-right: auto; +} + + +/* Next section based on https://dev.to/dcodeyt/creating-beautiful-html-tables-with-css-428l */ + +table thead tr { + background-color: $primary-color; + color: #ffffff; + text-align: left; +} + +table th, +table td { + padding: 12px 15px; +} + +table tbody tr { + border-bottom: 1px solid $primary-color; +} + +table tbody tr:nth-of-type(even) { + background-color: #f3f3f3; +} + +table tbody tr:last-of-type { + border-bottom: 2px solid $primary-color; +} + +table tbody tr.active-row { + font-weight: bold; + color: #009879; +} + +/* End of section based on https://dev.to/dcodeyt/creating-beautiful-html-tables-with-css-428l */ + +ol, +ul { + padding-top: 1ch; + padding-bottom: 1ch; +} + +li { + padding-left: 1ch; +} + +ul.li::marker { + color: $primary-color; + font-weight: bold; + content: '⧈'; + margin-right: 10px; +} + + + +/* CSS Reset Rules from https://perishablepress.com/a-killer-collection-of-global-css-reset-styles/ */ + +* { + vertical-align: baseline; + font-family: inherit; + font-style: inherit; + font-size: 100%; + border: none; + padding: 0; + margin: 0; +} + +h1, +h2, +h3, +h4, +h5, +h6, +p, +pre, +blockquote, +form, +ul, +ol, +dl { + margin: 0px 0; +} + +article p { + color: $font-color; + padding-top: 5px; +} + +li, +dd, +blockquote { + margin-left: 40px; +} + + +/* End of resets ------------------------------- */ \ No newline at end of file diff --git a/docs/templates/variables.scss b/docs/templates/variables.scss new file mode 100644 index 0000000..475de18 --- /dev/null +++ b/docs/templates/variables.scss @@ -0,0 +1,33 @@ +/* Sass property declarations */ +$document-title: 'The Handbook'; +$document-title-color: #ffffff; +$show-top-left-corner-logo: false; +$primary-color: #0099FF; +$secondary-color: #FF0099; +$tertiary-color: #8a8b8b; +$primary-color-light: #cdedff; +$secondary-color-light: #f4ebdb; +$tertiary-color-light: #eaeaea; +$primary-color-dark: #0082c7; +$secondary-color-dark: #e79709; +$tertiary-color-dark: #3f3f3f; + +$font-size: 10pt; +$font-color: #000; + +$code-font-size: 8pt; +$code-font-family: 'Noto Sans Mono', monospace; + +$inline-code-background: #bfe9ff; + +$codeblock-label-font-color: white; +$codeblock-label-background: $primary-color; +$codeblock-label-border: $primary-color-dark; +$codeblock-background: $inline-code-background; +$codeblock-border: $primary-color; + +$blockquote-label-font-color: white; +$blockquote-label-background: $secondary-color; +$blockquote-label-border: $secondary-color-dark; +$blockquote-background: $secondary-color-light; +$blockquote-border: $secondary-color; \ No newline at end of file diff --git a/docs/uuid_redirects_hook.py b/docs/uuid_redirects_hook.py new file mode 100644 index 0000000..638549b --- /dev/null +++ b/docs/uuid_redirects_hook.py @@ -0,0 +1,30 @@ +import logging +import mkdocs.plugins + +log = logging.getLogger('mkdocs') + +@mkdocs.plugins.event_priority(-50) + +def on_page_content(html, page, config, files): + + # get redirect config + redirect_plugin = config.get('plugins', {}).get('redirects') + redirects = redirect_plugin.config.get('redirect_maps',{}) + + if "context_id" in page.meta: + context_id = page.meta.get("context_id") + key = f"{context_id}.md" + if key in redirects: + log_context_id_warning(page.meta.context_id, page.file.src_path, redirects[key]) + redirects[key] = page.file.src_path + + for item in page.toc.items: + # maybe implement check for UUID or something else + if item.id.isdigit(): + key = f"{item.id}.md" + if key in redirects: + log_context_id_warning(item.id, page.file.src_path, redirects[key]) + redirects[key] = f"{page.file.src_path}{item.url}" + +def log_context_id_warning(context_id, markdown1, markdown2): + log.warning(f"Context ID {context_id} used in {markdown1} and {markdown2}")