diff --git a/CHANGELOG b/CHANGELOG index 690f65391bc5d4a32389a274ff99245be0715350..2fe59b2002a71125fd9172e68378df9c63642b2c 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,10 +1,11 @@ -[33mcda4d52[m[33m ([m[1;36mHEAD -> [m[1;32mmaster[m[33m, [m[1;33mtag: 1.9.3[m[33m, [m[1;31morigin/master[m[33m, [m[1;31morigin/HEAD[m[33m)[m added code coverage configuration file -[33ma2fa2be[m[33m ([m[1;33mtag: 1.9.2[m[33m)[m simplified CI for the backend -[33m34029c7[m[33m ([m[1;33mtag: 1.9.1[m[33m)[m added missing dependencies (coverage & psycopg2) -[33me6c8016[m[33m ([m[1;33mtag: 1.9.0[m[33m)[m added missing dependency (gunicorn) -[33m72aa622[m[33m ([m[1;33mtag: 1.8.9[m[33m)[m removed port forwarding for the database (docker) container -[33m143e218[m[33m ([m[1;33mtag: 1.8.8[m[33m)[m combined CI for backend and frontend -[33md7f3841[m[33m ([m[1;33mtag: 1.8.7[m[33m)[m simplified frontend CI -[33m4d2247e[m[33m ([m[1;33mtag: 1.8.6[m[33m)[m enable CI for frontend -[33m150d280[m[33m ([m[1;33mtag: 1.8.5[m[33m)[m merge source code for frontend and backend -[33m5f8b59f[m[33m ([m[1;33mtag: 1.8.4[m[33m)[m Initial commit +dceec53 (HEAD -> master, tag: 1.9.4, origin/master, origin/HEAD) updated README +cda4d52 (tag: 1.9.3) added code coverage configuration file +a2fa2be (tag: 1.9.2) simplified CI for the backend +34029c7 (tag: 1.9.1) added missing dependencies (coverage & psycopg2) +e6c8016 (tag: 1.9.0) added missing dependency (gunicorn) +72aa622 (tag: 1.8.9) removed port forwarding for the database (docker) container +143e218 (tag: 1.8.8) combined CI for backend and frontend +d7f3841 (tag: 1.8.7) simplified frontend CI +4d2247e (tag: 1.8.6) enable CI for frontend +150d280 (tag: 1.8.5) merge source code for frontend and backend +5f8b59f (tag: 1.8.4) Initial commit diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..b9dd7898a6a5d4087c81057b3ef179dbb608fb72 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to Machina Callida + +We welcome contributions from the community, and want to make contributing to this project as easy and transparent as possible, whether you contribute by + +- reporting a bug, +- submitting code, +- proposing a new feature, or +- put yourself forward to become the maintainer, +- ... + +Please read these guidelines before contributing. +If you have questions about them or want to suggest improvements, please [open a new issue](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/issues/new). + +## Development on GitLab + +We use GitLab to host source code and documentation, to track issues such as bug reports and feature requests, and to provide Machina Callida downloads to users. + +## Report a bug or other issues + +We track bugs in and issues with Machina Callida, and record proposals of new features, in GitLab issues. +You can report a bug, request a feature, or simply ask a question, by [opening a new issue](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/issues/new). +It's easy. + +## Contribute code or documentation through merge requests + +[Merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/getting_started.html) are the best way to propose changes to the codebase or the documentation sources. We actively welcome your merge requests: + +1. Fork this repository. +2. Open a new issue describing what you are planning to do. The maintainer will decide and communicate whether your change is a *hotfix* or a *feature*. +3. Create a `feature` branch (for new functionality) with `git checkout -b "feature/YOUR_BRANCH_NAME_HERE"`, +or a `hotfix` branch (for bug fixes) with `git checkout -b "hotfix/YOUR_BRANCH_NAME_HERE"`. +4. Do your work in this branch. + - If you add code, add tests! + - Update the relevant documentation! + - Test your changes locally! +5. Push your branch and create a merge request. + - If your contribution is new functionality, create it against `machina-callida:develop`. + - If your contribution is a bug fix, create it against `machina-callida:master`. + +### Code review schedules + +We perform reviews of all changes to Machina Callida, be they in code, documentation, configuration, etc. +Note that we may sometimes not be able to perform reviews right away due to illness, holidays, etc. + +## License + +By contributing code to Machina Callida, you agree that your contributions will be licensed under its [Apache License, Version 2.0](LICENSE). +By contributing documentation to Machina Callida, you agree that your contributions will be licensed under its [CC0 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/legalcode) license. + +## Governance + +This section describes the decision-making processes for the Machina Callida project, and the roles involved in them. + +### Roles + +In the Machina Callida project, the following roles are defined. + +- **Core contributors:** Active contributors to the Machina Callida software. The development of Machina Callida is either part of the job description of core contributors, or they are actively making substantial contributions to the project. + +- **Maintainer:** Machina Callida has a single maintainer. This person is responsible for the development and release workflow of Machina Callida, including project and software documentation and facilitating maintenance transfers, as well as nominating core contributors. + +- **Principal investigators:** As Machina Callida is research software, the principal investigators are responsible for strategic development of the project. + +### Decision making + +Decisions are usually made by the maintainer, with potential recourse to the core contributors, the principal investigators, or both. diff --git a/LICENSE b/LICENSE index 335ea9d070ad1c319906aeff798584ded23c7387..261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,201 @@ -Copyright (c) 2018 The Python Packaging Authority - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 5201b7d6ef56c56903de3c73b0190dee2140b9c6..1177a08d7574aa670c884cf5242b0c7bb34e22cd 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,4 @@ To snapshot a running container, use `docker commit CONTAINER_ID`. It returns a ## Documentation ### Changelog -To update the changelog, use: `git log --oneline --decorate --color > CHANGELOG` +To update the changelog, use: `git log --oneline --decorate > CHANGELOG` diff --git a/mc_backend/Dockerfile b/mc_backend/Dockerfile index 546172d2f48ccd70b61f0663c5b19372c8e82ab8..cf2c1df013fdbf010cbbcaaad0a86888cfe37b1f 100644 --- a/mc_backend/Dockerfile +++ b/mc_backend/Dockerfile @@ -3,27 +3,9 @@ FROM python:3.8 RUN useradd -ms /bin/bash mc - WORKDIR /home/mc - RUN python -m venv venv - -RUN apt-get update -RUN apt-get install -y openssh-server nano - COPY requirements.txt requirements.txt RUN venv/bin/pip install --no-cache-dir --default-timeout=120 -r requirements.txt - -#prepare ssh -RUN mkdir /var/run/sshd -RUN echo 'root:root' | chpasswd -RUN sed -i 's/#PermitRootLogin prohibit-password/PermitRootLogin yes/' /etc/ssh/sshd_config -RUN sed 's@session\s*required\s*pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/pam.d/sshd -ENV NOTVISIBLE "in users profile" -RUN echo "export VISIBLE=now" >> /etc/profile -RUN /usr/bin/ssh-keygen -A -CMD ["/usr/sbin/sshd", "-D"] - COPY . mc_backend - WORKDIR /home/mc/mc_backend diff --git a/mc_backend/run_csm.py b/mc_backend/run_csm.py index 7268fce977dd32d9c3385594d1453ad38ff02837..b923a0ee71a4e0cfbedd4be3cf85449bf92c1338 100644 --- a/mc_backend/run_csm.py +++ b/mc_backend/run_csm.py @@ -1,5 +1,4 @@ from flask import Flask - from csm import get_app, get_cfg app: Flask = get_app() diff --git a/mc_frontend/Dockerfile b/mc_frontend/Dockerfile index b901ddc1727daf0a4fa75f3650b8d1ad089c0059..a51c21cbc13111cef861cae4f9d8ff3a37719450 100644 --- a/mc_frontend/Dockerfile +++ b/mc_frontend/Dockerfile @@ -4,7 +4,7 @@ RUN useradd -ms /bin/bash mc WORKDIR /home/mc RUN apt update -# for testing +# for testing with headless chrome browser RUN wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb RUN apt install -y ./google-chrome-stable_current_amd64.deb