From a45cb1b01f66e723da74857a2add4a3881056d0c Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 26 Oct 2020 18:00:02 +0100 Subject: [PATCH 01/34] init deployment branch --- .editorconfig | 27 ++ .gitignore | 78 ++++ Dockerfile | 17 + LICENSE | 674 ++++++++++++++++++++++++++++++++ Makefile | 120 ++++++ README.creole | 176 +++++++++ caddy/Caddyfile | 20 + common.env | 10 + compose.sh | 12 + docker-compose.yml | 54 +++ inventory/entrypoint.sh | 48 +++ inventory/inventory_settings.py | 39 ++ inventory/kill_python.sh | 5 + inventory/manage.py | 14 + inventory/wsgi.py | 9 + postgres/init-user-db.sh | 5 + pyproject.toml | 16 + 17 files changed, 1324 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.creole create mode 100644 caddy/Caddyfile create mode 100644 common.env create mode 100755 compose.sh create mode 100644 docker-compose.yml create mode 100755 inventory/entrypoint.sh create mode 100644 inventory/inventory_settings.py create mode 100755 inventory/kill_python.sh create mode 100755 inventory/manage.py create mode 100644 inventory/wsgi.py create mode 100644 postgres/init-user-db.sh create mode 100644 pyproject.toml diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..99321a7 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,27 @@ +# see http://editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.{bat,cmd,ps1}] +end_of_line = crlf + +[*.{html,css,js}] +insert_final_newline = false + +[*.py] +line_length = 119 + +[{Makefile,**.mk}] +indent_style = tab +insert_final_newline = false + +[*.yml] +indent_style = tab +indent_size = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..81bdf36 --- /dev/null +++ b/.gitignore @@ -0,0 +1,78 @@ +.* +!.github +!.editorconfig +!.flake8 +!.gitignore +!.isort.cfg +!/.travis.yml +!/.style.yapf +!.coveralls.yml + +poetry.lock + +# for django-dbbackup +/backups/ +!/backups/.gitkeep + +# from test projects: +/static/ +/media/ +*.sqlite3 + +# docker-compose usage: +volumes + +# Django +secret.txt + +# Coverage HTML Report files: +htmlcov + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.tox +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +db.sqlite3 +coverage_html/ +coverage.xml +*,cover + +# Translations +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..28222a9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +FROM python:3.9-slim-buster +# https://hub.docker.com/_/python + +# Install deps +RUN apt-get update \ + && apt-mark auto $(apt-mark showinstall) \ + && apt-get install -y postgresql-client-11 python3-pip \ + && apt autoremove \ + && apt -y full-upgrade \ + && rm -rf /var/lib/apt \ + && python3 -m pip install -U pip + +WORKDIR /inventory + +RUN pip install psycopg2-binary pyinventory + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9ee2d97 --- /dev/null +++ b/Makefile @@ -0,0 +1,120 @@ +SHELL := /bin/bash + +help: ## List all commands + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9 -]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +check-poetry: + @if [[ "$(shell poetry --version 2>/dev/null)" == *"Poetry"* ]] ; \ + then \ + echo "Poetry found, ok." ; \ + else \ + echo 'Please install poetry first, with e.g.:' ; \ + echo 'make install-poetry' ; \ + exit 1 ; \ + fi + +install-poetry: ## install or update poetry + @if [[ "$(shell poetry --version 2>/dev/null)" == *"Poetry"* ]] ; \ + then \ + echo 'Update poetry' ; \ + poetry self update ; \ + else \ + echo 'Install poetry' ; \ + curl -sSL "https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py" | python3 ; \ + fi + +install: check-poetry ## install requirements to setup project + poetry install + +update: check-poetry ## update the sources and installation + git fetch --all + git pull origin deployment + poetry update + +check-compose: + @if [[ "$(shell poetry run docker-compose --version 2>/dev/null)" = *"docker-compose version"* ]] ; \ + then \ + echo "docker-compose found, ok." ; \ + else \ + echo 'Please install extras first, with e.g.:' ; \ + echo 'make install-compose' ; \ + exit 1 ; \ + fi + +up: check-compose ## Start containers via docker-compose + ./compose.sh up -d + ./compose.sh logs --tail=500 --follow + +down: ## Stop all containers + ./compose.sh down + +prune: ## Cleanup docker + docker system prune --force --all --filter until=4464h + +build: check-compose ## Update docker container build + ./compose.sh build --pull + +init_postgres: ## Create postgres database + ./compose.sh exec postgres ./docker/postgres_init.sh + +############################################################################## + +createsuperuser: ## Create super user + ./compose.sh exec inventory ./manage.sh createsuperuser + +############################################################################## + +shell_inventory: ## Go into bash shell in inventory container + ./compose.sh exec inventory /bin/bash + +shell_postgres: ## Go into bash shell in postgres container + ./compose.sh exec postgres /bin/bash + +shell_caddy: ## Go into bash shell in caddy container + ./compose.sh exec caddy /bin/ash + +############################################################################## + +caddy_environ: ## Prints the caddy environment + ./compose.sh exec caddy /usr/bin/caddy environ + +############################################################################## + +logs: ## Display docker logs from all containers + ./compose.sh logs --tail=500 --follow + +logs_postgres: ## Display docker logs from postgres container + ./compose.sh logs --tail=500 --follow postgres + +logs_inventory: ## Display docker logs from inventory container + ./compose.sh logs --tail=500 --follow inventory + +logs_caddy: ## Display docker logs from caddy container + ./compose.sh logs --tail=500 --follow caddy + +############################################################################## + +dbbackup: ## Backup database + ./compose.sh exec inventory ./manage.sh dbbackup + +dbrestore: ## Restore a database backup + ./compose.sh exec inventory ./manage.sh dbrestore + +############################################################################## + +restart: down up ## Restart all containers + +upgrade_inventory: ## Upgrade "inventory" container and restart it + $(MAKE) build + ./compose.sh stop inventory + $(MAKE) up + +reload_inventory: ## Reload server in "inventory" container + ./compose.sh exec inventory ./docker/kill_python.sh + ./compose.sh logs --tail=500 --follow inventory + +restart_caddy: ## Restart caddy container + ./compose.sh stop caddy + $(MAKE) up + +.PHONY: help \ No newline at end of file diff --git a/README.creole b/README.creole new file mode 100644 index 0000000..7c50aaf --- /dev/null +++ b/README.creole @@ -0,0 +1,176 @@ += PyInventory - deployment branch + +Web based management to catalog things including state and location etc. using Python/Django. + +*Note:* + +* This is the **deployment** branch that doesn't contain the project sourcecode! +* This branch is only for production use to setup a root server for PyInventory + +Pull requests welcome! + +== install + +=== prepare + +{{{ +~$ git clone https://github.com/jedie/PyInventory.git +~$ cd PyInventory +~/PyInventory$ git checkout deployment +~/PyInventory$ make +help List all commands +install-poetry install or update poetry +install install requirements to setup project +update update the sources and installation +up Start containers via docker-compose +down Stop all containers +prune Cleanup docker +build Update docker container build +createsuperuser Create super user +logs Display docker logs from all containers +dbbackup Backup database +dbrestore Restore a database backup +restart Restart all containers +}}} + + +{{{ +# install or update poetry: +~/PyInventory$ make install-poetry + +# install requirements via poetry: +~/PyInventory$ make install +... + +# Collectstatic + makemigration + migrate: +~/PyInventory$ make manage-update + +# Create a django super user: +~/PyInventory$ ./manage.sh createsuperuser + +# start local dev. web server: +~/PyInventory$ make run-dev-server +}}} + +The web page is available via: {{{http://127.0.0.1:8000/}}} + + +=== docker-compose usage + +Install docker, e.g.: https://docs.docker.com/engine/install/ubuntu/ + +{{{ +# Install "docker-compose" via poetry extras: +~/PyInventory$ make install-compose +}}} + +Create a {{{.env}}} file with these content, e.g.: +{{{ +# Public domain or "localhost" for local testing: +HOSTNAME=localhost + +# eMail address for Let's encrypt (Use "internal" for self signed https certificates): +LETSENCRYPT_EMAIL=internal +}}} +e.g. in production: +{{{ +HOSTNAME=domain.tld +LETSENCRYPT_EMAIL=webmaster@domain.tld +}}} + +Start containers via docker-compose: +{{{ +~/PyInventory$ make up +}}} + +Notes: At the first start it takes a little while until the database is created + +Create first super user: +{{{ +~/PyInventory$ make docker_createsuperuser +}}} + + +== Screenshots + +{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.2.0 screenshot 1.png|PyInventory v0.2.0 screenshot 1.png}} + +---- + +{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.1.0 screenshot 2.png|PyInventory v0.1.0 screenshot 2.png}} + +---- + +{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.1.0 screenshot 3.png|PyInventory v0.1.0 screenshot 3.png}} + +---- + + +== Multi user usage + +PyInventory supports multiple users. The idea: + +* Every normal user sees only his own created database entries +* All users used the Django admin + +Note: All created Tags are shared for all existing users! + + +So setup a normal user: + +* Set "Staff status" +* Unset "Superuser status" +* Add user to "normal_user" group +* Don't add any additional permissions + +e.g.: + +{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory normal user example.png|normal user example}} + + +== Backwards-incompatible changes + +Nothing, yet ;) + + +== history + +* [[https://github.com/jedie/PyInventory/compare/v0.2.0...master|compare v0.2.0...master]] **dev** +** tbc +* [[https://github.com/jedie/PyInventory/compare/v0.2.0...v0.3.0|v0.3.0 - 26.10.2020]] +** setup production usage: +*** Use [[https://caddyserver.com/|caddy server]] as reverse proxy +*** Use uWSGI as application server +*** autogenerate {{{secret.txt}}} file for {{{settings.SECRET_KEY}}} +*** Fix settings +** split settings for local development and production use +** Bugfix init: move "setup user group" from checks into "post migrate" signal handler +** Bugfix for using manage commands {{{dumpdata}}} and {{{loaddata}}} +* [[https://github.com/jedie/PyInventory/compare/v0.1.0...v0.2.0|v0.2.0 - 24.10.2020]] +** Simplify item change list by nested item +** Activate Django-Import/Export +** Implement multi user usage +** Add Django-dbbackup +** Add docker-compose usage +* [[https://github.com/jedie/PyInventory/compare/v0.0.1...v0.1.0|v0.1.0 - 17.10.2020]] +** Enhance models, admin and finish project setup +* v0.0.1 - 14.10.2020 +** Just create a pre-alpha release to save the PyPi package name ;) + + +== links == + +| Homepage | http://github.com/jedie/PyInventory +| PyPi | https://pypi.org/project/PyInventory/ + +Discuss here: + +* [[https://www.vogons.org/viewtopic.php?f=5&t=77285|vogons.org Forum Thread (en)]] +* [[https://forum.classic-computing.de/forum/index.php?thread/21738-opensource-projekt-pyinventory-web-basierte-verwaltung-um-seine-dinge-zu-katalog/|VzEkC e. V. Forum Thread (de)]] +* [[https://dosreloaded.de/forum/index.php?thread/3702-pyinventory-retro-sammlung-katalogisieren/|dosreloaded.de Forum Thread (de)]] + +== donation == + +* [[https://www.paypal.me/JensDiemer|paypal.me/JensDiemer]] +* [[https://flattr.com/submit/auto?uid=jedie&url=https%3A%2F%2Fgithub.com%2Fjedie%2FPyInventory%2F|Flattr This!]] +* Send [[http://www.bitcoin.org/|Bitcoins]] to [[https://blockexplorer.com/address/1823RZ5Md1Q2X5aSXRC5LRPcYdveCiVX6F|1823RZ5Md1Q2X5aSXRC5LRPcYdveCiVX6F]] diff --git a/caddy/Caddyfile b/caddy/Caddyfile new file mode 100644 index 0000000..152ffe4 --- /dev/null +++ b/caddy/Caddyfile @@ -0,0 +1,20 @@ +# https://caddyserver.com/docs/caddyfile +{ + admin off +} + +{$HOSTNAME} { + tls {$LETSENCRYPT_EMAIL} + + header { + X-Robots-Tag "none" + } + + respond /robots.txt 200 { + body "User-agent: * +Disallow: /" + close + } + + reverse_proxy inventory:8000 +} diff --git a/common.env b/common.env new file mode 100644 index 0000000..8e324cb --- /dev/null +++ b/common.env @@ -0,0 +1,10 @@ +DB_NAME=pyinventory +DB_USER=postgres +DB_PASS=postgres +DB_HOST=postgres +DB_PORT=5432 + +PYTHONUNBUFFERED=1 + +# e.g.: pip cache: +XDG_CACHE_HOME="/var/cache" diff --git a/compose.sh b/compose.sh new file mode 100755 index 0000000..72e9c9d --- /dev/null +++ b/compose.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +set -e + +if [[ -f .env ]]; then + echo "Read '.env' file..." + source .env +fi + +set -x + +exec poetry run docker-compose "$@" diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..c508f89 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,54 @@ +version: "3.7" + +services: + caddy: # https://hub.docker.com/_/caddy + image: caddy:2-alpine + restart: unless-stopped + ports: + - "80:80" + - "443:443" + volumes: + - ./caddy/Caddyfile:/etc/caddy/Caddyfile + - ./volumes/static/:/static/:ro + environment: + - HOSTNAME=${HOSTNAME:-localhost} + - LETSENCRYPT_EMAIL=${LETSENCRYPT_EMAIL:-internal} + + inventory: + build: + context: . + dockerfile: Dockerfile + restart: unless-stopped + hostname: inventory + ports: + - "8000" + env_file: ./common.env + environment: + - DJANGO_SETTINGS_MODULE=inventory_settings + - HOSTNAME=${HOSTNAME:-localhost} + links: + - postgres:postgres + depends_on: + - postgres + - caddy + volumes: + - ./inventory/:/inventory/ + - ./volumes/static/:/static/:rw + - ./volumes/media/:/media/:rw + # e.g.: pip cache must be the same value as $XDG_CACHE_HOME ! + - ./volumes/cache/:/var/cache/:rw + entrypoint: /inventory/entrypoint.sh + + postgres: + # https://hub.docker.com/_/postgres + image: postgres:11-alpine + restart: unless-stopped + hostname: postgres + ports: + - "5432" + env_file: ./common.env + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + volumes: + - ./postgres/init-user-db.sh:/docker-entrypoint-initdb.d/init-user-db.sh:ro + - ./volumes/postgresql/data/:/var/lib/postgresql/data/:rw diff --git a/inventory/entrypoint.sh b/inventory/entrypoint.sh new file mode 100755 index 0000000..c741b6e --- /dev/null +++ b/inventory/entrypoint.sh @@ -0,0 +1,48 @@ +#!/bin/sh + +set -e + +restart_error_handler() { + ( + echo "Restart ${0} in 3 sec..." + sleep 1 + echo "Restart ${0} in 2 sec..." + sleep 1 + echo "Restart ${0} in 1 sec..." + sleep 1 + ) + exec ${0} +} +trap restart_error_handler 0 + +echo "_______________________________________________________________________" +echo "$(date +%c) - ${0}" + +( + set -x + + pip3 install -U pyinventory + + ./manage.py collectstatic --noinput + ./manage.py makemigrations + ./manage.py migrate + + uwsgi \ + --http inventory:8000 \ + --chdir /inventory/ \ + --wsgi-file /inventory/wsgi.py \ + --static-map /static/=/static/ \ + --master \ + --processes 2 \ + --threads 2 \ + --ignore-sigpipe \ + --ignore-write-errors \ + --disable-write-exception \ + --http-auto-chunked \ + --http-keepalive + echo "uwsgi terminated with exit code: $?" + sleep 3 + exit 1 +) + +exit 2 diff --git a/inventory/inventory_settings.py b/inventory/inventory_settings.py new file mode 100644 index 0000000..b1bb285 --- /dev/null +++ b/inventory/inventory_settings.py @@ -0,0 +1,39 @@ +""" + Django settings for docker usage +""" +import os as __os + +from inventory_project.settings.base import * # noqa + + +HOSTNAME = __os.environ['HOSTNAME'] + +if HOSTNAME != 'localhost': + print(f'Production mode on domain: {HOSTNAME!r}') + DEBUG = False + INTERNAL_IPS = () +else: + print('Local development mode') + DEBUG = True + INTERNAL_IPS = ('127.0.0.1', '0.0.0.0', 'localhost') + + +ALLOWED_HOSTS = (HOSTNAME,) + + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': __os.environ['DB_NAME'], + 'USER': __os.environ['DB_USER'], + 'PASSWORD': __os.environ['DB_PASS'], + 'HOST': __os.environ['DB_HOST'], + 'PORT': __os.environ['DB_PORT'], + 'DEBUG_NAME': 'default', + 'CONN_MAX_AGE': 600, + }, +} + +# docker volumes: +STATIC_ROOT = '/static/' +MEDIA_ROOT = '/media/' diff --git a/inventory/kill_python.sh b/inventory/kill_python.sh new file mode 100755 index 0000000..b67e706 --- /dev/null +++ b/inventory/kill_python.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +set -ex + +for pid in $(pidof python3); do kill $pid; done diff --git a/inventory/manage.py b/inventory/manage.py new file mode 100755 index 0000000..bb39550 --- /dev/null +++ b/inventory/manage.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python3 + +import os +import sys + + +def main(): + assert 'DJANGO_SETTINGS_MODULE' in os.environ, 'No "DJANGO_SETTINGS_MODULE" in environment!' + from django.core.management import execute_from_command_line + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/inventory/wsgi.py b/inventory/wsgi.py new file mode 100644 index 0000000..d9598cf --- /dev/null +++ b/inventory/wsgi.py @@ -0,0 +1,9 @@ +""" + WSGI config +""" + + +from django.core.wsgi import get_wsgi_application + + +application = get_wsgi_application() diff --git a/postgres/init-user-db.sh b/postgres/init-user-db.sh new file mode 100644 index 0000000..5e2bf63 --- /dev/null +++ b/postgres/init-user-db.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +set -ex + +psql -U postgres -c "CREATE DATABASE $DB_NAME OWNER $DB_USER" diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..e5d354b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,16 @@ +[tool.poetry] +name = "pyinventory-deployment" +version = "0.1.0" +description = "production deployment for PyInventory project with docker-compose usage" +authors = ["JensDiemer "] +license = "GPL" + +[tool.poetry.dependencies] +python = ">=3.7,<4.0.0" +docker-compose = "*" + +[tool.poetry.dev-dependencies] + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api" From 72d01f61b390e77229381f910d2a2f99da7862a7 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 08:45:07 +0100 Subject: [PATCH 02/34] update README --- README.creole | 160 +++++++++++++++----------------------------------- 1 file changed, 46 insertions(+), 114 deletions(-) diff --git a/README.creole b/README.creole index 7c50aaf..f414403 100644 --- a/README.creole +++ b/README.creole @@ -9,15 +9,35 @@ Web based management to catalog things including state and location etc. using P Pull requests welcome! +== git branches + +Currently we have two main branches: + +|= git branch |= description +| **[[https://github.com/jedie/PyInventory/tree/master|master]]** | The main PyInventory source code +| **[[https://github.com/jedie/PyInventory/tree/deployment|deployment]]** | separate project to deploy PyInventory for production use case + == install -=== prepare +There exists two kind of installation/usage: + +* local development installation using poetry +* production use with docker-compose + +This README (in git **deployment** branch) contains only the instruction to install PyInventory on a root server. + +Read [[https://github.com/jedie/PyInventory/tree/master#readme|master README]] for local develompment installation. + + +=== deploy {{{ -~$ git clone https://github.com/jedie/PyInventory.git -~$ cd PyInventory -~/PyInventory$ git checkout deployment -~/PyInventory$ make +# Checkout the deployment branch: +~$ git clone -b deployment https://github.com/jedie/PyInventory.git PyInventory-Deployment +~$ cd PyInventory-Deployment + +# Theses Makefile targets exists: +~/PyInventory-Deployment$ make help List all commands install-poetry install or update poetry install install requirements to setup project @@ -34,140 +54,52 @@ restart Restart all containers }}} -{{{ -# install or update poetry: -~/PyInventory$ make install-poetry - -# install requirements via poetry: -~/PyInventory$ make install -... - -# Collectstatic + makemigration + migrate: -~/PyInventory$ make manage-update - -# Create a django super user: -~/PyInventory$ ./manage.sh createsuperuser - -# start local dev. web server: -~/PyInventory$ make run-dev-server -}}} - -The web page is available via: {{{http://127.0.0.1:8000/}}} - - -=== docker-compose usage - Install docker, e.g.: https://docs.docker.com/engine/install/ubuntu/ {{{ -# Install "docker-compose" via poetry extras: -~/PyInventory$ make install-compose +# install or update poetry: +~/PyInventory-Deployment$ make install-poetry + +# install requirements (e.g.: docker-compose) via poetry: +~/PyInventory-Deployment$ make install }}} -Create a {{{.env}}} file with these content, e.g.: -{{{ -# Public domain or "localhost" for local testing: -HOSTNAME=localhost - -# eMail address for Let's encrypt (Use "internal" for self signed https certificates): -LETSENCRYPT_EMAIL=internal -}}} -e.g. in production: +Create a {{{.env}}} file in project root directory with these content, e.g.: {{{ +~/PyInventory-Deployment$ touch .env +~/PyInventory-Deployment$ mcedit .env +~/PyInventory-Deployment$ cat .env +# Your Public domain: HOSTNAME=domain.tld + +# eMail address for Let's encrypt: LETSENCRYPT_EMAIL=webmaster@domain.tld }}} +For local testing of the docker-compose setup, used this values: +{{{ +HOSTNAME=localhost +LETSENCRYPT_EMAIL=internal +}}} +(Caddy will create a self signed https certificate) + Start containers via docker-compose: {{{ -~/PyInventory$ make up +~/PyInventory-Deployment$ make up }}} Notes: At the first start it takes a little while until the database is created Create first super user: {{{ -~/PyInventory$ make docker_createsuperuser +~/PyInventory-Deployment$ make docker_createsuperuser }}} -== Screenshots - -{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.2.0 screenshot 1.png|PyInventory v0.2.0 screenshot 1.png}} - ----- - -{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.1.0 screenshot 2.png|PyInventory v0.1.0 screenshot 2.png}} - ----- - -{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory v0.1.0 screenshot 3.png|PyInventory v0.1.0 screenshot 3.png}} - ----- - - -== Multi user usage - -PyInventory supports multiple users. The idea: - -* Every normal user sees only his own created database entries -* All users used the Django admin - -Note: All created Tags are shared for all existing users! - - -So setup a normal user: - -* Set "Staff status" -* Unset "Superuser status" -* Add user to "normal_user" group -* Don't add any additional permissions - -e.g.: - -{{https://raw.githubusercontent.com/jedie/jedie.github.io/master/screenshots/PyInventory/PyInventory normal user example.png|normal user example}} - - -== Backwards-incompatible changes - -Nothing, yet ;) - - -== history - -* [[https://github.com/jedie/PyInventory/compare/v0.2.0...master|compare v0.2.0...master]] **dev** -** tbc -* [[https://github.com/jedie/PyInventory/compare/v0.2.0...v0.3.0|v0.3.0 - 26.10.2020]] -** setup production usage: -*** Use [[https://caddyserver.com/|caddy server]] as reverse proxy -*** Use uWSGI as application server -*** autogenerate {{{secret.txt}}} file for {{{settings.SECRET_KEY}}} -*** Fix settings -** split settings for local development and production use -** Bugfix init: move "setup user group" from checks into "post migrate" signal handler -** Bugfix for using manage commands {{{dumpdata}}} and {{{loaddata}}} -* [[https://github.com/jedie/PyInventory/compare/v0.1.0...v0.2.0|v0.2.0 - 24.10.2020]] -** Simplify item change list by nested item -** Activate Django-Import/Export -** Implement multi user usage -** Add Django-dbbackup -** Add docker-compose usage -* [[https://github.com/jedie/PyInventory/compare/v0.0.1...v0.1.0|v0.1.0 - 17.10.2020]] -** Enhance models, admin and finish project setup -* v0.0.1 - 14.10.2020 -** Just create a pre-alpha release to save the PyPi package name ;) - - == links == | Homepage | http://github.com/jedie/PyInventory -| PyPi | https://pypi.org/project/PyInventory/ -Discuss here: - -* [[https://www.vogons.org/viewtopic.php?f=5&t=77285|vogons.org Forum Thread (en)]] -* [[https://forum.classic-computing.de/forum/index.php?thread/21738-opensource-projekt-pyinventory-web-basierte-verwaltung-um-seine-dinge-zu-katalog/|VzEkC e. V. Forum Thread (de)]] -* [[https://dosreloaded.de/forum/index.php?thread/3702-pyinventory-retro-sammlung-katalogisieren/|dosreloaded.de Forum Thread (de)]] == donation == From a0840f05a17382d6a08477b038b050079c3905a6 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Tue, 27 Oct 2020 08:49:19 +0100 Subject: [PATCH 03/34] Update README.creole --- README.creole | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.creole b/README.creole index f414403..178450c 100644 --- a/README.creole +++ b/README.creole @@ -2,13 +2,14 @@ Web based management to catalog things including state and location etc. using Python/Django. -*Note:* +**Note:** -* This is the **deployment** branch that doesn't contain the project sourcecode! -* This branch is only for production use to setup a root server for PyInventory +* This README (in git **deployment** branch) contains only the instruction to install PyInventory on a root server. +* Read [[https://github.com/jedie/PyInventory/tree/master#readme|master README]] for local develompment installation. Pull requests welcome! + == git branches Currently we have two main branches: @@ -17,19 +18,10 @@ Currently we have two main branches: | **[[https://github.com/jedie/PyInventory/tree/master|master]]** | The main PyInventory source code | **[[https://github.com/jedie/PyInventory/tree/deployment|deployment]]** | separate project to deploy PyInventory for production use case -== install -There exists two kind of installation/usage: +== deploy -* local development installation using poetry -* production use with docker-compose - -This README (in git **deployment** branch) contains only the instruction to install PyInventory on a root server. - -Read [[https://github.com/jedie/PyInventory/tree/master#readme|master README]] for local develompment installation. - - -=== deploy +Install PyInventory on a root server: {{{ # Checkout the deployment branch: From edf7ea2919262069690daade6e83e8a7518a45ae Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 09:15:19 +0100 Subject: [PATCH 04/34] update docker containers on "make update", too --- Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 9ee2d97..5ee9f69 100644 --- a/Makefile +++ b/Makefile @@ -26,10 +26,12 @@ install-poetry: ## install or update poetry install: check-poetry ## install requirements to setup project poetry install -update: check-poetry ## update the sources and installation +update: check-poetry ## update the sources and docker containers git fetch --all git pull origin deployment poetry update + ./compose.sh build --pull + $(MAKE) restart check-compose: @if [[ "$(shell poetry run docker-compose --version 2>/dev/null)" = *"docker-compose version"* ]] ; \ From 1fd6b46996bd73b408d0ebb595e995604342b15c Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 09:15:43 +0100 Subject: [PATCH 05/34] add root server helper shell scripts --- scripts/apt-distupgrade.sh | 14 ++++++++++++++ scripts/setup_user.sh | 21 +++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100755 scripts/apt-distupgrade.sh create mode 100644 scripts/setup_user.sh diff --git a/scripts/apt-distupgrade.sh b/scripts/apt-distupgrade.sh new file mode 100755 index 0000000..7558646 --- /dev/null +++ b/scripts/apt-distupgrade.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +( + set -x + sudo apt update + { echo "---------------------------------------------------"; } 2>/dev/null + sudo apt -y full-upgrade + { echo "---------------------------------------------------"; } 2>/dev/null + sudo apt -y autoremove + { echo "---------------------------------------------------"; } 2>/dev/null + # Delete old entries: + sudo journalctl --vacuum-size=1G + sudo journalctl --vacuum-time=1years +) diff --git a/scripts/setup_user.sh b/scripts/setup_user.sh new file mode 100644 index 0000000..d95c466 --- /dev/null +++ b/scripts/setup_user.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +if [ "$(whoami)" != "root" ]; then + echo "Please start with 'sudo' !" + ( + set -x + id + exit 1 + ) +fi + + +set -ex + +export USERNAME=${1} + +adduser --disabled-password --gecos "" --home=/home/${USERNAME} ${USERNAME} +mkdir -p /home/${USERNAME}/.ssh +cp /root/.ssh/authorized_keys /home/${USERNAME}/.ssh/ +chown -Rfc ${USERNAME}.${USERNAME} /home/${USERNAME}/ +echo "${USERNAME} ALL=(ALL) NOPASSWD:ALL">/etc/sudoers.d/${USERNAME} \ No newline at end of file From 350c0bb474859f6527c68fa7ff9ce4fcdcc9d737 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 09:15:50 +0100 Subject: [PATCH 06/34] update README --- README.creole | 99 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 95 insertions(+), 4 deletions(-) diff --git a/README.creole b/README.creole index 178450c..aa6786f 100644 --- a/README.creole +++ b/README.creole @@ -23,6 +23,64 @@ Currently we have two main branches: Install PyInventory on a root server: + +=== prepate root server + +Here some steps for a fresh created root server: + +Update all packages, e.g.: +{{{ +apt update && apt -y full-upgrade +}}} + +Setup a normal user. You may use [[https://github.com/jedie/PyInventory/blob/deployment/scripts/setup_user.sh|scripts/setup_user.sh]] + + +=== Setup SSH services + +{{{ +~# nano /etc/ssh/sshd_config +}}} + +Change e.g.: +{{{ +Port xxxx +PermitRootLogin no +PasswordAuthentication no +}}} +(Changing the Port may need to change a firewall/network settings) + +{{{ +# restart SSH deamon: +~# service ssh restart + +# Display and follow the ssh log output to see connection errors: +~# journalctl -f -u ssh +}}} + +* Keep the current SSH session (with the log output) open! +* Update your {{{~/.ssh/config}}} +* Try to connect as the new, normal user in a **separate** terminal + +Only after a working new connection: Terminate the first root SSH session ;) + + +=== setup unattended-upgrades + +{{{ +~$ sudo apt install unattended-upgrades +~$ sudo dpkg-reconfigure unattended-upgrades +~$ sudo nano /etc/apt/apt.conf.d/50unattended-upgrades +}}} + + +=== install docker + +see: https://docs.docker.com/engine/install/ubuntu/ + + +=== install PyInventory + {{{ # Checkout the deployment branch: ~$ git clone -b deployment https://github.com/jedie/PyInventory.git PyInventory-Deployment @@ -45,8 +103,7 @@ dbrestore Restore a database backup restart Restart all containers }}} - -Install docker, e.g.: https://docs.docker.com/engine/install/ubuntu/ +Install, e.g.: {{{ # install or update poetry: @@ -59,7 +116,7 @@ Install docker, e.g.: https://docs.docker.com/engine/install/ubuntu/ Create a {{{.env}}} file in project root directory with these content, e.g.: {{{ ~/PyInventory-Deployment$ touch .env -~/PyInventory-Deployment$ mcedit .env +~/PyInventory-Deployment$ nano .env ~/PyInventory-Deployment$ cat .env # Your Public domain: HOSTNAME=domain.tld @@ -80,18 +137,52 @@ Start containers via docker-compose: ~/PyInventory-Deployment$ make up }}} -Notes: At the first start it takes a little while until the database is created +Notes: At the first start it takes a little while until the database is created ;) Create first super user: {{{ ~/PyInventory-Deployment$ make docker_createsuperuser }}} +* Now you should be able to connect to your PyInventory installation and login with created super user. +* Redirect from **http** to **https** should work. +* Let's Encrypt certificate should be installed and valid. +* Containers should be restarted after a server reboot + + +=== Maintenance + +TO keep everything up-to-date do the following steps: + +Update the OS call: +{{{ +~/PyInventory-Deployment$ sudo ./scripts/apt-distupgrade.sh +}}} + +Update PyInventory installation and docker containers: +{{{ +~/PyInventory-Deployment$ make update +}}} + +This will do: + +* update the source code +* update docker-compose and all requirements +* Pull and rebuild all docker containers +* restart all docker containers + + == links == | Homepage | http://github.com/jedie/PyInventory +Web server stuff: + +* https://help.ubuntu.com/community/Security +* https://help.ubuntu.com/lts/serverguide/automatic-updates.html +* https://help.ubuntu.com/community/AutomaticSecurityUpdate + == donation == From 326118fa1c7e2a59df7600394a6e2069ade12a45 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 09:17:49 +0100 Subject: [PATCH 07/34] chmod +x --- scripts/setup_user.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 scripts/setup_user.sh diff --git a/scripts/setup_user.sh b/scripts/setup_user.sh old mode 100644 new mode 100755 From 8c851697b08acc0baacada978cbb47d9b5e5ce50 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:04:30 +0100 Subject: [PATCH 08/34] add .dockerignore --- .dockerignore | 1 + .gitignore | 1 + 2 files changed, 2 insertions(+) create mode 100644 .dockerignore diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..72e8ffc --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +* diff --git a/.gitignore b/.gitignore index 81bdf36..a212a9b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .* !.github +!.dockerignore !.editorconfig !.flake8 !.gitignore From e65b76b5fe33697877939e85781bcac68e58f198 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:04:49 +0100 Subject: [PATCH 09/34] update README --- README.creole | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.creole b/README.creole index aa6786f..268159d 100644 --- a/README.creole +++ b/README.creole @@ -74,9 +74,15 @@ Only after a working new connection: Terminate the first root SSH session ;) }}} -=== install docker +=== install requirements + +Install docker, see: https://docs.docker.com/engine/install/ubuntu/ + +install some base packages, e.g.: +{{{ +~$ sudo apt install git make +}}} -see: https://docs.docker.com/engine/install/ubuntu/ === install PyInventory @@ -108,7 +114,11 @@ Install, e.g.: {{{ # install or update poetry: ~/PyInventory-Deployment$ make install-poetry +}}} +To keep poetry running (PATH must be expand) just logout and login ;) + +{{{ # install requirements (e.g.: docker-compose) via poetry: ~/PyInventory-Deployment$ make install }}} From c337eece72c265950fea926d8622be1a7e4a2d57 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:05:57 +0100 Subject: [PATCH 10/34] cleanup (call "docker system prune") after start --- Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/Makefile b/Makefile index 5ee9f69..3278be3 100644 --- a/Makefile +++ b/Makefile @@ -45,6 +45,7 @@ check-compose: up: check-compose ## Start containers via docker-compose ./compose.sh up -d + $(MAKE) prune ./compose.sh logs --tail=500 --follow down: ## Stop all containers From 404617311a618e0baf48d2cd52929e79a4d95f43 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:43:33 +0100 Subject: [PATCH 11/34] Add some notes --- README.creole | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.creole b/README.creole index 268159d..106f171 100644 --- a/README.creole +++ b/README.creole @@ -23,8 +23,15 @@ Currently we have two main branches: Install PyInventory on a root server: +**Note:** -=== prepate root server +* Running a public web server is a lot of work and brings some risks. +* This instructions are only the basics to get PyInventory working. +* To run the server safely, more work should be done, which is not explained here. +* Run at your own risk! No warranty is given. + + +=== prepare root server Here some steps for a fresh created root server: From 65fc07bb93d16fe89712ddc70b347216dbb1088d Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:46:04 +0100 Subject: [PATCH 12/34] Add scripts/apt-cleanup.sh --- README.creole | 1 + scripts/apt-cleanup.sh | 69 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100755 scripts/apt-cleanup.sh diff --git a/README.creole b/README.creole index 106f171..c662671 100644 --- a/README.creole +++ b/README.creole @@ -188,6 +188,7 @@ This will do: * Pull and rebuild all docker containers * restart all docker containers +Take a look at [[https://github.com/jedie/PyInventory/blob/deployment/scripts/apt-cleanup.sh|scripts/apt-cleanup.sh]] to keep your system clean. == links == diff --git a/scripts/apt-cleanup.sh b/scripts/apt-cleanup.sh new file mode 100755 index 0000000..f45eefc --- /dev/null +++ b/scripts/apt-cleanup.sh @@ -0,0 +1,69 @@ +#!/bin/bash + +# Cleanup installed packages by using apt-mark: +# +# 1. mark all packages as "auto" +# 2. install really needed packages "manual" +# 3. call "autoremove" to deinstall all not needed packages +# +# WARNING: You may need some more packages depend on your cloud provider! + + + +############################################################### +# Remove this lines: +echo "Adjust this script first, before you use it!" +exit 1 +############################################################### + + + +set -e + +if [ "$(whoami)" != "root" ]; then + echo "Please start with 'sudo' !" + exit 1 +fi + +clear + +# These packages should be installed: +PACKAGES=( + linux-image-virtual ubuntu-minimal + qemu-guest-agent + command-not-found + update-manager-core + unattended-upgrades + openssh-server + rsync + lshw htop mc nano + git make + apt-transport-https curl gnupg-agent software-properties-common + docker-ce docker-ce-cli containerd.io +) + +( + set -ex + + apt update + + { echo "---------------------------------------------------"; } 2>/dev/null + + # Mark all installed packages as "auto": + apt-mark auto $(apt-mark showinstall) + + { echo "---------------------------------------------------"; } 2>/dev/null + + # Install the really needed packages: + apt -y install "${PACKAGES[@]}" + + { echo "---------------------------------------------------"; } 2>/dev/null + + # Update all installed packages: + apt -y full-upgrade + + { echo "---------------------------------------------------"; } 2>/dev/null + + # Deinstall all not needed packages: + apt autoremove +) From c7beb9e9d6a906f084c26a7517a751e9e1503329 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 27 Oct 2020 10:54:14 +0100 Subject: [PATCH 13/34] +acpid --- scripts/apt-cleanup.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/apt-cleanup.sh b/scripts/apt-cleanup.sh index f45eefc..b1ff142 100755 --- a/scripts/apt-cleanup.sh +++ b/scripts/apt-cleanup.sh @@ -29,7 +29,7 @@ clear # These packages should be installed: PACKAGES=( - linux-image-virtual ubuntu-minimal + linux-image-virtual ubuntu-minimal acpid qemu-guest-agent command-not-found update-manager-core From ce0e9a399178aa4ad2a7a989a5ca9e4f7ec287e7 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 11 Nov 2020 17:58:44 +0100 Subject: [PATCH 14/34] Bugfix Makefile help target --- Makefile | 8 ++++---- README.creole | 13 ++++++++++++- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 3278be3..9b417f4 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ SHELL := /bin/bash help: ## List all commands - @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9 -]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9 -_]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) check-poetry: @if [[ "$(shell poetry --version 2>/dev/null)" == *"Poetry"* ]] ; \ @@ -107,16 +107,16 @@ dbrestore: ## Restore a database backup restart: down up ## Restart all containers -upgrade_inventory: ## Upgrade "inventory" container and restart it +upgrade_inventory: ## Upgrade "inventory" container and restart it $(MAKE) build ./compose.sh stop inventory $(MAKE) up -reload_inventory: ## Reload server in "inventory" container +reload_inventory: ## Reload server in "inventory" container ./compose.sh exec inventory ./docker/kill_python.sh ./compose.sh logs --tail=500 --follow inventory -restart_caddy: ## Restart caddy container +restart_caddy: ## Restart caddy container ./compose.sh stop caddy $(MAKE) up diff --git a/README.creole b/README.creole index c662671..9b2103b 100644 --- a/README.creole +++ b/README.creole @@ -104,16 +104,27 @@ install some base packages, e.g.: help List all commands install-poetry install or update poetry install install requirements to setup project -update update the sources and installation +update update the sources and docker containers up Start containers via docker-compose down Stop all containers prune Cleanup docker build Update docker container build +init_postgres Create postgres database createsuperuser Create super user +shell_inventory Go into bash shell in inventory container +shell_postgres Go into bash shell in postgres container +shell_caddy Go into bash shell in caddy container +caddy_environ Prints the caddy environment logs Display docker logs from all containers +logs_postgres Display docker logs from postgres container +logs_inventory Display docker logs from inventory container +logs_caddy Display docker logs from caddy container dbbackup Backup database dbrestore Restore a database backup restart Restart all containers +upgrade_inventory Upgrade "inventory" container and restart it +reload_inventory Reload server in "inventory" container +restart_caddy Restart caddy container }}} Install, e.g.: From f048657a0d5a0999d0d3969dd17def7e2ab27bd6 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 11 Nov 2020 18:31:15 +0100 Subject: [PATCH 15/34] add "make reload_caddy" --- Makefile | 16 ++++++++++++---- README.creole | 3 ++- caddy/Caddyfile | 3 --- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 9b417f4..aa1845d 100644 --- a/Makefile +++ b/Makefile @@ -112,12 +112,20 @@ upgrade_inventory: ## Upgrade "inventory" container and restart it ./compose.sh stop inventory $(MAKE) up -reload_inventory: ## Reload server in "inventory" container - ./compose.sh exec inventory ./docker/kill_python.sh - ./compose.sh logs --tail=500 --follow inventory - restart_caddy: ## Restart caddy container ./compose.sh stop caddy $(MAKE) up +############################################################################## + +reload_caddy: ## Reload Caddy server + ./compose.sh exec caddy caddy reload --config /etc/caddy/Caddyfile --adapter caddyfile + $(MAKE) logs_caddy + +reload_inventory: ## Reload server in "inventory" container + ./compose.sh exec inventory ./docker/kill_python.sh + ./compose.sh logs --tail=500 --follow inventory + +############################################################################## + .PHONY: help \ No newline at end of file diff --git a/README.creole b/README.creole index 9b2103b..34c3204 100644 --- a/README.creole +++ b/README.creole @@ -123,8 +123,9 @@ dbbackup Backup database dbrestore Restore a database backup restart Restart all containers upgrade_inventory Upgrade "inventory" container and restart it -reload_inventory Reload server in "inventory" container restart_caddy Restart caddy container +reload_caddy Reload Caddy server +reload_inventory Reload server in "inventory" container }}} Install, e.g.: diff --git a/caddy/Caddyfile b/caddy/Caddyfile index 152ffe4..7ebaa37 100644 --- a/caddy/Caddyfile +++ b/caddy/Caddyfile @@ -1,7 +1,4 @@ # https://caddyserver.com/docs/caddyfile -{ - admin off -} {$HOSTNAME} { tls {$LETSENCRYPT_EMAIL} From ae0602fc4a0d15920e779778e4b8a21974b3aaee Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 11 Nov 2020 18:33:41 +0100 Subject: [PATCH 16/34] Serve static/media files by Caddy --- caddy/Caddyfile | 16 +++++++++++++++- docker-compose.yml | 3 ++- inventory/entrypoint.sh | 1 - inventory/inventory_settings.py | 5 ++++- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/caddy/Caddyfile b/caddy/Caddyfile index 7ebaa37..bc73ea9 100644 --- a/caddy/Caddyfile +++ b/caddy/Caddyfile @@ -3,6 +3,12 @@ {$HOSTNAME} { tls {$LETSENCRYPT_EMAIL} + log { + output stdout + format console + level WARN + } + header { X-Robots-Tag "none" } @@ -13,5 +19,13 @@ Disallow: /" close } - reverse_proxy inventory:8000 + route { + file_server /static { + root /srv/static + } + file_server /media { + root /srv/media + } + reverse_proxy inventory:8000 + } } diff --git a/docker-compose.yml b/docker-compose.yml index c508f89..7241a2b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -9,7 +9,8 @@ services: - "443:443" volumes: - ./caddy/Caddyfile:/etc/caddy/Caddyfile - - ./volumes/static/:/static/:ro + - ./volumes/static/:/srv/static/:ro + - ./volumes/media/:/srv/media/:ro environment: - HOSTNAME=${HOSTNAME:-localhost} - LETSENCRYPT_EMAIL=${LETSENCRYPT_EMAIL:-internal} diff --git a/inventory/entrypoint.sh b/inventory/entrypoint.sh index c741b6e..0b384c1 100755 --- a/inventory/entrypoint.sh +++ b/inventory/entrypoint.sh @@ -31,7 +31,6 @@ echo "$(date +%c) - ${0}" --http inventory:8000 \ --chdir /inventory/ \ --wsgi-file /inventory/wsgi.py \ - --static-map /static/=/static/ \ --master \ --processes 2 \ --threads 2 \ diff --git a/inventory/inventory_settings.py b/inventory/inventory_settings.py index b1bb285..7252369 100644 --- a/inventory/inventory_settings.py +++ b/inventory/inventory_settings.py @@ -5,9 +5,9 @@ import os as __os from inventory_project.settings.base import * # noqa - HOSTNAME = __os.environ['HOSTNAME'] + if HOSTNAME != 'localhost': print(f'Production mode on domain: {HOSTNAME!r}') DEBUG = False @@ -18,6 +18,9 @@ else: INTERNAL_IPS = ('127.0.0.1', '0.0.0.0', 'localhost') +SERVE_FILES = False # Caddy serve static/media files + + ALLOWED_HOSTS = (HOSTNAME,) From 1fcdf14d7a92cb175941b421179b9cd1641edc2d Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 11 Nov 2020 18:48:57 +0100 Subject: [PATCH 17/34] Don't generate migrations --- inventory/entrypoint.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/inventory/entrypoint.sh b/inventory/entrypoint.sh index 0b384c1..4fa99e1 100755 --- a/inventory/entrypoint.sh +++ b/inventory/entrypoint.sh @@ -24,7 +24,6 @@ echo "$(date +%c) - ${0}" pip3 install -U pyinventory ./manage.py collectstatic --noinput - ./manage.py makemigrations ./manage.py migrate uwsgi \ From dd9f5bd1da70ae1264b4dedb6f13e4d2a1ea6ede Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 09:23:44 +0100 Subject: [PATCH 18/34] Bugfix servind static files --- caddy/Caddyfile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/caddy/Caddyfile b/caddy/Caddyfile index bc73ea9..519fc3f 100644 --- a/caddy/Caddyfile +++ b/caddy/Caddyfile @@ -20,11 +20,11 @@ Disallow: /" } route { - file_server /static { - root /srv/static + file_server /static/* { + root /srv/ } - file_server /media { - root /srv/media + file_server /media/* { + root /srv/ } reverse_proxy inventory:8000 } From 27f3b00b6ffb360746c738ac83e2c5f898dd30cd Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 09:25:23 +0100 Subject: [PATCH 19/34] Update default install --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 28222a9..adb449e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -12,6 +12,6 @@ RUN apt-get update \ WORKDIR /inventory -RUN pip install psycopg2-binary pyinventory +RUN pip install psycopg2-binary "pyinventory>=0.4.2" From 67a9ec9725a9fd29d0d3725de73fad215a779d5d Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 09:26:58 +0100 Subject: [PATCH 20/34] seperate pip installations --- Dockerfile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index adb449e..0edda1d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,10 +8,11 @@ RUN apt-get update \ && apt autoremove \ && apt -y full-upgrade \ && rm -rf /var/lib/apt \ - && python3 -m pip install -U pip + && python3 -m pip install -U pip \ + && pip install -U psycopg2-binary WORKDIR /inventory -RUN pip install psycopg2-binary "pyinventory>=0.4.2" +RUN pip install "pyinventory>=0.4.2" From 1a286a509f6ce6c43c7c88284077ca3c3c66259c Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 20:35:27 +0100 Subject: [PATCH 21/34] move stuff into /src/ --- .flake8 => src/.flake8 | 0 .gitignore => src/.gitignore | 0 .isort.cfg => src/.isort.cfg | 0 .style.yapf => src/.style.yapf | 0 Makefile => src/Makefile | 0 README.creole => src/README.creole | 0 README.rst => src/README.rst | 0 {inventory => src/inventory}/__init__.py | 0 {inventory => src/inventory}/admin/__init__.py | 0 {inventory => src/inventory}/admin/base.py | 0 {inventory => src/inventory}/admin/item.py | 0 {inventory => src/inventory}/admin/location.py | 0 {inventory => src/inventory}/apps.py | 0 {inventory => src/inventory}/ckeditor_upload.py | 0 {inventory => src/inventory}/context_processors.py | 0 {inventory => src/inventory}/forms.py | 0 .../inventory}/locale/de/LC_MESSAGES/django.mo | Bin .../inventory}/locale/de/LC_MESSAGES/django.po | 0 .../inventory}/locale/en/LC_MESSAGES/django.mo | Bin .../inventory}/locale/en/LC_MESSAGES/django.po | 0 {inventory => src/inventory}/management/__init__.py | 0 .../inventory}/management/commands/__init__.py | 0 {inventory => src/inventory}/middlewares.py | 0 .../inventory}/migrations/0001_initial.py | 0 .../migrations/0002_auto_20201017_2211.py | 0 .../migrations/0003_auto_20201024_1830.py | 0 {inventory => src/inventory}/migrations/__init__.py | 0 {inventory => src/inventory}/models/__init__.py | 0 {inventory => src/inventory}/models/base.py | 0 {inventory => src/inventory}/models/item.py | 0 {inventory => src/inventory}/models/links.py | 0 {inventory => src/inventory}/models/location.py | 0 {inventory => src/inventory}/permissions.py | 0 {inventory => src/inventory}/request_dict.py | 0 {inventory => src/inventory}/signals.py | 0 {inventory => src/inventory}/static/inventory.css | 0 .../templates/admin/inventory/item/column_item.html | 0 {inventory => src/inventory}/tests/__init__.py | 0 .../inventory_project}/__init__.py | 0 .../inventory_project}/middlewares.py | 0 .../inventory_project}/publish.py | 0 .../inventory_project}/settings/__init__.py | 0 .../inventory_project}/settings/base.py | 0 .../inventory_project}/settings/local.py | 0 .../inventory_project}/settings/tests.py | 0 .../templates/admin/base_site.html | 0 .../inventory_project}/templates/admin/login.html | 0 .../inventory_project}/tests/__init__.py | 0 .../inventory_project}/tests/test_admin.py | 0 .../inventory_project}/tests/test_lint.py | 0 .../inventory_project}/tests/test_migrations.py | 0 .../inventory_project}/tests/test_project_setup.py | 0 .../inventory_project}/urls.py | 0 .../inventory_project}/wsgi.py | 0 manage.py => src/manage.py | 0 manage.sh => src/manage.sh | 0 poetry.lock => src/poetry.lock | 0 pyproject.toml => src/pyproject.toml | 0 pytest.ini => src/pytest.ini | 0 tox.ini => src/tox.ini | 0 60 files changed, 0 insertions(+), 0 deletions(-) rename .flake8 => src/.flake8 (100%) rename .gitignore => src/.gitignore (100%) rename .isort.cfg => src/.isort.cfg (100%) rename .style.yapf => src/.style.yapf (100%) rename Makefile => src/Makefile (100%) rename README.creole => src/README.creole (100%) rename README.rst => src/README.rst (100%) rename {inventory => src/inventory}/__init__.py (100%) rename {inventory => src/inventory}/admin/__init__.py (100%) rename {inventory => src/inventory}/admin/base.py (100%) rename {inventory => src/inventory}/admin/item.py (100%) rename {inventory => src/inventory}/admin/location.py (100%) rename {inventory => src/inventory}/apps.py (100%) rename {inventory => src/inventory}/ckeditor_upload.py (100%) rename {inventory => src/inventory}/context_processors.py (100%) rename {inventory => src/inventory}/forms.py (100%) rename {inventory => src/inventory}/locale/de/LC_MESSAGES/django.mo (100%) rename {inventory => src/inventory}/locale/de/LC_MESSAGES/django.po (100%) rename {inventory => src/inventory}/locale/en/LC_MESSAGES/django.mo (100%) rename {inventory => src/inventory}/locale/en/LC_MESSAGES/django.po (100%) rename {inventory => src/inventory}/management/__init__.py (100%) rename {inventory => src/inventory}/management/commands/__init__.py (100%) rename {inventory => src/inventory}/middlewares.py (100%) rename {inventory => src/inventory}/migrations/0001_initial.py (100%) rename {inventory => src/inventory}/migrations/0002_auto_20201017_2211.py (100%) rename {inventory => src/inventory}/migrations/0003_auto_20201024_1830.py (100%) rename {inventory => src/inventory}/migrations/__init__.py (100%) rename {inventory => src/inventory}/models/__init__.py (100%) rename {inventory => src/inventory}/models/base.py (100%) rename {inventory => src/inventory}/models/item.py (100%) rename {inventory => src/inventory}/models/links.py (100%) rename {inventory => src/inventory}/models/location.py (100%) rename {inventory => src/inventory}/permissions.py (100%) rename {inventory => src/inventory}/request_dict.py (100%) rename {inventory => src/inventory}/signals.py (100%) rename {inventory => src/inventory}/static/inventory.css (100%) rename {inventory => src/inventory}/templates/admin/inventory/item/column_item.html (100%) rename {inventory => src/inventory}/tests/__init__.py (100%) rename {inventory_project => src/inventory_project}/__init__.py (100%) rename {inventory_project => src/inventory_project}/middlewares.py (100%) rename {inventory_project => src/inventory_project}/publish.py (100%) rename {inventory_project => src/inventory_project}/settings/__init__.py (100%) rename {inventory_project => src/inventory_project}/settings/base.py (100%) rename {inventory_project => src/inventory_project}/settings/local.py (100%) rename {inventory_project => src/inventory_project}/settings/tests.py (100%) rename {inventory_project => src/inventory_project}/templates/admin/base_site.html (100%) rename {inventory_project => src/inventory_project}/templates/admin/login.html (100%) rename {inventory_project => src/inventory_project}/tests/__init__.py (100%) rename {inventory_project => src/inventory_project}/tests/test_admin.py (100%) rename {inventory_project => src/inventory_project}/tests/test_lint.py (100%) rename {inventory_project => src/inventory_project}/tests/test_migrations.py (100%) rename {inventory_project => src/inventory_project}/tests/test_project_setup.py (100%) rename {inventory_project => src/inventory_project}/urls.py (100%) rename {inventory_project => src/inventory_project}/wsgi.py (100%) rename manage.py => src/manage.py (100%) rename manage.sh => src/manage.sh (100%) rename poetry.lock => src/poetry.lock (100%) rename pyproject.toml => src/pyproject.toml (100%) rename pytest.ini => src/pytest.ini (100%) rename tox.ini => src/tox.ini (100%) diff --git a/.flake8 b/src/.flake8 similarity index 100% rename from .flake8 rename to src/.flake8 diff --git a/.gitignore b/src/.gitignore similarity index 100% rename from .gitignore rename to src/.gitignore diff --git a/.isort.cfg b/src/.isort.cfg similarity index 100% rename from .isort.cfg rename to src/.isort.cfg diff --git a/.style.yapf b/src/.style.yapf similarity index 100% rename from .style.yapf rename to src/.style.yapf diff --git a/Makefile b/src/Makefile similarity index 100% rename from Makefile rename to src/Makefile diff --git a/README.creole b/src/README.creole similarity index 100% rename from README.creole rename to src/README.creole diff --git a/README.rst b/src/README.rst similarity index 100% rename from README.rst rename to src/README.rst diff --git a/inventory/__init__.py b/src/inventory/__init__.py similarity index 100% rename from inventory/__init__.py rename to src/inventory/__init__.py diff --git a/inventory/admin/__init__.py b/src/inventory/admin/__init__.py similarity index 100% rename from inventory/admin/__init__.py rename to src/inventory/admin/__init__.py diff --git a/inventory/admin/base.py b/src/inventory/admin/base.py similarity index 100% rename from inventory/admin/base.py rename to src/inventory/admin/base.py diff --git a/inventory/admin/item.py b/src/inventory/admin/item.py similarity index 100% rename from inventory/admin/item.py rename to src/inventory/admin/item.py diff --git a/inventory/admin/location.py b/src/inventory/admin/location.py similarity index 100% rename from inventory/admin/location.py rename to src/inventory/admin/location.py diff --git a/inventory/apps.py b/src/inventory/apps.py similarity index 100% rename from inventory/apps.py rename to src/inventory/apps.py diff --git a/inventory/ckeditor_upload.py b/src/inventory/ckeditor_upload.py similarity index 100% rename from inventory/ckeditor_upload.py rename to src/inventory/ckeditor_upload.py diff --git a/inventory/context_processors.py b/src/inventory/context_processors.py similarity index 100% rename from inventory/context_processors.py rename to src/inventory/context_processors.py diff --git a/inventory/forms.py b/src/inventory/forms.py similarity index 100% rename from inventory/forms.py rename to src/inventory/forms.py diff --git a/inventory/locale/de/LC_MESSAGES/django.mo b/src/inventory/locale/de/LC_MESSAGES/django.mo similarity index 100% rename from inventory/locale/de/LC_MESSAGES/django.mo rename to src/inventory/locale/de/LC_MESSAGES/django.mo diff --git a/inventory/locale/de/LC_MESSAGES/django.po b/src/inventory/locale/de/LC_MESSAGES/django.po similarity index 100% rename from inventory/locale/de/LC_MESSAGES/django.po rename to src/inventory/locale/de/LC_MESSAGES/django.po diff --git a/inventory/locale/en/LC_MESSAGES/django.mo b/src/inventory/locale/en/LC_MESSAGES/django.mo similarity index 100% rename from inventory/locale/en/LC_MESSAGES/django.mo rename to src/inventory/locale/en/LC_MESSAGES/django.mo diff --git a/inventory/locale/en/LC_MESSAGES/django.po b/src/inventory/locale/en/LC_MESSAGES/django.po similarity index 100% rename from inventory/locale/en/LC_MESSAGES/django.po rename to src/inventory/locale/en/LC_MESSAGES/django.po diff --git a/inventory/management/__init__.py b/src/inventory/management/__init__.py similarity index 100% rename from inventory/management/__init__.py rename to src/inventory/management/__init__.py diff --git a/inventory/management/commands/__init__.py b/src/inventory/management/commands/__init__.py similarity index 100% rename from inventory/management/commands/__init__.py rename to src/inventory/management/commands/__init__.py diff --git a/inventory/middlewares.py b/src/inventory/middlewares.py similarity index 100% rename from inventory/middlewares.py rename to src/inventory/middlewares.py diff --git a/inventory/migrations/0001_initial.py b/src/inventory/migrations/0001_initial.py similarity index 100% rename from inventory/migrations/0001_initial.py rename to src/inventory/migrations/0001_initial.py diff --git a/inventory/migrations/0002_auto_20201017_2211.py b/src/inventory/migrations/0002_auto_20201017_2211.py similarity index 100% rename from inventory/migrations/0002_auto_20201017_2211.py rename to src/inventory/migrations/0002_auto_20201017_2211.py diff --git a/inventory/migrations/0003_auto_20201024_1830.py b/src/inventory/migrations/0003_auto_20201024_1830.py similarity index 100% rename from inventory/migrations/0003_auto_20201024_1830.py rename to src/inventory/migrations/0003_auto_20201024_1830.py diff --git a/inventory/migrations/__init__.py b/src/inventory/migrations/__init__.py similarity index 100% rename from inventory/migrations/__init__.py rename to src/inventory/migrations/__init__.py diff --git a/inventory/models/__init__.py b/src/inventory/models/__init__.py similarity index 100% rename from inventory/models/__init__.py rename to src/inventory/models/__init__.py diff --git a/inventory/models/base.py b/src/inventory/models/base.py similarity index 100% rename from inventory/models/base.py rename to src/inventory/models/base.py diff --git a/inventory/models/item.py b/src/inventory/models/item.py similarity index 100% rename from inventory/models/item.py rename to src/inventory/models/item.py diff --git a/inventory/models/links.py b/src/inventory/models/links.py similarity index 100% rename from inventory/models/links.py rename to src/inventory/models/links.py diff --git a/inventory/models/location.py b/src/inventory/models/location.py similarity index 100% rename from inventory/models/location.py rename to src/inventory/models/location.py diff --git a/inventory/permissions.py b/src/inventory/permissions.py similarity index 100% rename from inventory/permissions.py rename to src/inventory/permissions.py diff --git a/inventory/request_dict.py b/src/inventory/request_dict.py similarity index 100% rename from inventory/request_dict.py rename to src/inventory/request_dict.py diff --git a/inventory/signals.py b/src/inventory/signals.py similarity index 100% rename from inventory/signals.py rename to src/inventory/signals.py diff --git a/inventory/static/inventory.css b/src/inventory/static/inventory.css similarity index 100% rename from inventory/static/inventory.css rename to src/inventory/static/inventory.css diff --git a/inventory/templates/admin/inventory/item/column_item.html b/src/inventory/templates/admin/inventory/item/column_item.html similarity index 100% rename from inventory/templates/admin/inventory/item/column_item.html rename to src/inventory/templates/admin/inventory/item/column_item.html diff --git a/inventory/tests/__init__.py b/src/inventory/tests/__init__.py similarity index 100% rename from inventory/tests/__init__.py rename to src/inventory/tests/__init__.py diff --git a/inventory_project/__init__.py b/src/inventory_project/__init__.py similarity index 100% rename from inventory_project/__init__.py rename to src/inventory_project/__init__.py diff --git a/inventory_project/middlewares.py b/src/inventory_project/middlewares.py similarity index 100% rename from inventory_project/middlewares.py rename to src/inventory_project/middlewares.py diff --git a/inventory_project/publish.py b/src/inventory_project/publish.py similarity index 100% rename from inventory_project/publish.py rename to src/inventory_project/publish.py diff --git a/inventory_project/settings/__init__.py b/src/inventory_project/settings/__init__.py similarity index 100% rename from inventory_project/settings/__init__.py rename to src/inventory_project/settings/__init__.py diff --git a/inventory_project/settings/base.py b/src/inventory_project/settings/base.py similarity index 100% rename from inventory_project/settings/base.py rename to src/inventory_project/settings/base.py diff --git a/inventory_project/settings/local.py b/src/inventory_project/settings/local.py similarity index 100% rename from inventory_project/settings/local.py rename to src/inventory_project/settings/local.py diff --git a/inventory_project/settings/tests.py b/src/inventory_project/settings/tests.py similarity index 100% rename from inventory_project/settings/tests.py rename to src/inventory_project/settings/tests.py diff --git a/inventory_project/templates/admin/base_site.html b/src/inventory_project/templates/admin/base_site.html similarity index 100% rename from inventory_project/templates/admin/base_site.html rename to src/inventory_project/templates/admin/base_site.html diff --git a/inventory_project/templates/admin/login.html b/src/inventory_project/templates/admin/login.html similarity index 100% rename from inventory_project/templates/admin/login.html rename to src/inventory_project/templates/admin/login.html diff --git a/inventory_project/tests/__init__.py b/src/inventory_project/tests/__init__.py similarity index 100% rename from inventory_project/tests/__init__.py rename to src/inventory_project/tests/__init__.py diff --git a/inventory_project/tests/test_admin.py b/src/inventory_project/tests/test_admin.py similarity index 100% rename from inventory_project/tests/test_admin.py rename to src/inventory_project/tests/test_admin.py diff --git a/inventory_project/tests/test_lint.py b/src/inventory_project/tests/test_lint.py similarity index 100% rename from inventory_project/tests/test_lint.py rename to src/inventory_project/tests/test_lint.py diff --git a/inventory_project/tests/test_migrations.py b/src/inventory_project/tests/test_migrations.py similarity index 100% rename from inventory_project/tests/test_migrations.py rename to src/inventory_project/tests/test_migrations.py diff --git a/inventory_project/tests/test_project_setup.py b/src/inventory_project/tests/test_project_setup.py similarity index 100% rename from inventory_project/tests/test_project_setup.py rename to src/inventory_project/tests/test_project_setup.py diff --git a/inventory_project/urls.py b/src/inventory_project/urls.py similarity index 100% rename from inventory_project/urls.py rename to src/inventory_project/urls.py diff --git a/inventory_project/wsgi.py b/src/inventory_project/wsgi.py similarity index 100% rename from inventory_project/wsgi.py rename to src/inventory_project/wsgi.py diff --git a/manage.py b/src/manage.py similarity index 100% rename from manage.py rename to src/manage.py diff --git a/manage.sh b/src/manage.sh similarity index 100% rename from manage.sh rename to src/manage.sh diff --git a/poetry.lock b/src/poetry.lock similarity index 100% rename from poetry.lock rename to src/poetry.lock diff --git a/pyproject.toml b/src/pyproject.toml similarity index 100% rename from pyproject.toml rename to src/pyproject.toml diff --git a/pytest.ini b/src/pytest.ini similarity index 100% rename from pytest.ini rename to src/pytest.ini diff --git a/tox.ini b/src/tox.ini similarity index 100% rename from tox.ini rename to src/tox.ini From 13dad450a95f701d44d28c0d179bbfe1672a49c1 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 20:43:58 +0100 Subject: [PATCH 22/34] setup .gitignore --- .gitignore | 5 +++++ src/.gitignore | 2 -- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bf895fa --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.* +!.github +!.editorconfig +!.gitignore +!.travis.yml diff --git a/src/.gitignore b/src/.gitignore index 3af867f..c41f249 100644 --- a/src/.gitignore +++ b/src/.gitignore @@ -1,6 +1,4 @@ .* -!.github -!.editorconfig !.flake8 !.gitignore !.isort.cfg From 159585da1b937768c8d15d800ef9648f27b8de8c Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 20:50:16 +0100 Subject: [PATCH 23/34] Start to update README --- src/README.creole => README.creole | 29 +++++++++++++++-------------- src/README.rst => README.rst | 0 2 files changed, 15 insertions(+), 14 deletions(-) rename src/README.creole => README.creole (88%) rename src/README.rst => README.rst (100%) diff --git a/src/README.creole b/README.creole similarity index 88% rename from src/README.creole rename to README.creole index 8f9c9b1..ef2b8f9 100644 --- a/src/README.creole +++ b/README.creole @@ -37,13 +37,13 @@ Plan: any many more... ;) -== git branches +== Project structure -Currently we have two main branches: +There are two main directories: -|= git branch |= description -| **[[https://github.com/jedie/PyInventory/tree/master|master]]** | The main PyInventory source code -| **[[https://github.com/jedie/PyInventory/tree/deployment|deployment]]** | separate project to deploy PyInventory for production use case +|= directory |= description +| **[[https://github.com/jedie/PyInventory/tree/master/src|/src/]]** | The main PyInventory source code +| **[[https://github.com/jedie/PyInventory/tree/master/deployment|/deployment/]]** | deploy PyInventory for production use case == install @@ -52,17 +52,17 @@ There exists two kind of installation/usage: * local development installation using poetry * production use with docker-compose -This README (in git **master** branch) contains only the information about local develompment installation. +This README contains only the information about local development installation. -Read [[https://github.com/jedie/PyInventory/tree/deployment#readme|deployment README]] for instruction to install PyInventory on a root server. +Read [[https://github.com/jedie/PyInventory/tree/master/deployment#readme|/deployment/README]] for instruction to install PyInventory on a root server. === prepare {{{ ~$ git clone https://github.com/jedie/PyInventory.git -~$ cd PyInventory -~/PyInventory$ make +~$ cd PyInventory/src/ +~/PyInventory/src$ make help List all commands install-poetry install or update poetry install install PyInventory via poetry @@ -92,20 +92,20 @@ dbrestore Restore a database backup {{{ # install or update Poetry: -~/PyInventory$ make install-poetry +~/PyInventory/src$ make install-poetry # install PyInventory via poetry: -~/PyInventory$ make install +~/PyInventory/src$ make install ... # Collectstatic + makemigration + migrate: -~/PyInventory$ make manage-update +~/PyInventory/src$ make manage-update # Create a django super user: -~/PyInventory$ ./manage.sh createsuperuser +~/PyInventory/src$ ./manage.sh createsuperuser # start local dev. web server: -~/PyInventory$ make run-dev-server +~/PyInventory/src$ make run-dev-server }}} The web page is available via: {{{http://127.0.0.1:8000/}}} @@ -156,6 +156,7 @@ Nothing, yet ;) == history * [[https://github.com/jedie/PyInventory/compare/v0.4.2...master|compare v0.4.2...master]] **dev** +* Merge seperate git branches into one: "/src/" and "/development/" [[https://github.com/jedie/PyInventory/issues/19|#19]] ** tbc * [[https://github.com/jedie/PyInventory/compare/v0.4.1...v0.4.2|v0.4.2 - 13.11.2020]] ** Serve static files by Caddy diff --git a/src/README.rst b/README.rst similarity index 100% rename from src/README.rst rename to README.rst From f4c744772c68d543ad89d44a6ceb4cb70f58de69 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 20:54:17 +0100 Subject: [PATCH 24/34] fix github action --- .github/workflows/pythonapp.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml index 1449c8f..ace9ad9 100644 --- a/.github/workflows/pythonapp.yml +++ b/.github/workflows/pythonapp.yml @@ -21,6 +21,7 @@ jobs: - name: 'Install package' run: | + cd src make install-poetry source $HOME/.poetry/env poetry lock From 9c058a03d4df5bac194ab23de59c0a1ccdb8b9c0 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 20:55:53 +0100 Subject: [PATCH 25/34] update path to meta files --- src/pyproject.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pyproject.toml b/src/pyproject.toml index 5b3f412..406544d 100644 --- a/src/pyproject.toml +++ b/src/pyproject.toml @@ -26,10 +26,10 @@ classifiers = [ "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", "Operating System :: OS Independent", ] -include = ['AUTHORS', 'LICENSE', 'README.creole'] +include = ['../AUTHORS', '../LICENSE', '../README.creole'] # Will be generated from README.creole with: 'poetry run update_rst_readme' -readme='README.rst' +readme='../README.rst' [tool.poetry.dependencies] python = ">=3.7,<4.0.0" From 83ba4da9a98287b354698ce9b7e42024f6db2099 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 21:52:19 +0100 Subject: [PATCH 26/34] WIP: Fix project layout --- src/.flake8 => .flake8 | 0 .github/workflows/pythonapp.yml | 1 - .gitignore | 73 ++++++++++++++++++- src/.isort.cfg => .isort.cfg | 0 src/.style.yapf => .style.yapf | 0 src/Makefile => Makefile | 0 README.creole | 14 ++-- README.rst | 38 +++++----- deployment/inventory/inventory_settings.py | 1 + src/manage.py => manage.py | 11 ++- src/manage.sh => manage.sh | 0 src/poetry.lock => poetry.lock | 0 src/pyproject.toml => pyproject.toml | 8 +- src/pytest.ini => pytest.ini | 4 +- src/.gitignore | 72 ------------------ src/inventory_project/publish.py | 2 +- src/inventory_project/settings/base.py | 5 +- src/inventory_project/settings/local.py | 4 +- src/inventory_project/tests/test_lint.py | 2 +- .../tests/test_project_setup.py | 2 +- src/tox.ini => tox.ini | 0 21 files changed, 120 insertions(+), 117 deletions(-) rename src/.flake8 => .flake8 (100%) rename src/.isort.cfg => .isort.cfg (100%) rename src/.style.yapf => .style.yapf (100%) rename src/Makefile => Makefile (100%) rename src/manage.py => manage.py (74%) rename src/manage.sh => manage.sh (100%) rename src/poetry.lock => poetry.lock (100%) rename src/pyproject.toml => pyproject.toml (95%) rename src/pytest.ini => pytest.ini (93%) delete mode 100644 src/.gitignore rename src/tox.ini => tox.ini (100%) diff --git a/src/.flake8 b/.flake8 similarity index 100% rename from src/.flake8 rename to .flake8 diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml index ace9ad9..1449c8f 100644 --- a/.github/workflows/pythonapp.yml +++ b/.github/workflows/pythonapp.yml @@ -21,7 +21,6 @@ jobs: - name: 'Install package' run: | - cd src make install-poetry source $HOME/.poetry/env poetry lock diff --git a/.gitignore b/.gitignore index bf895fa..c41f249 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,72 @@ .* -!.github -!.editorconfig +!.flake8 !.gitignore -!.travis.yml +!.isort.cfg +!/.travis.yml +!/.style.yapf +!.coveralls.yml + +# for django-dbbackup +/backups/ +!/backups/.gitkeep + +# from test projects: +/static/ +/media/ +*.sqlite3 + + +# Django +secret.txt + +# Coverage HTML Report files: +htmlcov + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.tox +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +db.sqlite3 +coverage_html/ +coverage.xml +*,cover + +# Translations +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + diff --git a/src/.isort.cfg b/.isort.cfg similarity index 100% rename from src/.isort.cfg rename to .isort.cfg diff --git a/src/.style.yapf b/.style.yapf similarity index 100% rename from src/.style.yapf rename to .style.yapf diff --git a/src/Makefile b/Makefile similarity index 100% rename from src/Makefile rename to Makefile diff --git a/README.creole b/README.creole index ef2b8f9..e1015ab 100644 --- a/README.creole +++ b/README.creole @@ -61,8 +61,8 @@ Read [[https://github.com/jedie/PyInventory/tree/master/deployment#readme|/deplo {{{ ~$ git clone https://github.com/jedie/PyInventory.git -~$ cd PyInventory/src/ -~/PyInventory/src$ make +~$ cd PyInventory/ +~/PyInventory$ make help List all commands install-poetry install or update poetry install install PyInventory via poetry @@ -92,20 +92,20 @@ dbrestore Restore a database backup {{{ # install or update Poetry: -~/PyInventory/src$ make install-poetry +~/PyInventory$ make install-poetry # install PyInventory via poetry: -~/PyInventory/src$ make install +~/PyInventory$ make install ... # Collectstatic + makemigration + migrate: -~/PyInventory/src$ make manage-update +~/PyInventory$ make manage-update # Create a django super user: -~/PyInventory/src$ ./manage.sh createsuperuser +~/PyInventory$ ./manage.sh createsuperuser # start local dev. web server: -~/PyInventory/src$ make run-dev-server +~/PyInventory$ make run-dev-server }}} The web page is available via: {{{http://127.0.0.1:8000/}}} diff --git a/README.rst b/README.rst index 1f3b76c..2c6769e 100644 --- a/README.rst +++ b/README.rst @@ -69,22 +69,22 @@ Plan: any many more... ;) ------------- -git branches ------------- +----------------- +Project structure +----------------- -Currently we have two main branches: +There are two main directories: -+-------------------+----------------------------------------------------------------+ -| git branch | description | -+===================+================================================================+ -| **`master`_** | The main PyInventory source code | -+-------------------+----------------------------------------------------------------+ -| **`deployment`_** | separate project to deploy PyInventory for production use case | -+-------------------+----------------------------------------------------------------+ ++---------------------+--------------------------------------------+ +| directory | description | ++=====================+============================================+ +| **`/src/`_** | The main PyInventory source code | ++---------------------+--------------------------------------------+ +| **`/deployment/`_** | deploy PyInventory for production use case | ++---------------------+--------------------------------------------+ -.. _master: https://github.com/jedie/PyInventory/tree/master -.. _deployment: https://github.com/jedie/PyInventory/tree/deployment +.. _/src/: https://github.com/jedie/PyInventory/tree/master/src +.. _/deployment/: https://github.com/jedie/PyInventory/tree/master/deployment ------- install @@ -96,9 +96,9 @@ There exists two kind of installation/usage: * production use with docker-compose -This README (in git **master** branch) contains only the information about local develompment installation. +This README contains only the information about local development installation. -Read `deployment README `_ for instruction to install PyInventory on a root server. +Read `/deployment/README `_ for instruction to install PyInventory on a root server. prepare ======= @@ -106,7 +106,7 @@ prepare :: ~$ git clone https://github.com/jedie/PyInventory.git - ~$ cd PyInventory + ~$ cd PyInventory/ ~/PyInventory$ make help List all commands install-poetry install or update poetry @@ -214,7 +214,9 @@ Nothing, yet ;) history ------- -* `compare v0.4.2...master `_ **dev** +* `compare v0.4.2...master `_ **dev** + +* Merge seperate git branches into one: "/src/" and "/development/" `#19 `_ * tbc @@ -315,4 +317,4 @@ donation ------------ -``Note: this file is generated from README.creole 2020-11-13 09:09:36 with "python-creole"`` \ No newline at end of file +``Note: this file is generated from README.creole 2020-11-13 21:51:42 with "python-creole"`` \ No newline at end of file diff --git a/deployment/inventory/inventory_settings.py b/deployment/inventory/inventory_settings.py index 7252369..17787f2 100644 --- a/deployment/inventory/inventory_settings.py +++ b/deployment/inventory/inventory_settings.py @@ -5,6 +5,7 @@ import os as __os from inventory_project.settings.base import * # noqa + HOSTNAME = __os.environ['HOSTNAME'] diff --git a/src/manage.py b/manage.py similarity index 74% rename from src/manage.py rename to manage.py index 6d57aaf..3d14d8b 100644 --- a/src/manage.py +++ b/manage.py @@ -1,11 +1,20 @@ #!/usr/bin/env python3 - import os import sys +from pathlib import Path + + +BASE_PATH = Path(__file__).parent def main(): assert 'DJANGO_SETTINGS_MODULE' in os.environ, 'No "DJANGO_SETTINGS_MODULE" in environment!' + + # Change to /src/ and add it to sys.path + src_path = Path(BASE_PATH, 'src').resolve() + assert src_path.is_dir(), f'Path not exists: {src_path}' + sys.path.insert(0, str(src_path)) + try: from django.core.management import execute_from_command_line except ImportError as exc: diff --git a/src/manage.sh b/manage.sh similarity index 100% rename from src/manage.sh rename to manage.sh diff --git a/src/poetry.lock b/poetry.lock similarity index 100% rename from src/poetry.lock rename to poetry.lock diff --git a/src/pyproject.toml b/pyproject.toml similarity index 95% rename from src/pyproject.toml rename to pyproject.toml index 406544d..8d3bd10 100644 --- a/src/pyproject.toml +++ b/pyproject.toml @@ -4,8 +4,8 @@ version = "0.4.2" description = "Web based management to catalog things including state and location etc. using Python/Django." authors = ["JensDiemer "] packages = [ - { include = "inventory" }, - { include = "inventory_project" }, + { include = "inventory", from = "src" }, + { include = "inventory_project", from = "src" }, ] keywords=['inventory','django'] classifiers = [ @@ -26,10 +26,10 @@ classifiers = [ "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", "Operating System :: OS Independent", ] -include = ['../AUTHORS', '../LICENSE', '../README.creole'] +include = ['AUTHORS', 'LICENSE', 'README.creole'] # Will be generated from README.creole with: 'poetry run update_rst_readme' -readme='../README.rst' +readme='README.rst' [tool.poetry.dependencies] python = ">=3.7,<4.0.0" diff --git a/src/pytest.ini b/pytest.ini similarity index 93% rename from src/pytest.ini rename to pytest.ini index b3949d9..0e6b176 100644 --- a/src/pytest.ini +++ b/pytest.ini @@ -4,9 +4,7 @@ [pytest] DJANGO_SETTINGS_MODULE=inventory_project.settings.tests -testpaths = - inventory/tests/ - inventory_project/tests/ +testpaths = src # http://doc.pytest.org/en/latest/customize.html#confval-norecursedirs norecursedirs = .* .git __pycache__ coverage* dist diff --git a/src/.gitignore b/src/.gitignore deleted file mode 100644 index c41f249..0000000 --- a/src/.gitignore +++ /dev/null @@ -1,72 +0,0 @@ -.* -!.flake8 -!.gitignore -!.isort.cfg -!/.travis.yml -!/.style.yapf -!.coveralls.yml - -# for django-dbbackup -/backups/ -!/backups/.gitkeep - -# from test projects: -/static/ -/media/ -*.sqlite3 - - -# Django -secret.txt - -# Coverage HTML Report files: -htmlcov - -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.tox -.Python -env/ -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -*.egg-info/ -.installed.cfg -*.egg - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -db.sqlite3 -coverage_html/ -coverage.xml -*,cover - -# Translations -*.pot - -# Django stuff: -*.log - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - diff --git a/src/inventory_project/publish.py b/src/inventory_project/publish.py index 9d000ba..e8a1eef 100644 --- a/src/inventory_project/publish.py +++ b/src/inventory_project/publish.py @@ -8,7 +8,7 @@ from poetry_publish.utils.subprocess_utils import verbose_check_call import inventory -PACKAGE_ROOT = Path(inventory.__file__).parent.parent +PACKAGE_ROOT = Path(inventory.__file__).parent.parent.parent def update_readme(): diff --git a/src/inventory_project/settings/base.py b/src/inventory_project/settings/base.py index 3ec36e5..df35aca 100644 --- a/src/inventory_project/settings/base.py +++ b/src/inventory_project/settings/base.py @@ -8,8 +8,9 @@ from pathlib import Path as __Path from django.utils.translation import ugettext_lazy as _ -# Build paths inside the project: -BASE_PATH = __Path(__file__).resolve().parent.parent.parent +# Build paths relative to the current working directory: +BASE_PATH = __Path().cwd().resolve() +print(f'BASE_PATH:{BASE_PATH}') # SECURITY WARNING: don't run with debug turned on in production! diff --git a/src/inventory_project/settings/local.py b/src/inventory_project/settings/local.py index fe01672..4d18adf 100644 --- a/src/inventory_project/settings/local.py +++ b/src/inventory_project/settings/local.py @@ -7,7 +7,6 @@ """ import sys as __sys -from pathlib import Path as __Path from inventory_project.settings.base import * # noqa @@ -31,8 +30,7 @@ ALLOWED_HOSTS = INTERNAL_IPS DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': str(__Path(BASE_PATH.parent, 'PyInventory-database.sqlite3')), - # 'NAME': ':memory:' + 'NAME': str(BASE_PATH / 'PyInventory-database.sqlite3'), # https://docs.djangoproject.com/en/dev/ref/databases/#database-is-locked-errors 'timeout': 30, } diff --git a/src/inventory_project/tests/test_lint.py b/src/inventory_project/tests/test_lint.py index b402999..edd26d8 100644 --- a/src/inventory_project/tests/test_lint.py +++ b/src/inventory_project/tests/test_lint.py @@ -5,7 +5,7 @@ from pathlib import Path import inventory -BASE_PATH = Path(inventory.__file__).parent.parent +BASE_PATH = Path(inventory.__file__).parent.parent.parent def test_lint(): diff --git a/src/inventory_project/tests/test_project_setup.py b/src/inventory_project/tests/test_project_setup.py index fadcbac..8602969 100644 --- a/src/inventory_project/tests/test_project_setup.py +++ b/src/inventory_project/tests/test_project_setup.py @@ -8,7 +8,7 @@ from creole.setup_utils import update_rst_readme import inventory -PACKAGE_ROOT = Path(inventory.__file__).parent.parent +PACKAGE_ROOT = Path(inventory.__file__).parent.parent.parent def assert_file_contains_string(file_path, string): diff --git a/src/tox.ini b/tox.ini similarity index 100% rename from src/tox.ini rename to tox.ini From a973fac4e6b45fb18049bbc3deeb7cd016802bbf Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 21:53:51 +0100 Subject: [PATCH 27/34] update requirements --- poetry.lock | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/poetry.lock b/poetry.lock index 0554030..da3673b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -627,7 +627,7 @@ python-versions = "*" [[package]] name = "model-bakery" -version = "1.2.0" +version = "1.2.1" description = "Smart object creation facility for Django." category = "dev" optional = false @@ -951,7 +951,7 @@ version = "5.3.1" description = "YAML parser and emitter for Python" category = "main" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +python-versions = "*" [[package]] name = "readme-renderer" @@ -972,7 +972,7 @@ md = ["cmarkgfm (>=0.2.0)"] [[package]] name = "requests" -version = "2.24.0" +version = "2.25.0" description = "Python HTTP for Humans." category = "main" optional = false @@ -982,7 +982,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" certifi = ">=2017.4.17" chardet = ">=3.0.2,<4" idna = ">=2.5,<3" -urllib3 = ">=1.21.1,<1.25.0 || >1.25.0,<1.25.1 || >1.25.1,<1.26" +urllib3 = ">=1.21.1,<1.27" [package.extras] security = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)"] @@ -1143,7 +1143,7 @@ tqdm = ">=4.14" [[package]] name = "urllib3" -version = "1.25.11" +version = "1.26.2" description = "HTTP library with thread-safe connection pooling, file post, and more." category = "main" optional = false @@ -1326,6 +1326,7 @@ chardet = [ ] colorama = [ {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, + {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, ] colorlog = [ {file = "colorlog-4.6.2-py2.py3-none-any.whl", hash = "sha256:edd5ada5de03e880e42b2526f8be5570fd9b692f8eb7cf6b1fdcac3e3fb23976"}, @@ -1508,6 +1509,7 @@ importlib-metadata = [ {file = "importlib_metadata-2.0.0.tar.gz", hash = "sha256:77a540690e24b0305878c37ffd421785a6f7e53c8b5720d211b211de8d0e95da"}, ] iniconfig = [ + {file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"}, {file = "iniconfig-1.1.1.tar.gz", hash = "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32"}, ] isort = [ @@ -1538,8 +1540,8 @@ mccabe = [ {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"}, ] model-bakery = [ - {file = "model_bakery-1.2.0-py2.py3-none-any.whl", hash = "sha256:b25f400b392067f02d841a0ef33e861543c04b1702dc004020bdd50e1dbce05f"}, - {file = "model_bakery-1.2.0.tar.gz", hash = "sha256:088698cdf62e5ccedeb97e55ceb966c974cc79e2514928aec9beab27a8c1faf4"}, + {file = "model_bakery-1.2.1-py2.py3-none-any.whl", hash = "sha256:d3260bd055c25998b54eda2082a507ba7fd113fe071156bdad065da426b14851"}, + {file = "model_bakery-1.2.1.tar.gz", hash = "sha256:c2b3521a866b2b25ee0b5f953bfa385ef7d27ad75f30abf5e2de6dd61160c404"}, ] odfpy = [ {file = "odfpy-1.4.1-py2.7.egg", hash = "sha256:fc3b8d1bc098eba4a0fda865a76d9d1e577c4ceec771426bcb169a82c5e9dfe0"}, @@ -1637,6 +1639,8 @@ psycopg2-binary = [ {file = "psycopg2_binary-2.8.6-cp39-cp39-macosx_10_9_x86_64.macosx_10_9_intel.macosx_10_10_intel.macosx_10_10_x86_64.whl", hash = "sha256:89705f45ce07b2dfa806ee84439ec67c5d9a0ef20154e0e475e2b2ed392a5b83"}, {file = "psycopg2_binary-2.8.6-cp39-cp39-manylinux1_i686.whl", hash = "sha256:42ec1035841b389e8cc3692277a0bd81cdfe0b65d575a2c8862cec7a80e62e52"}, {file = "psycopg2_binary-2.8.6-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:7312e931b90fe14f925729cde58022f5d034241918a5c4f9797cac62f6b3a9dd"}, + {file = "psycopg2_binary-2.8.6-cp39-cp39-win32.whl", hash = "sha256:6422f2ff0919fd720195f64ffd8f924c1395d30f9a495f31e2392c2efafb5056"}, + {file = "psycopg2_binary-2.8.6-cp39-cp39-win_amd64.whl", hash = "sha256:15978a1fbd225583dd8cdaf37e67ccc278b5abecb4caf6b2d6b8e2b948e953f6"}, ] py = [ {file = "py-1.9.0-py2.py3-none-any.whl", hash = "sha256:366389d1db726cd2fcfc79732e75410e5fe4d31db13692115529d34069a043c2"}, @@ -1753,8 +1757,8 @@ readme-renderer = [ {file = "readme_renderer-28.0.tar.gz", hash = "sha256:6b7e5aa59210a40de72eb79931491eaf46fefca2952b9181268bd7c7c65c260a"}, ] requests = [ - {file = "requests-2.24.0-py2.py3-none-any.whl", hash = "sha256:fe75cc94a9443b9246fc7049224f75604b113c36acb93f87b80ed42c44cbb898"}, - {file = "requests-2.24.0.tar.gz", hash = "sha256:b3559a131db72c33ee969480840fff4bb6dd111de7dd27c8ee1f820f4f00231b"}, + {file = "requests-2.25.0-py2.py3-none-any.whl", hash = "sha256:e786fa28d8c9154e6a4de5d46a1d921b8749f8b74e28bde23768e5e16eece998"}, + {file = "requests-2.25.0.tar.gz", hash = "sha256:7f1a0b932f4a60a1a65caa4263921bb7d9ee911957e0ae4a23a6dd08185ad5f8"}, ] requests-toolbelt = [ {file = "requests-toolbelt-0.9.1.tar.gz", hash = "sha256:968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0"}, @@ -1805,8 +1809,8 @@ twine = [ {file = "twine-3.2.0.tar.gz", hash = "sha256:34352fd52ec3b9d29837e6072d5a2a7c6fe4290e97bba46bb8d478b5c598f7ab"}, ] urllib3 = [ - {file = "urllib3-1.25.11-py2.py3-none-any.whl", hash = "sha256:f5321fbe4bf3fefa0efd0bfe7fb14e90909eb62a48ccda331726b4319897dd5e"}, - {file = "urllib3-1.25.11.tar.gz", hash = "sha256:8d7eaa5a82a1cac232164990f04874c594c9453ec55eef02eab885aa02fc17a2"}, + {file = "urllib3-1.26.2-py2.py3-none-any.whl", hash = "sha256:d8ff90d979214d7b4f8ce956e80f4028fc6860e4431f731ea4a8c08f23f99473"}, + {file = "urllib3-1.26.2.tar.gz", hash = "sha256:19188f96923873c92ccb987120ec4acaa12f0461fa9ce5d3d0772bc965a39e08"}, ] uwsgi = [ {file = "uWSGI-2.0.19.1.tar.gz", hash = "sha256:faa85e053c0b1be4d5585b0858d3a511d2cd10201802e8676060fd0a109e5869"}, From 7820ea28abcf146c533dae15853b6c90300af326 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:32:19 +0100 Subject: [PATCH 28/34] fix tox --- pytest.ini | 5 ++++- src/inventory/tests/__init__.py | 0 tox.ini | 5 ++--- 3 files changed, 6 insertions(+), 4 deletions(-) delete mode 100644 src/inventory/tests/__init__.py diff --git a/pytest.ini b/pytest.ini index 0e6b176..5679270 100644 --- a/pytest.ini +++ b/pytest.ini @@ -4,11 +4,14 @@ [pytest] DJANGO_SETTINGS_MODULE=inventory_project.settings.tests -testpaths = src # http://doc.pytest.org/en/latest/customize.html#confval-norecursedirs norecursedirs = .* .git __pycache__ coverage* dist addopts = + --import-mode=importlib + --ignore-glob=deployment/inventory/* + --collect-in-virtualenv + --reuse-db --nomigrations diff --git a/src/inventory/tests/__init__.py b/src/inventory/tests/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/tox.ini b/tox.ini index e3ae0c4..3766271 100644 --- a/tox.ini +++ b/tox.ini @@ -4,8 +4,7 @@ envlist = py39,py38,py37 skip_missing_interpreters = True [testenv] -whitelist_externals = make +whitelist_externals = pytest commands = - make install - make pytest + pytest --pyargs inventory inventory_project -x From 45f53541a9bc8a1dbffaca85217b26c3f40942d4 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:38:28 +0100 Subject: [PATCH 29/34] move tox.ini into pyproject.toml --- pyproject.toml | 20 +++++++++++++++++--- tox.ini | 10 ---------- 2 files changed, 17 insertions(+), 13 deletions(-) delete mode 100644 tox.ini diff --git a/pyproject.toml b/pyproject.toml index 8d3bd10..ef983b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -84,11 +84,25 @@ manage = "inventory_project.manage:main" update_rst_readme = "inventory_project.publish:update_readme" publish = "inventory_project.publish:publish" +[build-system] +requires = ["poetry>=0.12"] +build-backend = "poetry.masonry.api" + [tool.autopep8] # https://github.com/hhatto/autopep8#pyprojecttoml max_line_length = 120 exclude = "*/migrations/*" -[build-system] -requires = ["poetry>=0.12"] -build-backend = "poetry.masonry.api" +[tool.tox] +# https://tox.readthedocs.io/en/latest/example/basic.html#pyproject-toml-tox-legacy-ini +legacy_tox_ini = """ +[tox] +isolated_build = True +envlist = py39,py38,py37 +skip_missing_interpreters = True + +[testenv] +whitelist_externals = pytest +commands = + pytest --pyargs inventory inventory_project +""" diff --git a/tox.ini b/tox.ini deleted file mode 100644 index 3766271..0000000 --- a/tox.ini +++ /dev/null @@ -1,10 +0,0 @@ -[tox] -isolated_build = True -envlist = py39,py38,py37 -skip_missing_interpreters = True - -[testenv] -whitelist_externals = pytest -commands = - pytest --pyargs inventory inventory_project -x - From c4c63d8e183d241b9a1e9a06579b6a5310b367e5 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:45:40 +0100 Subject: [PATCH 30/34] move pytest.ini into pyproject.toml --- pyproject.toml | 33 +++++++++++++++++++++++++++++++++ pytest.ini | 47 ----------------------------------------------- 2 files changed, 33 insertions(+), 47 deletions(-) delete mode 100644 pytest.ini diff --git a/pyproject.toml b/pyproject.toml index ef983b0..62157b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -88,11 +88,44 @@ publish = "inventory_project.publish:publish" requires = ["poetry>=0.12"] build-backend = "poetry.masonry.api" + [tool.autopep8] # https://github.com/hhatto/autopep8#pyprojecttoml max_line_length = 120 exclude = "*/migrations/*" + +[tool.pytest.ini_options] +# https://docs.pytest.org/en/latest/customize.html#pyproject-toml +minversion = "6.0" +DJANGO_SETTINGS_MODULE="inventory_project.settings.tests" +norecursedirs = ".* .git __pycache__ coverage* dist" +# sometimes helpfull "addopts" arguments: +# -vv +# --verbose +# --capture=no +# --trace-config +# --full-trace +# -p no:warnings +addopts = """ + --import-mode=importlib + --ignore-glob=deployment/inventory/* + --reuse-db + --nomigrations + --cov=. + --cov-report term-missing + --cov-report html + --cov-report xml + --no-cov-on-fail + --showlocals + --doctest-modules + --failed-first + --last-failed-no-failures all + --new-first + -p no:randomly +""" + + [tool.tox] # https://tox.readthedocs.io/en/latest/example/basic.html#pyproject-toml-tox-legacy-ini legacy_tox_ini = """ diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index 5679270..0000000 --- a/pytest.ini +++ /dev/null @@ -1,47 +0,0 @@ -# -# http://doc.pytest.org/en/latest/customize.html#builtin-configuration-file-options -# https://pytest-django.readthedocs.io/en/latest/ - -[pytest] -DJANGO_SETTINGS_MODULE=inventory_project.settings.tests - -# http://doc.pytest.org/en/latest/customize.html#confval-norecursedirs -norecursedirs = .* .git __pycache__ coverage* dist -addopts = - --import-mode=importlib - --ignore-glob=deployment/inventory/* - --collect-in-virtualenv - - --reuse-db - --nomigrations - - # coverage: - --cov=. - --cov-report term-missing - --cov-report html - --cov-report xml - --no-cov-on-fail - - --showlocals - - --doctest-modules - - # run the last failures first: - --failed-first - - # run all tests if no tests failed in the last run: - --last-failed-no-failures all - - # sort new tests first: - --new-first - - # randomly is sometimes helpfull, comment this: - -p no:randomly - - # sometimes helpfull: - #-vv - #--verbose - #--capture=no - #--trace-config - #--full-trace - #-p no:warnings From 14cddd57627579f087dcabe87cc39c060a6f0f16 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:48:48 +0100 Subject: [PATCH 31/34] add a note about https://gitlab.com/pycqa/flake8/-/issues/428 --- .flake8 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.flake8 b/.flake8 index 5806d13..3cc9471 100644 --- a/.flake8 +++ b/.flake8 @@ -1,3 +1,6 @@ +# +# Move to pyproject.toml after: https://gitlab.com/pycqa/flake8/-/issues/428 +# [flake8] exclude = .tox, .pytest_cache, *.egg-info, */migrations/*, volumes #ignore = E402 From b8c54f94902c05fa3a2d7b1d263204cf3038a0b9 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:57:22 +0100 Subject: [PATCH 32/34] move .isort.cfg into pyproject.toml --- .isort.cfg | 23 ----------------------- pyproject.toml | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 23 deletions(-) delete mode 100644 .isort.cfg diff --git a/.isort.cfg b/.isort.cfg deleted file mode 100644 index b8ec977..0000000 --- a/.isort.cfg +++ /dev/null @@ -1,23 +0,0 @@ -# Configuring isort -# https://github.com/timothycrosley/isort/wiki/isort-Settings - -[settings] -atomic=true -line_length=120 -case_sensitive=false - -skip_glob=*/migrations/*,*/volumes/* - -# https://github.com/timothycrosley/isort#multi-line-output-modes -# 3 - Vertical Hanging Indent -multi_line_output=3 -include_trailing_comma=true - -known_first_party=inventory,inventory_project,inventory_tests - -no_lines_before=LOCALFOLDER - -default_section=THIRDPARTY -sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER - -lines_after_imports=2 diff --git a/pyproject.toml b/pyproject.toml index 62157b3..1027a84 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -95,6 +95,21 @@ max_line_length = 120 exclude = "*/migrations/*" +[tool.isort] +# https://pycqa.github.io/isort/docs/configuration/config_files/#pyprojecttoml-preferred-format +atomic=true +line_length=120 +case_sensitive=false +skip_glob=["*/migrations/*","*/volumes/*"] +multi_line_output=3 +include_trailing_comma=true +known_first_party=["inventory","inventory_project","inventory_tests"] +no_lines_before="LOCALFOLDER" +default_section="THIRDPARTY" +sections=["FUTURE","STDLIB","THIRDPARTY","FIRSTPARTY","LOCALFOLDER"] +lines_after_imports=2 + + [tool.pytest.ini_options] # https://docs.pytest.org/en/latest/customize.html#pyproject-toml minversion = "6.0" From 75435b9ca0fa83164e1a3ac0cafe2b89f0c9dd13 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Fri, 13 Nov 2020 22:58:50 +0100 Subject: [PATCH 33/34] remove obsolete yapf config --- .style.yapf | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 .style.yapf diff --git a/.style.yapf b/.style.yapf deleted file mode 100644 index fd9bc17..0000000 --- a/.style.yapf +++ /dev/null @@ -1,13 +0,0 @@ -# https://github.com/google/yapf#formatting-style -# https://github.com/google/yapf/blob/master/yapf/yapflib/style.py - -[style] -based_on_style = google -# max-line-length = 119 from django, see: https://github.com/django/django/blob/master/setup.cfg -BLANK_LINE_BEFORE_MODULE_DOCSTRING = True -COLUMN_LIMIT = 119 -DEDENT_CLOSING_BRACKETS = True -EACH_DICT_ENTRY_ON_SEPARATE_LINE = True -SPLIT_BEFORE_DICT_SET_GENERATOR = False -ALLOW_SPLIT_BEFORE_DICT_VALUE = False -COALESCE_BRACKETS = True From 52faab70d60eac57d531de10017d5c5a4d28dba6 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Sat, 14 Nov 2020 09:55:36 +0100 Subject: [PATCH 34/34] update deployment README --- deployment/README.creole | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/deployment/README.creole b/deployment/README.creole index 34c3204..98b4bb5 100644 --- a/deployment/README.creole +++ b/deployment/README.creole @@ -1,22 +1,22 @@ -= PyInventory - deployment branch += PyInventory - deployment instruction Web based management to catalog things including state and location etc. using Python/Django. **Note:** -* This README (in git **deployment** branch) contains only the instruction to install PyInventory on a root server. -* Read [[https://github.com/jedie/PyInventory/tree/master#readme|master README]] for local develompment installation. +* This README contains only the instruction to install PyInventory on a root server. +* Read [[https://github.com/jedie/PyInventory/tree/master#readme|the main README]] for local development installation. Pull requests welcome! -== git branches +== Project structure -Currently we have two main branches: +There are two main directories: -|= git branch |= description -| **[[https://github.com/jedie/PyInventory/tree/master|master]]** | The main PyInventory source code -| **[[https://github.com/jedie/PyInventory/tree/deployment|deployment]]** | separate project to deploy PyInventory for production use case +|= directory |= description +| **[[https://github.com/jedie/PyInventory/tree/master/src|/src/]]** | The main PyInventory source code +| **[[https://github.com/jedie/PyInventory/tree/master/deployment|/deployment/]]** | deploy PyInventory for production use case == deploy @@ -96,11 +96,11 @@ install some base packages, e.g.: {{{ # Checkout the deployment branch: -~$ git clone -b deployment https://github.com/jedie/PyInventory.git PyInventory-Deployment -~$ cd PyInventory-Deployment +~$ git clone https://github.com/jedie/PyInventory.git +~$ cd PyInventory/deployment/ # Theses Makefile targets exists: -~/PyInventory-Deployment$ make +~/PyInventory/deployment$ make help List all commands install-poetry install or update poetry install install requirements to setup project @@ -132,21 +132,21 @@ Install, e.g.: {{{ # install or update poetry: -~/PyInventory-Deployment$ make install-poetry +~/PyInventory/deployment$ make install-poetry }}} To keep poetry running (PATH must be expand) just logout and login ;) {{{ # install requirements (e.g.: docker-compose) via poetry: -~/PyInventory-Deployment$ make install +~/PyInventory/deployment$ make install }}} Create a {{{.env}}} file in project root directory with these content, e.g.: {{{ -~/PyInventory-Deployment$ touch .env -~/PyInventory-Deployment$ nano .env -~/PyInventory-Deployment$ cat .env +~/PyInventory/deployment$ touch .env +~/PyInventory/deployment$ nano .env +~/PyInventory/deployment$ cat .env # Your Public domain: HOSTNAME=domain.tld @@ -163,14 +163,14 @@ LETSENCRYPT_EMAIL=internal Start containers via docker-compose: {{{ -~/PyInventory-Deployment$ make up +~/PyInventory/deployment$ make up }}} Notes: At the first start it takes a little while until the database is created ;) Create first super user: {{{ -~/PyInventory-Deployment$ make docker_createsuperuser +~/PyInventory/deployment$ make docker_createsuperuser }}} * Now you should be able to connect to your PyInventory installation and login with created super user. @@ -185,12 +185,12 @@ TO keep everything up-to-date do the following steps: Update the OS call: {{{ -~/PyInventory-Deployment$ sudo ./scripts/apt-distupgrade.sh +~/PyInventory/deployment$ sudo ./scripts/apt-distupgrade.sh }}} Update PyInventory installation and docker containers: {{{ -~/PyInventory-Deployment$ make update +~/PyInventory/deployment$ make update }}} This will do: